net/mlx4: fix missing stamp during Tx completion
[dpdk.git] / drivers / net / mlx4 / mlx4_utils.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright 2017 6WIND S.A.
5  *   Copyright 2017 Mellanox
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
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
16  *       distribution.
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.
20  *
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.
32  */
33
34 #ifndef MLX4_UTILS_H_
35 #define MLX4_UTILS_H_
36
37 #include <assert.h>
38 #include <stddef.h>
39 #include <stdio.h>
40
41 #include <rte_common.h>
42 #include <rte_log.h>
43
44 #include "mlx4.h"
45
46 #ifndef NDEBUG
47
48 /*
49  * When debugging is enabled (NDEBUG not defined), file, line and function
50  * information replace the driver name (MLX4_DRIVER_NAME) in log messages.
51  */
52
53 /** Return the file name part of a path. */
54 static inline const char *
55 pmd_drv_log_basename(const char *s)
56 {
57         const char *n = s;
58
59         while (*n)
60                 if (*(n++) == '/')
61                         s = n;
62         return s;
63 }
64
65 #define PMD_DRV_LOG(level, ...) \
66         RTE_LOG(level, PMD, \
67                 RTE_FMT("%s:%u: %s(): " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
68                         pmd_drv_log_basename(__FILE__), \
69                         __LINE__, \
70                         __func__, \
71                         RTE_FMT_TAIL(__VA_ARGS__,)))
72 #define DEBUG(...) PMD_DRV_LOG(DEBUG, __VA_ARGS__)
73 #ifndef MLX4_PMD_DEBUG_BROKEN_VERBS
74 #define claim_zero(...) assert((__VA_ARGS__) == 0)
75 #else /* MLX4_PMD_DEBUG_BROKEN_VERBS */
76 #define claim_zero(...) \
77         (void)(((__VA_ARGS__) == 0) || \
78                 DEBUG("Assertion `(" # __VA_ARGS__ ") == 0' failed (IGNORED)."))
79 #endif /* MLX4_PMD_DEBUG_BROKEN_VERBS */
80
81 #else /* NDEBUG */
82
83 /*
84  * Like assert(), DEBUG() becomes a no-op and claim_zero() does not perform
85  * any check when debugging is disabled.
86  */
87
88 #define PMD_DRV_LOG(level, ...) \
89         RTE_LOG(level, PMD, \
90                 RTE_FMT(MLX4_DRIVER_NAME ": " \
91                         RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
92                 RTE_FMT_TAIL(__VA_ARGS__,)))
93 #define DEBUG(...) (void)0
94 #define claim_zero(...) (__VA_ARGS__)
95
96 #endif /* NDEBUG */
97
98 #define INFO(...) PMD_DRV_LOG(INFO, __VA_ARGS__)
99 #define WARN(...) PMD_DRV_LOG(WARNING, __VA_ARGS__)
100 #define ERROR(...) PMD_DRV_LOG(ERR, __VA_ARGS__)
101
102 /** Allocate a buffer on the stack and fill it with a printf format string. */
103 #define MKSTR(name, ...) \
104         char name[snprintf(NULL, 0, __VA_ARGS__) + 1]; \
105         \
106         snprintf(name, sizeof(name), __VA_ARGS__)
107
108 /** Generate a string out of the provided arguments. */
109 #define MLX4_STR(...) # __VA_ARGS__
110
111 /** Similar to MLX4_STR() with enclosed macros expanded first. */
112 #define MLX4_STR_EXPAND(...) MLX4_STR(__VA_ARGS__)
113
114 /** Object description used with mlx4_mallocv() and similar functions. */
115 struct mlx4_malloc_vec {
116         size_t align; /**< Alignment constraint (power of 2), 0 if unknown. */
117         size_t size; /**< Object size. */
118         void **addr; /**< Storage for allocation address. */
119 };
120
121 /* mlx4_utils.c */
122
123 int mlx4_fd_set_non_blocking(int fd);
124 size_t mlx4_mallocv(const char *type, const struct mlx4_malloc_vec *vec,
125                     unsigned int cnt);
126 size_t mlx4_zmallocv(const char *type, const struct mlx4_malloc_vec *vec,
127                      unsigned int cnt);
128 size_t mlx4_mallocv_socket(const char *type, const struct mlx4_malloc_vec *vec,
129                            unsigned int cnt, int socket);
130 size_t mlx4_zmallocv_socket(const char *type, const struct mlx4_malloc_vec *vec,
131                             unsigned int cnt, int socket);
132
133 #endif /* MLX4_UTILS_H_ */