1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2015 6WIND S.A.
3 * Copyright 2015 Mellanox.
6 #ifndef RTE_PMD_MLX5_UTILS_H_
7 #define RTE_PMD_MLX5_UTILS_H_
16 #include "mlx5_defs.h"
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))))))
37 /* Convert a bit number to the corresponding 64-bit mask */
38 #define MLX5_BITSHIFT(v) (UINT64_C(1) << (v))
40 /* Save and restore errno around argument evaluation. */
41 #define ERRNO_SAFE(x) ((errno = (int []){ errno, ((x), 0) }[0]))
44 * Helper macros to work around __VA_ARGS__ limitations in a C99 compliant
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 ,
52 /* Return the file name part of a path. */
53 static inline const char *
54 pmd_drv_log_basename(const char *s)
65 * When debugging is enabled (NDEBUG not defined), file, line and function
66 * information replace the driver name (MLX5_DRIVER_NAME) in log messages.
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 \
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__)
93 /* Generic printf()-like logging macro with automatic line feed. */
94 #define PMD_DRV_LOG(level, ...) \
96 __VA_ARGS__ PMD_DRV_LOG_STRIP PMD_DRV_LOG_OPAREN, \
100 * Like assert(), DEBUG() becomes a no-op and claim_zero() does not perform
101 * any check when debugging is disabled.
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)
111 #define DEBUG(...) (void)0
112 #define claim_zero(...) (__VA_ARGS__)
113 #define claim_nonzero(...) (__VA_ARGS__)
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__)
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)
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))))
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]; \
140 snprintf(name, sizeof(name), __VA_ARGS__)
143 * Return nearest power of two above input value.
149 * Nearest power of two above input value.
151 static inline unsigned int
152 log2above(unsigned int v)
157 for (l = 0, r = 0; (v >> 1); ++l, v >>= 1)
162 #endif /* RTE_PMD_MLX5_UTILS_H_ */