path: root/src/diagnostic/diagnostic.c

/*
 * The Rin Library – diagnostics module
 *
 * Copyright (C) 2015 Gediminas Jakutis
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; version 2.1
 * of the License.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 */

#include "diagnostic_private.h"

#include <stdlib.h>
#include <string.h>
#include <time.h>
#include "rin/diagnostic.h"
#include "rin/time.h"
#include "rin/definitions.h"

static const char default_format[] = "C:f:F:l:mn";
static const char valid_format[] = "CFtTn:mfl";

static struct iostate {
	struct timespec start;
	FILE *err;
	FILE *warn;
	FILE *fixme;
	FILE *info;
	char *err_format;
	char *warn_format;
	char *fixme_format;
	char *info_format;
	unsigned int err_knob : 1;
	unsigned int warn_knob : 1;
	unsigned int fixme_knob : 1;
	unsigned int info_knob : 1;
} state = {{0, 0}, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, 1, 1, 1, 1};

void rin_diag_cleanup(void)
{
	char *tmp;

	tmp = state.err_format;
	state.err_format = NULL;
	free(tmp);

	tmp = state.warn_format;
	state.warn_format = NULL;
	free(tmp);

	tmp = state.fixme_format;
	state.fixme_format = NULL;
	free(tmp);

	tmp = state.info_format;
	state.info_format = NULL;
	free(tmp);
}

void rin_diag_init(void)
{
	clock_gettime(RIN_CLOCK_WALL_COUNTER, &state.start);
	atexit(rin_diag_cleanup);
}

int rin_diag_format(const enum rin_diag_outstream channel, const char * const format)
{
	char *tmp;
	size_t i, j;

	if (!format) {
		tmp = NULL;
	} else {
		for (i = 0; format[i]; ++i) {
			int valid = 0;

			for (j = 0; valid_format[j]; ++j) {
				if (valid_format[j] == format [i]) {
					valid = 1;
					break;
				}
			}

			if (!valid) {
				return EINVAL;
			}
		}

		tmp = strdup(format);
	}

	switch (channel) {
	case rin_diag_err:
		free(state.err_format);
		state.err_format = tmp;
		break;
	case rin_diag_warn:
		free(state.warn_format);
		state.warn_format = tmp;
		break;
	case rin_diag_fixme:
		free(state.fixme_format);
		state.fixme_format = tmp;
		break;
	case rin_diag_info:
		free(state.info_format);
		state.info_format = tmp;
		break;
	default:
		return EINVAL;
	}

	return 0;
}

int rin_diag_set_outstream(const enum rin_diag_outstream channel, FILE * const stream)
{
	switch (channel) {
	case rin_diag_err:
		state.err = stream;
		break;
	case rin_diag_warn:
		state.warn = stream;
		break;
	case rin_diag_fixme:
		state.fixme = stream;
		break;
	case rin_diag_info:
		state.info = stream;
		break;
	default:
		return EINVAL;
	}

	return 0;
}

int rin_diag_channel_set_enabled_state(const enum rin_diag_outstream channel, const unsigned int enable)
{
	switch (channel) {
	case rin_diag_err:
		state.err_knob = enable;
		break;
	case rin_diag_warn:
		state.warn_knob = enable;
		break;
	case rin_diag_fixme:
		state.fixme_knob = enable;
		break;
	case rin_diag_info:
		state.info_knob = enable;
		break;
	default:
		return EINVAL;
	}

	return 0;
}

void __rin_err(const char * const func_name, int line_num, const char * const file_name, const char *format, ...)
{
	va_list args;

	if (!state.err_knob) {
		return;
	}

	va_start(args, format);
	__rin_msg(state.err ? state.err : stderr, "error", func_name, line_num,
			file_name, state.err_format ? state.err_format : default_format,
			format, args);
	va_end(args);
}

void __rin_warn(const char * const func_name, int line_num, const char * const file_name, const char *format, ...)
{
	va_list args;

	if (!state.warn_knob) {
		return;
	}

	va_start(args, format);
	__rin_msg(state.warn ? state.warn : stderr, "warning", func_name, line_num,
			file_name, state.warn_format ? state.warn_format : default_format,
			format, args);
	va_end(args);
}

void __rin_fixme(const char * const func_name, int line_num, const char * const file_name, const char *format, ...)
{
	va_list args;

	if (!state.fixme_knob) {
		return;
	}

	va_start(args, format);
	__rin_msg(state.fixme ? state.fixme : stderr, "fixme", func_name, line_num,
			file_name, state.fixme_format ? state.fixme_format : default_format,
			format, args);
	va_end(args);
}

void __rin_info(const char * const func_name, int line_num, const char * const file_name, const char *format, ...)
{
	va_list args;

	if (!state.info_knob) {
		return;
	}

	va_start(args, format);
	__rin_msg(state.info ? state.info : stdout, "info", func_name, line_num,
			file_name, state.info_format ? state.info_format : default_format,
			format, args);
	va_end(args);
}

static void __rin_msg(FILE * const stream, const char *prefix, const char *func_name, int line_num, const char * const file_name, const char *rin_format, const char *format, va_list args)
{
	struct timespec t;
	size_t i;
	int gottime = 0;

	for (i = 0; rin_format[i]; ++i) {
		switch (rin_format[i]) {
		case 'C':
			fprintf(stream, "%s", prefix);
			break;
		case 'F':
			fprintf(stream, "%s", func_name);
			break;
		case 't':
			/* gettid returns pid_t, which is a "signed integer type"
			 * there is no clean way to detect its actual size,
			 * so promote it to long it, if smaller and print THAT.
			 * So far we can semi-safely assume it is not going to be
			 * bigger than 8 hex digits.
			 */
			fprintf(stream, "%08lx", (long int) gettid());
			break;
		case 'T':
			if (!gottime) {
				clock_gettime(RIN_CLOCK_WALL_COUNTER, &t);
				t = rin_time_sub(&t, &state.start);
				gottime = 1;
			}

			fprintf(stream, "%lus%06lu.%03luµs", t.tv_sec, t.tv_nsec / 1000, t.tv_nsec % 1000);
			break;
		case 'n':
			fprintf(stream, "\n");
			break;
		case ':':
			fprintf(stream, ":");
			break;
		case 'm':
			vfprintf(stream, format, args);
			break;
		case 'f':
			fprintf(stream, "%s", file_name);
			break;
		case 'l':
			fprintf(stream, "%i", line_num);
			break;
		}
	}
}