hio/lib/sys-log.c

/*
    Copyright (c) 2016-2020 Chung, Hyung-Hwan. All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions
    are met:
    1. Redistributions of source code must retain the above copyright
       notice, this list of conditions and the following disclaimer.
    2. Redistributions in binary form must reproduce the above copyright
       notice, this list of conditions and the following disclaimer in the
       documentation and/or other materials provided with the distribution.

    THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR
    IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
    IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
    NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
    THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "sys-prv.h"

#if defined(_WIN32)
#	include <windows.h>
#	include <time.h>
#	include <errno.h>
#	include <io.h>
#	include <fcntl.h>

#elif defined(__OS2__)
#	define INCL_DOSDATETIME
#	include <os2.h>
#	include <time.h>
#	include <errno.h>
#	include <io.h>
#	include <fcntl.h>

#elif defined(__DOS__)
#	include <dos.h>
#	include <time.h>
#	include <errno.h>
#	include <io.h>
#	include <fcntl.h>

#elif defined(macintosh)
#	include <Types.h>
#	include <OSUtils.h>
#	include <Timer.h>
#	include <MacErrors.h>

	/* TODO: a lot to do */

#elif defined(vms) || defined(__vms)
#	define __NEW_STARLET 1
#	include <starlet.h> /* (SYS$...) */
#	include <ssdef.h> /* (SS$...) */
#	include <lib$routines.h> /* (lib$...) */

	/* TODO: a lot to do */

#else
#	include <sys/types.h>
#	include <unistd.h>
#	include <fcntl.h>
#	include <errno.h>

#	if defined(HAVE_TIME_H)
#		include <time.h>
#	endif
#	if defined(HAVE_SYS_TIME_H)
#		include <sys/time.h>
#	endif

#endif

#include <stdio.h> /* for sprintf */


enum logfd_flag_t
{
	LOGFD_TTY = (1 << 0),
	LOGFD_OPENED_HERE = (1 << 1)
};

static int write_all (hio_t* hio, int fd, hio_bitmask_t mask, const hio_bch_t* ptr, hio_oow_t len)
{
	if (hio->option.log_writer) return hio->option.log_writer(hio, mask, ptr, len);

	if (HIO_UNLIKELY(fd <= -1)) return 0; /* HIO_FEATURE_LOG_WRITER is off but hio->option.log_write is not set */

	while (len > 0)
	{
		hio_ooi_t wr;

		wr = write(fd, ptr, len);

		if (wr <= -1)
		{
		#if defined(EAGAIN) && defined(EWOULDBLOCK) && (EAGAIN == EWOULDBLOCK)
			if (errno == EAGAIN) continue;
		#else
			#if defined(EAGAIN)
			if (errno == EAGAIN) continue;
			#elif defined(EWOULDBLOCK)
			if (errno == EWOULDBLOCK) continue;
			#endif
		#endif

		#if defined(EINTR)
			/* TODO: would this interfere with non-blocking nature of this VM? */
			if (errno == EINTR) continue;
		#endif
			return -1;
		}

		ptr += wr;
		len -= wr;
	}

	return 0;
}

static int write_log (hio_t* hio, int fd, hio_bitmask_t mask, const hio_bch_t* ptr, hio_oow_t len)
{
	hio_sys_log_t* log = &hio->sysdep->log;

	while (len > 0)
	{
		if (log->out.len > 0)
		{
			hio_oow_t rcapa, cplen;

			rcapa = HIO_COUNTOF(log->out.buf) - log->out.len;
			cplen = (len >= rcapa)? rcapa: len;

			HIO_MEMCPY (&log->out.buf[log->out.len], ptr, cplen);
			log->out.len += cplen;
			ptr += cplen;
			len -= cplen;

			if (log->out.len >= HIO_COUNTOF(log->out.buf))
			{
				int n;
				n = write_all(hio, fd, mask, log->out.buf, log->out.len);
				log->out.len = 0;
				if (n <= -1) return -1;
			}
		}
		else
		{
			hio_oow_t rcapa;

			rcapa = HIO_COUNTOF(log->out.buf);
			if (len >= rcapa)
			{
				if (write_all(hio, fd, mask, ptr, rcapa) <= -1) return -1;
				ptr += rcapa;
				len -= rcapa;
			}
			else
			{
				HIO_MEMCPY (log->out.buf, ptr, len);
				log->out.len += len;
				ptr += len;
				len -= len;

			}
		}
	}

	return 0;
}

static void flush_log (hio_t* hio, int fd, hio_bitmask_t mask)
{
	hio_sys_log_t* log = &hio->sysdep->log;
	if (log->out.len > 0)
	{
		write_all (hio, fd, mask, log->out.buf, log->out.len);
		log->out.len = 0;
	}
}

void hio_sys_writelog (hio_t* hio, hio_bitmask_t mask, const hio_ooch_t* msg, hio_oow_t len)
{
	hio_sys_log_t* log = &hio->sysdep->log;
	hio_bch_t buf[256];
	hio_oow_t ucslen, bcslen, msgidx;
	int n, logfd = -1;

	if (hio->_features & HIO_FEATURE_LOG_WRITER)
	{
		if (mask & HIO_LOG_STDERR)
		{
			logfd = 2;
		}
		else
		{
			if (mask & HIO_LOG_STDOUT) logfd = 1;
			else
			{
				logfd = log->fd;
				if (logfd <= -1) return;
			}
		}
	}

/* TODO: beautify the log message.
 *       do classification based on mask. */
	if (!(mask & (HIO_LOG_STDOUT | HIO_LOG_STDERR)))
	{
		time_t now;
		char ts[32];
		size_t tslen;
		struct tm tm, *tmp;

		now = time(HIO_NULL);
	#if defined(_WIN32)
		tmp = localtime(&now);
		tslen = strftime(ts, sizeof(ts), "%Y-%m-%d %H:%M:%S %z ", tmp);
		if (tslen == 0)
		{
			tslen = sprintf(ts, "%04d-%02d-%02d %02d:%02d:%02d ", tmp->tm_year + 1900, tmp->tm_mon + 1, tmp->tm_mday, tmp->tm_hour, tmp->tm_min, tmp->tm_sec);
		}
	#elif defined(__OS2__)
		#if defined(__WATCOMC__)
		tmp = _localtime(&now, &tm);
		#else
		tmp = localtime(&now);
		#endif

		#if defined(__BORLANDC__)
		/* the borland compiler doesn't handle %z properly - it showed 00 all the time */
		tslen = strftime(ts, sizeof(ts), "%Y-%m-%d %H:%M:%S %Z ", tmp);
		#else
		tslen = strftime(ts, sizeof(ts), "%Y-%m-%d %H:%M:%S %z ", tmp);
		#endif
		if (tslen == 0)
		{
			tslen = sprintf(ts, "%04d-%02d-%02d %02d:%02d:%02d ", tmp->tm_year + 1900, tmp->tm_mon + 1, tmp->tm_mday, tmp->tm_hour, tmp->tm_min, tmp->tm_sec);
		}

	#elif defined(__DOS__)
		tmp = localtime(&now);
		/* since i know that %z/%Z is not available in strftime, i switch to sprintf immediately */
		tslen = sprintf(ts, "%04d-%02d-%02d %02d:%02d:%02d ", tmp->tm_year + 1900, tmp->tm_mon + 1, tmp->tm_mday, tmp->tm_hour, tmp->tm_min, tmp->tm_sec);
	#else
		#if defined(HAVE_LOCALTIME_R)
		tmp = localtime_r(&now, &tm);
		#else
		tmp = localtime(&now);
		#endif

		#if defined(HAVE_STRFTIME_SMALL_Z)
		tslen = strftime(ts, sizeof(ts), "%Y-%m-%d %H:%M:%S %z ", tmp);
		#else
		tslen = strftime(ts, sizeof(ts), "%Y-%m-%d %H:%M:%S %Z ", tmp);
		#endif
		if (tslen == 0)
		{
			tslen = sprintf(ts, "%04d-%02d-%02d %02d:%02d:%02d ", tmp->tm_year + 1900, tmp->tm_mon + 1, tmp->tm_mday, tmp->tm_hour, tmp->tm_min, tmp->tm_sec);
		}
	#endif
		write_log (hio, logfd, mask, ts, tslen);
	}

	if (logfd == log->fd && (log->fd_flag & LOGFD_TTY))
	{
		if (mask & HIO_LOG_FATAL) write_log (hio, logfd, mask, "\x1B[1;31m", 7);
		else if (mask & HIO_LOG_ERROR) write_log (hio, logfd, mask, "\x1B[1;32m", 7);
		else if (mask & HIO_LOG_WARN) write_log (hio, logfd, mask, "\x1B[1;33m", 7);
	}

#if defined(HIO_OOCH_IS_UCH)
	msgidx = 0;
	while (len > 0)
	{
		ucslen = len;
		bcslen = HIO_COUNTOF(buf);

		n = hio_convootobchars(hio, &msg[msgidx], &ucslen, buf, &bcslen);
		if (n == 0 || n == -2)
		{
			/* n = 0:
			 *   converted all successfully
			 * n == -2:
			 *    buffer not sufficient. not all got converted yet.
			 *    write what have been converted this round. */

			HIO_ASSERT (hio, ucslen > 0); /* if this fails, the buffer size must be increased */

			/* attempt to write all converted characters */
			if (write_log(hio, logfd, mask, buf, bcslen) <= -1) break;

			if (n == 0) break;
			else
			{
				msgidx += ucslen;
				len -= ucslen;
			}
		}
		else if (n <= -1)
		{
			/* conversion error */
			break;
		}
	}
#else
	write_log (hio, logfd, mask, msg, len);
#endif

	if (logfd == log->fd && (log->fd_flag & LOGFD_TTY))
	{
		if (mask & (HIO_LOG_FATAL | HIO_LOG_ERROR | HIO_LOG_WARN)) write_log (hio, logfd, mask, "\x1B[0m", 4);
	}

	flush_log (hio, logfd, mask);
}

int hio_sys_initlog (hio_t* hio)
{
	hio_sys_log_t* log = &hio->sysdep->log;

	if (hio->_features & HIO_FEATURE_LOG_WRITER)
	{
		log->fd = 2;
		log->fd_flag = 0;
	}
	else
	{
		log->fd = -1;
	}

	pthread_mutex_init (&log->mtx, HIO_NULL);
	return 0;
}

void hio_sys_finilog (hio_t* hio)
{
	hio_sys_log_t* log = &hio->sysdep->log;

	pthread_mutex_destroy (&log->mtx);

	if (hio->_features & HIO_FEATURE_LOG_WRITER)
	{
		if ((log->fd_flag & LOGFD_OPENED_HERE) && log->fd >= 0)
		{
			close (log->fd);
			log->fd = -1;
			log->fd_flag = 0;
		}
	}
}

void hio_sys_resetlog (hio_t* hio)
{
	hio_sys_log_t* log = &hio->sysdep->log;

	if (hio->_features & HIO_FEATURE_LOG_WRITER)
	{
		int fd;
		int fd_flag = 0;
		int kill_fd = -1;

		fd = open(hio->option.log_target_b, O_CREAT | O_WRONLY | O_APPEND , 0644);
		if (fd == -1)
		{
			fd = 2;
			fd_flag = 0;
		}
		else
		{
			fd_flag |= LOGFD_OPENED_HERE;
		#if defined(HAVE_ISATTY)
			if (isatty(fd)) fd_flag |= LOGFD_TTY;
		#endif
		}

		if ((log->fd_flag & LOGFD_OPENED_HERE) && log->fd >= 0) kill_fd = log->fd;

		/* swap - risk of race condition depite this late swap */
		log->fd = fd;
		log->fd_flag = fd_flag;

		if (kill_fd >= 0) close (kill_fd);
	}
}

void hio_sys_locklog (hio_t* hio)
{
	pthread_mutex_lock (&hio->sysdep->log.mtx);
}

void hio_sys_unlocklog (hio_t* hio)
{
	pthread_mutex_unlock (&hio->sysdep->log.mtx);
}