drivers/net/mlx5/mlx5_utils.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2015 6WIND S.A.
   3  * Copyright 2015 Mellanox.
   4  */
   5
   6 #ifndef RTE_PMD_MLX5_UTILS_H_
   7 #define RTE_PMD_MLX5_UTILS_H_
   8
   9 #include <stddef.h>
  10 #include <stdint.h>
  11 #include <stdio.h>
  12 #include <limits.h>
  13 #include <assert.h>
  14 #include <errno.h>
  15
  16 #include "mlx5_defs.h"
  17
  18 /* Bit-field manipulation. */
  19 #define BITFIELD_DECLARE(bf, type, size) \
  20         type bf[(((size_t)(size) / (sizeof(type) * CHAR_BIT)) + \
  21                  !!((size_t)(size) % (sizeof(type) * CHAR_BIT)))]
  22 #define BITFIELD_DEFINE(bf, type, size) \
  23         BITFIELD_DECLARE((bf), type, (size)) = { 0 }
  24 #define BITFIELD_SET(bf, b) \
  25         (assert((size_t)(b) < (sizeof(bf) * CHAR_BIT)), \
  26          (void)((bf)[((b) / (sizeof((bf)[0]) * CHAR_BIT))] |= \
  27                 ((size_t)1 << ((b) % (sizeof((bf)[0]) * CHAR_BIT)))))
  28 #define BITFIELD_RESET(bf, b) \
  29         (assert((size_t)(b) < (sizeof(bf) * CHAR_BIT)), \
  30          (void)((bf)[((b) / (sizeof((bf)[0]) * CHAR_BIT))] &= \
  31                 ~((size_t)1 << ((b) % (sizeof((bf)[0]) * CHAR_BIT)))))
  32 #define BITFIELD_ISSET(bf, b) \
  33         (assert((size_t)(b) < (sizeof(bf) * CHAR_BIT)), \
  34          !!(((bf)[((b) / (sizeof((bf)[0]) * CHAR_BIT))] & \
  35              ((size_t)1 << ((b) % (sizeof((bf)[0]) * CHAR_BIT))))))
  36
  37 /* Convert a bit number to the corresponding 64-bit mask */
  38 #define MLX5_BITSHIFT(v) (UINT64_C(1) << (v))
  39
  40 /* Save and restore errno around argument evaluation. */
  41 #define ERRNO_SAFE(x) ((errno = (int []){ errno, ((x), 0) }[0]))
  42
  43 /*
  44  * Helper macros to work around __VA_ARGS__ limitations in a C99 compliant
  45  * manner.
  46  */
  47 #define PMD_DRV_LOG_STRIP(a, b) a
  48 #define PMD_DRV_LOG_OPAREN (
  49 #define PMD_DRV_LOG_CPAREN )
  50 #define PMD_DRV_LOG_COMMA ,
  51
  52 /* Return the file name part of a path. */
  53 static inline const char *
  54 pmd_drv_log_basename(const char *s)
  55 {
  56         const char *n = s;
  57
  58         while (*n)
  59                 if (*(n++) == '/')
  60                         s = n;
  61         return s;
  62 }
  63
  64 /*
  65  * When debugging is enabled (NDEBUG not defined), file, line and function
  66  * information replace the driver name (MLX5_DRIVER_NAME) in log messages.
  67  */
  68 #ifndef NDEBUG
  69
  70 #define PMD_DRV_LOG___(level, ...) \
  71         ERRNO_SAFE(RTE_LOG(level, PMD, __VA_ARGS__))
  72 #define PMD_DRV_LOG__(level, ...) \
  73         PMD_DRV_LOG___(level, "%s:%u: %s(): " __VA_ARGS__)
  74 #define PMD_DRV_LOG_(level, s, ...) \
  75         PMD_DRV_LOG__(level, \
  76                 s "\n" PMD_DRV_LOG_COMMA \
  77                 pmd_drv_log_basename(__FILE__) PMD_DRV_LOG_COMMA \
  78                 __LINE__ PMD_DRV_LOG_COMMA \
  79                 __func__, \
  80                 __VA_ARGS__)
  81
  82 #else /* NDEBUG */
  83
  84 #define PMD_DRV_LOG___(level, ...) \
  85         ERRNO_SAFE(RTE_LOG(level, PMD, MLX5_DRIVER_NAME ": " __VA_ARGS__))
  86 #define PMD_DRV_LOG__(level, ...) \
  87         PMD_DRV_LOG___(level, __VA_ARGS__)
  88 #define PMD_DRV_LOG_(level, s, ...) \
  89         PMD_DRV_LOG__(level, s "\n", __VA_ARGS__)
  90
  91 #endif /* NDEBUG */
  92
  93 /* Generic printf()-like logging macro with automatic line feed. */
  94 #define PMD_DRV_LOG(level, ...) \
  95         PMD_DRV_LOG_(level, \
  96                 __VA_ARGS__ PMD_DRV_LOG_STRIP PMD_DRV_LOG_OPAREN, \
  97                 PMD_DRV_LOG_CPAREN)
  98
  99 /*
 100  * Like assert(), DEBUG() becomes a no-op and claim_zero() does not perform
 101  * any check when debugging is disabled.
 102  */
 103 #ifndef NDEBUG
 104
 105 #define DEBUG(...) PMD_DRV_LOG(DEBUG, __VA_ARGS__)
 106 #define claim_zero(...) assert((__VA_ARGS__) == 0)
 107 #define claim_nonzero(...) assert((__VA_ARGS__) != 0)
 108
 109 #else /* NDEBUG */
 110
 111 #define DEBUG(...) (void)0
 112 #define claim_zero(...) (__VA_ARGS__)
 113 #define claim_nonzero(...) (__VA_ARGS__)
 114
 115 #endif /* NDEBUG */
 116
 117 #define INFO(...) PMD_DRV_LOG(INFO, __VA_ARGS__)
 118 #define WARN(...) PMD_DRV_LOG(WARNING, __VA_ARGS__)
 119 #define ERROR(...) PMD_DRV_LOG(ERR, __VA_ARGS__)
 120
 121 /* Convenience macros for accessing mbuf fields. */
 122 #define NEXT(m) ((m)->next)
 123 #define DATA_LEN(m) ((m)->data_len)
 124 #define PKT_LEN(m) ((m)->pkt_len)
 125 #define DATA_OFF(m) ((m)->data_off)
 126 #define SET_DATA_OFF(m, o) ((m)->data_off = (o))
 127 #define NB_SEGS(m) ((m)->nb_segs)
 128 #define PORT(m) ((m)->port)
 129
 130 /* Transpose flags. Useful to convert IBV to DPDK flags. */
 131 #define TRANSPOSE(val, from, to) \
 132         (((from) >= (to)) ? \
 133          (((val) & (from)) / ((from) / (to))) : \
 134          (((val) & (from)) * ((to) / (from))))
 135
 136 /* Allocate a buffer on the stack and fill it with a printf format string. */
 137 #define MKSTR(name, ...) \
 138         char name[snprintf(NULL, 0, __VA_ARGS__) + 1]; \
 139         \
 140         snprintf(name, sizeof(name), __VA_ARGS__)
 141
 142 /**
 143  * Return nearest power of two above input value.
 144  *
 145  * @param v
 146  *   Input value.
 147  *
 148  * @return
 149  *   Nearest power of two above input value.
 150  */
 151 static inline unsigned int
 152 log2above(unsigned int v)
 153 {
 154         unsigned int l;
 155         unsigned int r;
 156
 157         for (l = 0, r = 0; (v >> 1); ++l, v >>= 1)
 158                 r |= (v & 1);
 159         return l + r;
 160 }
 161
 162 #endif /* RTE_PMD_MLX5_UTILS_H_ */