bladeRF/host/common/include/log.h
Rey Tucker 78286d47f9 host: common: add log_get_verbosity function
log_get_verbosity returns the current logging level, which may be useful
for situations where a lot of processing is required for verbose
logging, etc.
2018-08-01 16:24:54 -04:00

144 lines
4.4 KiB
C

/**
* @file log.h
*
* @brief Simple log message
*
* This file is part of the bladeRF project:
* http://www.github.com/nuand/bladeRF
*
* Copyright (c) 2013 Nuand LLC.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
#ifndef LOG_H__
#define LOG_H__
#include <stdio.h>
#include <inttypes.h>
#include "libbladeRF.h"
#ifdef __cplusplus
extern "C" {
#endif
#ifdef SHORT_FILE_
# define THIS_FILE SHORT_FILE_
#else
#if 0
# warning "SHORT_FILE_ was not defined. Using __FILE__ instead."
#endif
# define THIS_FILE __FILE__
#endif
#define LOG_STRINGIFY__(x) #x
#define LOG_STRINGIFY_(x) LOG_STRINGIFY__(x)
#define LOG_EXPAND__(x) #x
#define LOG_EXPAND_(x) LOG_EXPAND__(x)
/**
* @defgroup LOG_MACROS Logging macros
* @{
*/
/** Logs a verbose message. Does not include function/line information */
#define log_verbose(...) \
LOG_WRITE(BLADERF_LOG_LEVEL_VERBOSE, "[VERBOSE", __VA_ARGS__)
/** Logs a debug message. Does not include function/line information */
#define log_debug(...) \
LOG_WRITE(BLADERF_LOG_LEVEL_DEBUG, "[DEBUG", __VA_ARGS__)
/** Logs an info message. Does not include function/line information*/
#define log_info(...) \
LOG_WRITE(BLADERF_LOG_LEVEL_INFO, "[INFO", __VA_ARGS__)
/** Logs a warning message. Includes function/line information */
#define log_warning(...) \
LOG_WRITE(BLADERF_LOG_LEVEL_WARNING, "[WARNING", __VA_ARGS__)
/** Logs an error message. Includes function/line information */
#define log_error(...) \
LOG_WRITE(BLADERF_LOG_LEVEL_ERROR, "[ERROR", __VA_ARGS__)
/** Logs a critical error message. Includes function/line information */
#define log_critical(...) \
LOG_WRITE(BLADERF_LOG_LEVEL_CRITICAL, "[CRITICAL", __VA_ARGS__)
/** @} */
#ifdef LOG_INCLUDE_FILE_INFO
# define LOG_WRITE(LEVEL, LEVEL_STRING, ...) \
do { log_write(LEVEL, LEVEL_STRING \
" @ " LOG_EXPAND_(THIS_FILE) \
":" LOG_STRINGIFY_(__LINE__) "] " \
__VA_ARGS__); \
} while (0)
#else
# define LOG_WRITE(LEVEL, LEVEL_STRING, ...) \
do { log_write(LEVEL, LEVEL_STRING "] " __VA_ARGS__); } while (0)
#endif
/**
* Writes a message to the logger with the specified log level. This function
* should only be invoked indirectly through one of the log_*
* convenience macros above to ensure consistent formatting of log messages.
*
* @param level The severity level of the message
* @param format The printf-style format string
* @param ... Optional values for format specifier substitution
*/
#ifdef LOGGING_ENABLED
void log_write(bladerf_log_level level, const char *format, ...);
#else
#define log_write(level, format, ...) do {} while(0)
#endif
/**
* Sets the filter level for displayed log messages. Messages that are at
* or above the specified log level will be written to the log output, while
* messages with a lower log level will be suppressed. This function returns
* the previous log level.
*
* @param level The new log level filter value
*/
#ifdef LOGGING_ENABLED
void log_set_verbosity(bladerf_log_level level);
#else
#define log_set_verbosity(level) do {} while (0)
#endif
/**
* @brief Gets the current filter level for displayed log messages.
*
* @return bladerf_log_level
*/
#ifdef LOGGING_ENABLED
bladerf_log_level log_get_verbosity();
#else
#define log_get_verbosity(...) BLADERF_LOG_LEVEL_SILENT
#endif
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif