common/mlx5: introduce common library
[dpdk.git] / drivers / common / mlx5 / mlx5_common.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright 2019 Mellanox Technologies, Ltd
3  */
4
5 #ifndef RTE_PMD_MLX5_COMMON_H_
6 #define RTE_PMD_MLX5_COMMON_H_
7
8 #include <assert.h>
9
10 #include <rte_log.h>
11
12
13 /*
14  * Helper macros to work around __VA_ARGS__ limitations in a C99 compliant
15  * manner.
16  */
17 #define PMD_DRV_LOG_STRIP(a, b) a
18 #define PMD_DRV_LOG_OPAREN (
19 #define PMD_DRV_LOG_CPAREN )
20 #define PMD_DRV_LOG_COMMA ,
21
22 /* Return the file name part of a path. */
23 static inline const char *
24 pmd_drv_log_basename(const char *s)
25 {
26         const char *n = s;
27
28         while (*n)
29                 if (*(n++) == '/')
30                         s = n;
31         return s;
32 }
33
34 #define PMD_DRV_LOG___(level, type, name, ...) \
35         rte_log(RTE_LOG_ ## level, \
36                 type, \
37                 RTE_FMT(name ": " \
38                         RTE_FMT_HEAD(__VA_ARGS__,), \
39                 RTE_FMT_TAIL(__VA_ARGS__,)))
40
41 /*
42  * When debugging is enabled (NDEBUG not defined), file, line and function
43  * information replace the driver name (MLX5_DRIVER_NAME) in log messages.
44  */
45 #ifndef NDEBUG
46
47 #define PMD_DRV_LOG__(level, type, name, ...) \
48         PMD_DRV_LOG___(level, type, name, "%s:%u: %s(): " __VA_ARGS__)
49 #define PMD_DRV_LOG_(level, type, name, s, ...) \
50         PMD_DRV_LOG__(level, type, name,\
51                 s "\n" PMD_DRV_LOG_COMMA \
52                 pmd_drv_log_basename(__FILE__) PMD_DRV_LOG_COMMA \
53                 __LINE__ PMD_DRV_LOG_COMMA \
54                 __func__, \
55                 __VA_ARGS__)
56
57 #else /* NDEBUG */
58 #define PMD_DRV_LOG__(level, type, name, ...) \
59         PMD_DRV_LOG___(level, type, name, __VA_ARGS__)
60 #define PMD_DRV_LOG_(level, type, name, s, ...) \
61         PMD_DRV_LOG__(level, type, name, s "\n", __VA_ARGS__)
62
63 #endif /* NDEBUG */
64
65 /* claim_zero() does not perform any check when debugging is disabled. */
66 #ifndef NDEBUG
67
68 #define DEBUG(...) DRV_LOG(DEBUG, __VA_ARGS__)
69 #define claim_zero(...) assert((__VA_ARGS__) == 0)
70 #define claim_nonzero(...) assert((__VA_ARGS__) != 0)
71
72 #else /* NDEBUG */
73
74 #define DEBUG(...) (void)0
75 #define claim_zero(...) (__VA_ARGS__)
76 #define claim_nonzero(...) (__VA_ARGS__)
77
78 #endif /* NDEBUG */
79
80 /* Allocate a buffer on the stack and fill it with a printf format string. */
81 #define MKSTR(name, ...) \
82         int mkstr_size_##name = snprintf(NULL, 0, "" __VA_ARGS__); \
83         char name[mkstr_size_##name + 1]; \
84         \
85         snprintf(name, sizeof(name), "" __VA_ARGS__)
86
87 #endif /* RTE_PMD_MLX5_COMMON_H_ */