numam-spdk/include/spdk/log.h
Krzysztof Jakimiak 25749728b6 spdk: tweak tracedump
Increased printed data width, added data offset indices.

Change-Id: I44f81396e33870109c2bece5e152657f8a24a56a
Signed-off-by: Krzysztof Jakimiak <krzysztof.jakimiak@intel.com>
2016-10-05 09:40:21 -07:00

117 lines
4.1 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.
*/
/**
* \file
* Logging interfaces
*/
#ifndef SPDK_LOG_H
#define SPDK_LOG_H
#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>
#include <stdio.h>
/*
* Default: 1 - noticelog messages will print to stderr and syslog.
* Can be set to 0 to print noticelog messages to syslog only.
*/
extern unsigned int spdk_g_notice_stderr_flag;
#define SPDK_NOTICELOG(...) \
spdk_noticelog(NULL, 0, NULL, __VA_ARGS__)
#define SPDK_WARNLOG(...) \
spdk_warnlog(NULL, 0, NULL, __VA_ARGS__)
#define SPDK_ERRLOG(...) \
spdk_errlog(__FILE__, __LINE__, __func__, __VA_ARGS__)
#ifdef DEBUG
#define SPDK_LOG_REGISTER_TRACE_FLAG(str, flag) \
bool flag = false; \
__attribute__((constructor)) static void register_trace_flag_##flag(void) \
{ \
spdk_log_register_trace_flag(str, &flag); \
}
#define SPDK_TRACELOG(FLAG, ...) \
do { \
extern bool FLAG; \
if (FLAG) { \
spdk_tracelog(__FILE__, __LINE__, __func__, __VA_ARGS__); \
} \
} while (0)
#define SPDK_TRACEDUMP(FLAG, LABEL, BUF, LEN) \
do { \
extern bool FLAG; \
if ((FLAG) && (LEN)) { \
spdk_trace_dump((LABEL), (BUF), (LEN)); \
} \
} while (0)
#else
#define SPDK_LOG_REGISTER_TRACE_FLAG(str, flag)
#define SPDK_TRACELOG(...) do { } while (0)
#define SPDK_TRACEDUMP(...) do { } while (0)
#endif
int spdk_set_log_facility(const char *facility);
int spdk_set_log_priority(const char *priority);
void spdk_noticelog(const char *file, const int line, const char *func,
const char *format, ...) __attribute__((__format__(__printf__, 4, 5)));
void spdk_warnlog(const char *file, const int line, const char *func,
const char *format, ...) __attribute__((__format__(__printf__, 4, 5)));
void spdk_tracelog(const char *file, const int line,
const char *func, const char *format, ...) __attribute__((__format__(__printf__, 4, 5)));
void spdk_errlog(const char *file, const int line, const char *func,
const char *format, ...) __attribute__((__format__(__printf__, 4, 5)));
void spdk_trace_dump(const char *label, const uint8_t *buf, size_t len);
void spdk_log_register_trace_flag(const char *name, bool *enabled);
bool spdk_log_get_trace_flag(const char *flag);
int spdk_log_set_trace_flag(const char *flag);
int spdk_log_clear_trace_flag(const char *flag);
size_t spdk_log_get_num_trace_flags(void);
const char *spdk_log_get_trace_flag_name(size_t idx);
void spdk_open_log(void);
void spdk_close_log(void);
void spdk_tracelog_usage(FILE *f, const char *trace_arg);
#endif /* SPDK_LOG_H */