OpenSolaris_b135/cmd/ldmad/ldma_log.c

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

/*
 * Logging support for the LDoms Agent daemon
 */

#include <errno.h>
#include <stdarg.h>
#include <stdio.h>
#include <string.h>
#include <syslog.h>
#include <sys/types.h>

#define	LDMA_MAX_MSG_LEN	512
#define	LDMA_MAX_TIME_LEN	32

extern boolean_t ldma_debug;
extern boolean_t ldma_daemon;

static char *log_prio_str[] = {
	"EMERG",	/* LOG_EMERG */
	"ALERT",	/* LOG_ALERT */
	"CRIT",		/* LOG_CRIT */
	"ERROR",	/* LOG_ERR */
	"WARNING",	/* LOG_WARNING */
	"NOTICE",	/* LOG_NOTICE */
	"INFO",		/* LOG_INFO */
	"DEBUG"		/* LOG_DEBUG */
};

/*
 * Generate a timestamp string in the provided buffer.
 * If any errors are encountered, the function returns
 * with the buffer containing an empty string.
 */
static void
ldma_timestamp(char *buf, size_t buflen)
{
	struct tm	ltime;
	struct timeval	now;

	if ((buf == NULL) || (buflen == 0))
		return;

	buf[0] = '\0';

	if (gettimeofday(&now, NULL) != 0) {
		(void) fprintf(stderr, "gettimeofday failed: %s\n",
		    strerror(errno));
		return;
	}

	if (localtime_r(&now.tv_sec, &ltime) == NULL) {
		(void) fprintf(stderr, "localtime_r failed: %s\n",
		    strerror(errno));
		return;
	}

	if (strftime(buf, buflen, "%b %e %T ", &ltime) == 0) {
		(void) fprintf(stderr, "strftime failed: buffer[%d] too "
		    "small\n", buflen);
		/*
		 * On failure, the contents of the buffer
		 * are indeterminate. Restore it to a known
		 * state before returning.
		 */
		buf[0] = '\0';
	}
}

static void
ldma_log_msg(int prio, char *module, char *fmt, va_list vap)
{
	char msgbuf[LDMA_MAX_MSG_LEN];
	char timebuf[LDMA_MAX_TIME_LEN] = "";

	/* generate a timestamp for the SMF log */
	ldma_timestamp(timebuf, sizeof (timebuf));

	/* LINTED E_SEC_PRINTF_VAR_FMT */
	(void) vsnprintf(msgbuf, LDMA_MAX_MSG_LEN, fmt, vap);

	/*
	 * Print the message to stderr. In daemon mode, it
	 * will be sent to the SMF log. In standalone mode,
	 * it will be sent to the controlling terminal.
	 */
	(void) fprintf(stderr, "%s%s.%s: %s\n", timebuf, module,
	    log_prio_str[prio], msgbuf);

	if (ldma_daemon && prio != LOG_DEBUG) {
		/* LINTED E_SEC_PRINTF_VAR_FMT */
		syslog(prio, msgbuf);
	}
}

void
ldma_err(char *module, char *fmt, ...)
{
	va_list vap;

	va_start(vap, fmt);
	ldma_log_msg(LOG_ERR, module, fmt, vap);
	va_end(vap);
}

void
ldma_info(char *module, char *fmt, ...)
{
	va_list vap;

	va_start(vap, fmt);
	ldma_log_msg(LOG_INFO, module, fmt, vap);
	va_end(vap);
}

void
ldma_dbg(char *module, char *fmt, ...)
{
	va_list vap;

	if (!ldma_debug) {
		/* not debugging */
		return;
	}

	va_start(vap, fmt);
	ldma_log_msg(LOG_DEBUG, module, fmt, vap);
	va_end(vap);
}