xref: /dpdk/drivers/net/mlx4/mlx4_utils.h (revision 68a03efeed657e6e05f281479b33b51102797e15)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright 2017 6WIND S.A.
3  * Copyright 2017 Mellanox Technologies, Ltd
4  */
5 
6 #ifndef MLX4_UTILS_H_
7 #define MLX4_UTILS_H_
8 
9 #include <stddef.h>
10 #include <stdio.h>
11 
12 #include <rte_common.h>
13 #include <rte_log.h>
14 
15 #include "mlx4.h"
16 
17 /*
18  * Compilation workaround for PPC64 when AltiVec is fully enabled, e.g. std=c11.
19  * Otherwise there would be a type conflict between stdbool and altivec.
20  */
21 #if defined(__PPC64__) && !defined(__APPLE_ALTIVEC__)
22 #undef bool
23 /* redefine as in stdbool.h */
24 #define bool _Bool
25 #endif
26 
27 extern int mlx4_logtype;
28 
29 #ifdef RTE_LIBRTE_MLX4_DEBUG
30 
31 /*
32  * When debugging is enabled (MLX4_DEBUG is defined), file, line and function
33  * information replace the driver name (MLX4_DRIVER_NAME) in log messages.
34  */
35 
36 /** Return the file name part of a path. */
37 static inline const char *
38 pmd_drv_log_basename(const char *s)
39 {
40 	const char *n = s;
41 
42 	while (*n)
43 		if (*(n++) == '/')
44 			s = n;
45 	return s;
46 }
47 
48 #define PMD_DRV_LOG(level, ...) \
49 	rte_log(RTE_LOG_ ## level, mlx4_logtype, \
50 		RTE_FMT("%s:%u: %s(): " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
51 			pmd_drv_log_basename(__FILE__), \
52 			__LINE__, \
53 			__func__, \
54 			RTE_FMT_TAIL(__VA_ARGS__,)))
55 #define MLX4_ASSERT(exp) RTE_VERIFY(exp)
56 #define claim_zero(...) MLX4_ASSERT((__VA_ARGS__) == 0)
57 
58 #else /* RTE_LIBRTE_MLX4_DEBUG */
59 
60 /*
61  * Like MLX4_ASSERT(), claim_zero() does not perform
62  * any check when debugging is disabled.
63  */
64 
65 #define PMD_DRV_LOG(level, ...) \
66 	rte_log(RTE_LOG_ ## level, mlx4_logtype, \
67 		RTE_FMT(MLX4_DRIVER_NAME ": " \
68 			RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
69 		RTE_FMT_TAIL(__VA_ARGS__,)))
70 #define MLX4_ASSERT(exp) RTE_ASSERT(exp)
71 #define claim_zero(...) (__VA_ARGS__)
72 
73 #endif /* RTE_LIBRTE_MLX4_DEBUG */
74 
75 #define DEBUG(...) PMD_DRV_LOG(DEBUG, __VA_ARGS__)
76 #define INFO(...) PMD_DRV_LOG(INFO, __VA_ARGS__)
77 #define WARN(...) PMD_DRV_LOG(WARNING, __VA_ARGS__)
78 #define ERROR(...) PMD_DRV_LOG(ERR, __VA_ARGS__)
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 /** Generate a string out of the provided arguments. */
88 #define MLX4_STR(...) # __VA_ARGS__
89 
90 /** Similar to MLX4_STR() with enclosed macros expanded first. */
91 #define MLX4_STR_EXPAND(...) MLX4_STR(__VA_ARGS__)
92 
93 /** Object description used with mlx4_mallocv() and similar functions. */
94 struct mlx4_malloc_vec {
95 	size_t align; /**< Alignment constraint (power of 2), 0 if unknown. */
96 	size_t size; /**< Object size. */
97 	void **addr; /**< Storage for allocation address. */
98 };
99 
100 /* mlx4_utils.c */
101 
102 int mlx4_fd_set_non_blocking(int fd);
103 size_t mlx4_mallocv(const char *type, const struct mlx4_malloc_vec *vec,
104 		    unsigned int cnt);
105 size_t mlx4_zmallocv(const char *type, const struct mlx4_malloc_vec *vec,
106 		     unsigned int cnt);
107 size_t mlx4_mallocv_socket(const char *type, const struct mlx4_malloc_vec *vec,
108 			   unsigned int cnt, int socket);
109 size_t mlx4_zmallocv_socket(const char *type, const struct mlx4_malloc_vec *vec,
110 			    unsigned int cnt, int socket);
111 
112 #endif /* MLX4_UTILS_H_ */
113