drivers/net/mlx4/mlx4_utils.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2017 6WIND S.A.
   3  * Copyright 2017 Mellanox
   4  */
   5
   6 #ifndef MLX4_UTILS_H_
   7 #define MLX4_UTILS_H_
   8
   9 #include <assert.h>
  10 #include <stddef.h>
  11 #include <stdio.h>
  12
  13 #include <rte_common.h>
  14 #include <rte_log.h>
  15
  16 #include "mlx4.h"
  17
  18 #ifndef NDEBUG
  19
  20 /*
  21  * When debugging is enabled (NDEBUG not defined), file, line and function
  22  * information replace the driver name (MLX4_DRIVER_NAME) in log messages.
  23  */
  24
  25 /** Return the file name part of a path. */
  26 static inline const char *
  27 pmd_drv_log_basename(const char *s)
  28 {
  29         const char *n = s;
  30
  31         while (*n)
  32                 if (*(n++) == '/')
  33                         s = n;
  34         return s;
  35 }
  36
  37 #define PMD_DRV_LOG(level, ...) \
  38         RTE_LOG(level, PMD, \
  39                 RTE_FMT("%s:%u: %s(): " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
  40                         pmd_drv_log_basename(__FILE__), \
  41                         __LINE__, \
  42                         __func__, \
  43                         RTE_FMT_TAIL(__VA_ARGS__,)))
  44 #define DEBUG(...) PMD_DRV_LOG(DEBUG, __VA_ARGS__)
  45 #define claim_zero(...) assert((__VA_ARGS__) == 0)
  46
  47 #else /* NDEBUG */
  48
  49 /*
  50  * Like assert(), DEBUG() becomes a no-op and claim_zero() does not perform
  51  * any check when debugging is disabled.
  52  */
  53
  54 #define PMD_DRV_LOG(level, ...) \
  55         RTE_LOG(level, PMD, \
  56                 RTE_FMT(MLX4_DRIVER_NAME ": " \
  57                         RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
  58                 RTE_FMT_TAIL(__VA_ARGS__,)))
  59 #define DEBUG(...) (void)0
  60 #define claim_zero(...) (__VA_ARGS__)
  61
  62 #endif /* NDEBUG */
  63
  64 #define INFO(...) PMD_DRV_LOG(INFO, __VA_ARGS__)
  65 #define WARN(...) PMD_DRV_LOG(WARNING, __VA_ARGS__)
  66 #define ERROR(...) PMD_DRV_LOG(ERR, __VA_ARGS__)
  67
  68 /** Allocate a buffer on the stack and fill it with a printf format string. */
  69 #define MKSTR(name, ...) \
  70         char name[snprintf(NULL, 0, __VA_ARGS__) + 1]; \
  71         \
  72         snprintf(name, sizeof(name), __VA_ARGS__)
  73
  74 /** Generate a string out of the provided arguments. */
  75 #define MLX4_STR(...) # __VA_ARGS__
  76
  77 /** Similar to MLX4_STR() with enclosed macros expanded first. */
  78 #define MLX4_STR_EXPAND(...) MLX4_STR(__VA_ARGS__)
  79
  80 /** Object description used with mlx4_mallocv() and similar functions. */
  81 struct mlx4_malloc_vec {
  82         size_t align; /**< Alignment constraint (power of 2), 0 if unknown. */
  83         size_t size; /**< Object size. */
  84         void **addr; /**< Storage for allocation address. */
  85 };
  86
  87 /* mlx4_utils.c */
  88
  89 int mlx4_fd_set_non_blocking(int fd);
  90 size_t mlx4_mallocv(const char *type, const struct mlx4_malloc_vec *vec,
  91                     unsigned int cnt);
  92 size_t mlx4_zmallocv(const char *type, const struct mlx4_malloc_vec *vec,
  93                      unsigned int cnt);
  94 size_t mlx4_mallocv_socket(const char *type, const struct mlx4_malloc_vec *vec,
  95                            unsigned int cnt, int socket);
  96 size_t mlx4_zmallocv_socket(const char *type, const struct mlx4_malloc_vec *vec,
  97                             unsigned int cnt, int socket);
  98
  99 #endif /* MLX4_UTILS_H_ */