common.h

/**
 * @mainpage
 *
 * https://github.com/usnistgov/ndn-dpdk
 */

#ifndef NDNDPDK_CORE_COMMON_H
#define NDNDPDK_CORE_COMMON_H

/** @file */

#if __INTELLISENSE__
// https://github.com/microsoft/vscode-cpptools/issues/4503
#pragma diag_suppress 1094
#endif

#include <assert.h>
#include <inttypes.h>
#include <limits.h>
#include <memory.h>
#include <stdatomic.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#define ALLOW_EXPERIMENTAL_API
#include <rte_config.h>

#include <rte_bitops.h>
#include <rte_branch_prediction.h>
#include <rte_common.h>

#ifndef __BPF__

#include <float.h>
#include <math.h>

#include <urcu/list.h>

#include <rte_byteorder.h>
#include <rte_cycles.h>
#include <rte_debug.h>
#include <rte_errno.h>
#include <rte_malloc.h>
#include <rte_memcpy.h>

#include <spdk/util.h>

#ifdef NDEBUG
#define NDNDPDK_ASSERT(x)                                                                          \
  do {                                                                                             \
    if (__builtin_constant_p((x)) && !(x)) {                                                       \
      __builtin_unreachable();                                                                     \
    }                                                                                              \
  } while (false)
#else
#define NDNDPDK_ASSERT(x) RTE_VERIFY((x))
#endif

#endif // __BPF__

#define STATIC_ASSERT_FUNC_TYPE(typ, func)                                                         \
  static_assert(__builtin_types_compatible_p(typ, typeof(&func)), "")

#ifdef NDEBUG
#define NULLize(x) RTE_SET_USED(x)
#else
/** @brief Set x to NULL to expose memory access bugs. */
#define NULLize(x)                                                                                 \
  do {                                                                                             \
    (x) = NULL;                                                                                    \
  } while (false)
#endif

#ifdef NDNDPDK_POISON
#define POISON_2_(x, size) memset(x, 0x99, size)
#else
#define POISON_2_(x, size)                                                                         \
  do {                                                                                             \
    RTE_SET_USED(x);                                                                               \
    RTE_SET_USED(size);                                                                            \
  } while (false)
#endif
#define POISON_1_(x) POISON_2_((x), sizeof(*(x)))
#define POISON_Arg3_(a1, a2, a3, ...) a3
#define POISON_Choose_(...) POISON_Arg3_(__VA_ARGS__, POISON_2_, POISON_1_)
/**
 * @brief Write junk to memory region to expose memory access bugs.
 * @code
 * POISON(&var);
 * POISON(&var, sizeof(var));
 * @endcode
 */
#define POISON(...) POISON_Choose_(__VA_ARGS__)(__VA_ARGS__)

#define CLAMP(x, lo, hi) RTE_MAX((lo), RTE_MIN((hi), (x)))

#endif // NDNDPDK_CORE_COMMON_H