iio-debug.h

/* SPDX-License-Identifier: MIT */
/*
 * libiio - Library for interfacing industrial I/O (IIO) devices
 *
 * Copyright (C) 2021-2023 Analog Devices, Inc.
 * Author: Paul Cercueil <paul.cercueil@analog.com>
 */
 
#ifndef __IIO_DEBUG_H__
#define __IIO_DEBUG_H__
 
#include <iio/iio.h>
 
#define __api __iio_api
 
#if defined(__MINGW32__)
#define __iio_printf __attribute__((__format__(gnu_printf, 3, 4)))
#elif defined(__GNUC__)
#define __iio_printf __attribute__((__format__(printf, 3, 4)))
#else
#define __iio_printf
#endif
 
#ifdef LIBIIO_EXPORTS
#include "iio-config.h"
#define LIBIIO_MAX_LOG_LEVEL MAX_LOG_LEVEL
#else
#define LIBIIO_MAX_LOG_LEVEL LEVEL_DEBUG
#endif
 
#define __FIRST(a, ...) a
#define ___OTHERS(a, ...) a, __VA_ARGS__
#define __OTHERS(a, b, ...) ___OTHERS(a, __VA_ARGS__)
#define __SKIPFIRST(a, ...) __VA_ARGS__

__api __iio_printf void iio_prm_printf(const struct iio_context_params *params,
        enum iio_log_level msg_level, const char *fmt, ...);
 
#define __ctx_params_or_null(ctx) ((ctx) ? iio_context_get_params(ctx) : NULL)
#define __dev_ctx_or_null(dev) ((dev) ? iio_device_get_context(dev) : NULL)
#define __chn_dev_or_null(chn) ((chn) ? iio_channel_get_device(chn) : NULL)
 
/* Passing a null pointer for a "%s" directive is undefined behaviour; glibc
 * prints "(null)" but other C libraries are free to crash. Substitute the
 * string itself so that the device/channel ID is always printable. */
#define __dev_id_str(dev) ((dev) ? iio_device_get_id(dev) : "(null)")
#define __chn_id_str(chn) ((chn) ? iio_channel_get_id(chn) : "(null)")
 
#define prm_err(prm, ...) \
    do { \
        if (LIBIIO_MAX_LOG_LEVEL >= LEVEL_ERROR) \
            iio_prm_printf((prm), LEVEL_ERROR, "ERROR: " __VA_ARGS__); \
    } while (0)
#define prm_warn(prm, ...) \
    do { \
        if (LIBIIO_MAX_LOG_LEVEL >= LEVEL_WARNING) \
            iio_prm_printf((prm), LEVEL_WARNING, "WARNING: " __VA_ARGS__); \
    } while (0)
#define prm_info(prm, ...) \
    do { \
        if (LIBIIO_MAX_LOG_LEVEL >= LEVEL_INFO) \
            iio_prm_printf((prm), LEVEL_INFO, __VA_ARGS__); \
    } while (0)
#define prm_dbg(prm, ...) \
    do { \
        if (LIBIIO_MAX_LOG_LEVEL >= LEVEL_DEBUG) \
            iio_prm_printf((prm), LEVEL_DEBUG, "DEBUG: " __VA_ARGS__); \
    } while (0)
 
#define ctx_err(ctx, ...) prm_err(__ctx_params_or_null(ctx), __VA_ARGS__)
#define ctx_warn(ctx, ...) prm_warn(__ctx_params_or_null(ctx), __VA_ARGS__)
#define ctx_info(ctx, ...) prm_info(__ctx_params_or_null(ctx), __VA_ARGS__)
#define ctx_dbg(ctx, ...) prm_dbg(__ctx_params_or_null(ctx), __VA_ARGS__)
 
#define dev_err(dev, ...) \
    ctx_err(__dev_ctx_or_null(dev), "%s: " __FIRST(__VA_ARGS__, 0) "%s", __dev_id_str(dev), \
            __SKIPFIRST(__VA_ARGS__, ""))
#define dev_warn(dev, ...) \
    ctx_warn(__dev_ctx_or_null(dev), "%s: " __FIRST(__VA_ARGS__, 0) "%s", __dev_id_str(dev), \
            __SKIPFIRST(__VA_ARGS__, ""))
#define dev_info(dev, ...) \
    ctx_info(__dev_ctx_or_null(dev), "%s: " __FIRST(__VA_ARGS__, 0) "%s", __dev_id_str(dev), \
            __SKIPFIRST(__VA_ARGS__, ""))
#define dev_dbg(dev, ...) \
    ctx_dbg(__dev_ctx_or_null(dev), "%s: " __FIRST(__VA_ARGS__, 0) "%s", __dev_id_str(dev), \
            __SKIPFIRST(__VA_ARGS__, ""))
 
#define chn_err(dev, ...) \
    dev_err(__chn_dev_or_null(chn), "%s: " __FIRST(__VA_ARGS__, 0) "%s", __chn_id_str(chn), \
            __SKIPFIRST(__VA_ARGS__, ""))
#define chn_warn(dev, ...) \
    dev_warn(__chn_dev_or_null(chn), "%s: " __FIRST(__VA_ARGS__, 0) "%s", __chn_id_str(chn), \
            __SKIPFIRST(__VA_ARGS__, ""))
#define chn_info(dev, ...) \
    dev_info(__chn_dev_or_null(chn), "%s: " __FIRST(__VA_ARGS__, 0) "%s", __chn_id_str(chn), \
            __SKIPFIRST(__VA_ARGS__, ""))
#define chn_dbg(dev, ...) \
    dev_dbg(__chn_dev_or_null(chn), "%s: " __FIRST(__VA_ARGS__, 0) "%s", __chn_id_str(chn), \
            __SKIPFIRST(__VA_ARGS__, ""))
 
#define prm_perror(params, err, ...) \
    do { \
        if (LIBIIO_MAX_LOG_LEVEL >= LEVEL_ERROR) { \
            char _buf[1024]; \
            int _err = -(err); \
            iio_strerror(_err, _buf, sizeof(_buf)); \
            prm_err(params, __FIRST(__VA_ARGS__, 0) \
                            __OTHERS(": %s\n", __VA_ARGS__, _buf)); \
        } \
    } while (0)
#define ctx_perror(ctx, err, ...) prm_perror(__ctx_params_or_null(ctx), err, __VA_ARGS__)
#define dev_perror(dev, err, ...) \
    ctx_perror(__dev_ctx_or_null(dev), err, "%s: " __FIRST(__VA_ARGS__, 0) "%s", \
            __dev_id_str(dev), __SKIPFIRST(__VA_ARGS__, ""))
#define chn_perror(dev, err, ...) \
    dev_perror(__chn_dev_or_null(chn), err, "%s: " __FIRST(__VA_ARGS__, 0) "%s", \
            __chn_id_str(chn), __SKIPFIRST(__VA_ARGS__, ""))
 
#undef __api
 
#endif /* __IIO_DEBUG_H__ */