rte_debug.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2010-2014 Intel Corporation
 */

#ifndef _RTE_DEBUG_H_
#define _RTE_DEBUG_H_

#include "rte_log.h"
#include "rte_branch_prediction.h"

#ifdef __cplusplus
extern "C" {
#endif

void rte_dump_stack(void);

#define rte_panic(...) rte_panic_(__func__, __VA_ARGS__, "dummy")
#define rte_panic_(func, format, ...) __rte_panic(func, format "%.0s", __VA_ARGS__)

#ifdef RTE_ENABLE_ASSERT
#define RTE_ASSERT(exp) RTE_VERIFY(exp)
#else
/*
 * If RTE_ENABLE_ASSERT is not set, the exp is not checked
 * but not evaluated because of the use of sizeof().
 * The ternary operator is to allow function pointers and bit fields,
 * and to suppress the evaluation of any variable length arrays.
 */
#define RTE_ASSERT(exp) do { \
    (void)sizeof((exp) ? 1 : 0); \
} while (0)
#endif

#define RTE_VERIFY(exp) do {                                                  \
    if (unlikely(!(exp)))                                                           \
        rte_panic("line %d\tassert \"%s\" failed\n", __LINE__, #exp); \
} while (0)

/*
 * Provide notification of a critical non-recoverable error and stop.
 *
 * This function should not be called directly. Refer to rte_panic() macro
 * documentation.
 */
void __rte_panic(const char *funcname , const char *format, ...)
    __rte_cold
    __rte_noreturn
    __rte_format_printf(2, 3);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_DEBUG_H_ */