numam-spdk/lib/log/log.c
fanyang bb9d17a5c3 lib/log: passing va_list to user-provided log call
va_list is not passed in logfunc, so the user-provided log call can't
get the arguments corresponding to the format string.

This patch fixes it and replaces log func pointer in spdk_app_opts
with logfunc.

Change-Id: I7f7806f47c4fd8f36f3234aa5a8c877db0fc7140
Signed-off-by: Yang Fan <fanyang@smartx.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/469828
Reviewed-by: Feng,Li <fengli@smartx.com>
Reviewed-by: Darek Stojaczyk <dariusz.stojaczyk@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
2019-10-09 14:35:51 +00:00

214 lines
5.3 KiB
C

/*-
* BSD LICENSE
*
* Copyright (c) Intel Corporation.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * 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.
* * Neither the name of Intel Corporation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "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 COPYRIGHT
* OWNER OR CONTRIBUTORS 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 "spdk/stdinc.h"
#include "spdk_internal/log.h"
#ifdef SPDK_LOG_BACKTRACE_LVL
#define UNW_LOCAL_ONLY
#include <libunwind.h>
#endif
static const char *const spdk_level_names[] = {
[SPDK_LOG_ERROR] = "ERROR",
[SPDK_LOG_WARN] = "WARNING",
[SPDK_LOG_NOTICE] = "NOTICE",
[SPDK_LOG_INFO] = "INFO",
[SPDK_LOG_DEBUG] = "DEBUG",
};
#define MAX_TMPBUF 1024
static logfunc *g_log = NULL;
void
spdk_log_open(logfunc *logf)
{
if (logf) {
g_log = logf;
} else {
openlog("spdk", LOG_PID, LOG_LOCAL7);
}
}
void
spdk_log_close(void)
{
if (!g_log) {
closelog();
}
}
#ifdef SPDK_LOG_BACKTRACE_LVL
static void
spdk_log_unwind_stack(FILE *fp, enum spdk_log_level level)
{
unw_error_t err;
unw_cursor_t cursor;
unw_context_t uc;
unw_word_t ip;
unw_word_t offp;
char f_name[64];
int frame;
if (level > g_spdk_log_backtrace_level) {
return;
}
unw_getcontext(&uc);
unw_init_local(&cursor, &uc);
fprintf(fp, "*%s*: === BACKTRACE START ===\n", spdk_level_names[level]);
unw_step(&cursor);
for (frame = 1; unw_step(&cursor) > 0; frame++) {
unw_get_reg(&cursor, UNW_REG_IP, &ip);
err = unw_get_proc_name(&cursor, f_name, sizeof(f_name), &offp);
if (err || strcmp(f_name, "main") == 0) {
break;
}
fprintf(fp, "*%s*: %3d: %*s%s() at %#lx\n", spdk_level_names[level], frame, frame - 1, "", f_name,
(unsigned long)ip);
}
fprintf(fp, "*%s*: === BACKTRACE END ===\n", spdk_level_names[level]);
}
#else
#define spdk_log_unwind_stack(fp, lvl)
#endif
void
spdk_log(enum spdk_log_level level, const char *file, const int line, const char *func,
const char *format, ...)
{
int severity = LOG_INFO;
char buf[MAX_TMPBUF];
va_list ap;
if (g_log) {
va_start(ap, format);
g_log(level, file, line, func, format, ap);
va_end(ap);
return;
}
if (level > g_spdk_log_print_level && level > g_spdk_log_level) {
return;
}
switch (level) {
case SPDK_LOG_ERROR:
severity = LOG_ERR;
break;
case SPDK_LOG_WARN:
severity = LOG_WARNING;
break;
case SPDK_LOG_NOTICE:
severity = LOG_NOTICE;
break;
case SPDK_LOG_INFO:
case SPDK_LOG_DEBUG:
severity = LOG_INFO;
break;
case SPDK_LOG_DISABLED:
return;
}
va_start(ap, format);
vsnprintf(buf, sizeof(buf), format, ap);
if (level <= g_spdk_log_print_level) {
fprintf(stderr, "%s:%4d:%s: *%s*: %s", file, line, func, spdk_level_names[level], buf);
spdk_log_unwind_stack(stderr, level);
}
if (level <= g_spdk_log_level) {
syslog(severity, "%s:%4d:%s: *%s*: %s", file, line, func, spdk_level_names[level], buf);
}
va_end(ap);
}
static void
fdump(FILE *fp, const char *label, const uint8_t *buf, size_t len)
{
char tmpbuf[MAX_TMPBUF];
char buf16[16 + 1];
size_t total;
unsigned int idx;
fprintf(fp, "%s\n", label);
memset(buf16, 0, sizeof buf16);
total = 0;
for (idx = 0; idx < len; idx++) {
if (idx != 0 && idx % 16 == 0) {
snprintf(tmpbuf + total, sizeof tmpbuf - total,
" %s", buf16);
fprintf(fp, "%s\n", tmpbuf);
total = 0;
}
if (idx % 16 == 0) {
total += snprintf(tmpbuf + total, sizeof tmpbuf - total,
"%08x ", idx);
}
if (idx % 8 == 0) {
total += snprintf(tmpbuf + total, sizeof tmpbuf - total,
"%s", " ");
}
total += snprintf(tmpbuf + total, sizeof tmpbuf - total,
"%2.2x ", buf[idx] & 0xff);
buf16[idx % 16] = isprint(buf[idx]) ? buf[idx] : '.';
}
for (; idx % 16 != 0; idx++) {
if (idx == 8) {
total += snprintf(tmpbuf + total, sizeof tmpbuf - total,
" ");
}
total += snprintf(tmpbuf + total, sizeof tmpbuf - total, " ");
buf16[idx % 16] = ' ';
}
snprintf(tmpbuf + total, sizeof tmpbuf - total, " %s", buf16);
fprintf(fp, "%s\n", tmpbuf);
fflush(fp);
}
void
spdk_log_dump(FILE *fp, const char *label, const void *buf, size_t len)
{
fdump(fp, label, buf, len);
}