4 * Copyright 2015 6WIND S.A.
5 * Copyright 2015 Mellanox.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of 6WIND S.A. nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #ifndef RTE_PMD_MLX5_UTILS_H_
35 #define RTE_PMD_MLX5_UTILS_H_
44 #include "mlx5_defs.h"
46 /* Bit-field manipulation. */
47 #define BITFIELD_DECLARE(bf, type, size) \
48 type bf[(((size_t)(size) / (sizeof(type) * CHAR_BIT)) + \
49 !!((size_t)(size) % (sizeof(type) * CHAR_BIT)))]
50 #define BITFIELD_DEFINE(bf, type, size) \
51 BITFIELD_DECLARE((bf), type, (size)) = { 0 }
52 #define BITFIELD_SET(bf, b) \
53 (assert((size_t)(b) < (sizeof(bf) * CHAR_BIT)), \
54 (void)((bf)[((b) / (sizeof((bf)[0]) * CHAR_BIT))] |= \
55 ((size_t)1 << ((b) % (sizeof((bf)[0]) * CHAR_BIT)))))
56 #define BITFIELD_RESET(bf, b) \
57 (assert((size_t)(b) < (sizeof(bf) * CHAR_BIT)), \
58 (void)((bf)[((b) / (sizeof((bf)[0]) * CHAR_BIT))] &= \
59 ~((size_t)1 << ((b) % (sizeof((bf)[0]) * CHAR_BIT)))))
60 #define BITFIELD_ISSET(bf, b) \
61 (assert((size_t)(b) < (sizeof(bf) * CHAR_BIT)), \
62 !!(((bf)[((b) / (sizeof((bf)[0]) * CHAR_BIT))] & \
63 ((size_t)1 << ((b) % (sizeof((bf)[0]) * CHAR_BIT))))))
65 /* Convert a bit number to the corresponding 64-bit mask */
66 #define MLX5_BITSHIFT(v) (UINT64_C(1) << (v))
68 /* Save and restore errno around argument evaluation. */
69 #define ERRNO_SAFE(x) ((errno = (int []){ errno, ((x), 0) }[0]))
72 * Helper macros to work around __VA_ARGS__ limitations in a C99 compliant
75 #define PMD_DRV_LOG_STRIP(a, b) a
76 #define PMD_DRV_LOG_OPAREN (
77 #define PMD_DRV_LOG_CPAREN )
78 #define PMD_DRV_LOG_COMMA ,
80 /* Return the file name part of a path. */
81 static inline const char *
82 pmd_drv_log_basename(const char *s)
93 * When debugging is enabled (NDEBUG not defined), file, line and function
94 * information replace the driver name (MLX5_DRIVER_NAME) in log messages.
98 #define PMD_DRV_LOG___(level, ...) \
99 ERRNO_SAFE(RTE_LOG(level, PMD, __VA_ARGS__))
100 #define PMD_DRV_LOG__(level, ...) \
101 PMD_DRV_LOG___(level, "%s:%u: %s(): " __VA_ARGS__)
102 #define PMD_DRV_LOG_(level, s, ...) \
103 PMD_DRV_LOG__(level, \
104 s "\n" PMD_DRV_LOG_COMMA \
105 pmd_drv_log_basename(__FILE__) PMD_DRV_LOG_COMMA \
106 __LINE__ PMD_DRV_LOG_COMMA \
112 #define PMD_DRV_LOG___(level, ...) \
113 ERRNO_SAFE(RTE_LOG(level, PMD, MLX5_DRIVER_NAME ": " __VA_ARGS__))
114 #define PMD_DRV_LOG__(level, ...) \
115 PMD_DRV_LOG___(level, __VA_ARGS__)
116 #define PMD_DRV_LOG_(level, s, ...) \
117 PMD_DRV_LOG__(level, s "\n", __VA_ARGS__)
121 /* Generic printf()-like logging macro with automatic line feed. */
122 #define PMD_DRV_LOG(level, ...) \
123 PMD_DRV_LOG_(level, \
124 __VA_ARGS__ PMD_DRV_LOG_STRIP PMD_DRV_LOG_OPAREN, \
128 * Like assert(), DEBUG() becomes a no-op and claim_zero() does not perform
129 * any check when debugging is disabled.
133 #define DEBUG(...) PMD_DRV_LOG(DEBUG, __VA_ARGS__)
134 #define claim_zero(...) assert((__VA_ARGS__) == 0)
135 #define claim_nonzero(...) assert((__VA_ARGS__) != 0)
139 #define DEBUG(...) (void)0
140 #define claim_zero(...) (__VA_ARGS__)
141 #define claim_nonzero(...) (__VA_ARGS__)
145 #define INFO(...) PMD_DRV_LOG(INFO, __VA_ARGS__)
146 #define WARN(...) PMD_DRV_LOG(WARNING, __VA_ARGS__)
147 #define ERROR(...) PMD_DRV_LOG(ERR, __VA_ARGS__)
149 /* Convenience macros for accessing mbuf fields. */
150 #define NEXT(m) ((m)->next)
151 #define DATA_LEN(m) ((m)->data_len)
152 #define PKT_LEN(m) ((m)->pkt_len)
153 #define DATA_OFF(m) ((m)->data_off)
154 #define SET_DATA_OFF(m, o) ((m)->data_off = (o))
155 #define NB_SEGS(m) ((m)->nb_segs)
156 #define PORT(m) ((m)->port)
158 /* Transpose flags. Useful to convert IBV to DPDK flags. */
159 #define TRANSPOSE(val, from, to) \
160 (((from) >= (to)) ? \
161 (((val) & (from)) / ((from) / (to))) : \
162 (((val) & (from)) * ((to) / (from))))
164 /* Allocate a buffer on the stack and fill it with a printf format string. */
165 #define MKSTR(name, ...) \
166 char name[snprintf(NULL, 0, __VA_ARGS__) + 1]; \
168 snprintf(name, sizeof(name), __VA_ARGS__)
171 * Return nearest power of two above input value.
177 * Nearest power of two above input value.
179 static inline unsigned int
180 log2above(unsigned int v)
185 for (l = 0, r = 0; (v >> 1); ++l, v >>= 1)
190 #endif /* RTE_PMD_MLX5_UTILS_H_ */