drivers/common/mlx5/mlx5_common_mr.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2018 6WIND S.A.
   3  * Copyright 2018 Mellanox Technologies, Ltd
   4  */
   5
   6 #ifndef RTE_PMD_MLX5_COMMON_MR_H_
   7 #define RTE_PMD_MLX5_COMMON_MR_H_
   8
   9 #include <stddef.h>
  10 #include <stdint.h>
  11 #include <sys/queue.h>
  12
  13
  14 #include <rte_rwlock.h>
  15 #include <rte_bitmap.h>
  16 #include <rte_mbuf.h>
  17 #include <rte_memory.h>
  18
  19 #include "mlx5_glue.h"
  20 #include "mlx5_common_mp.h"
  21 #include "mlx5_common_defs.h"
  22
  23 /* mlx5 PMD MR struct. */
  24 struct mlx5_pmd_mr {
  25         uint32_t             lkey;
  26         void                 *addr;
  27         size_t               len;
  28         void                 *obj;  /* verbs mr object or devx umem object. */
  29         struct mlx5_devx_obj *mkey; /* devx mkey object. */
  30 };
  31
  32 /**
  33  * mr operations typedef
  34  */
  35 typedef int (*mlx5_reg_mr_t)(void *pd, void *addr, size_t length,
  36                              struct mlx5_pmd_mr *pmd_mr);
  37 typedef void (*mlx5_dereg_mr_t)(struct mlx5_pmd_mr *pmd_mr);
  38
  39 /* Memory Region object. */
  40 struct mlx5_mr {
  41         LIST_ENTRY(mlx5_mr) mr; /**< Pointer to the prev/next entry. */
  42         struct mlx5_pmd_mr pmd_mr; /* PMD memory region. */
  43         const struct rte_memseg_list *msl;
  44         int ms_base_idx; /* Start index of msl->memseg_arr[]. */
  45         int ms_n; /* Number of memsegs in use. */
  46         uint32_t ms_bmp_n; /* Number of bits in memsegs bit-mask. */
  47         struct rte_bitmap *ms_bmp; /* Bit-mask of memsegs belonged to MR. */
  48 };
  49
  50 /* Cache entry for Memory Region. */
  51 struct mr_cache_entry {
  52         uintptr_t start; /* Start address of MR. */
  53         uintptr_t end; /* End address of MR. */
  54         uint32_t lkey; /* rte_cpu_to_be_32(lkey). */
  55 } __rte_packed;
  56
  57 /* MR Cache table for Binary search. */
  58 struct mlx5_mr_btree {
  59         uint16_t len; /* Number of entries. */
  60         uint16_t size; /* Total number of entries. */
  61         int overflow; /* Mark failure of table expansion. */
  62         struct mr_cache_entry (*table)[];
  63 } __rte_packed;
  64
  65 /* Per-queue MR control descriptor. */
  66 struct mlx5_mr_ctrl {
  67         uint32_t *dev_gen_ptr; /* Generation number of device to poll. */
  68         uint32_t cur_gen; /* Generation number saved to flush caches. */
  69         uint16_t mru; /* Index of last hit entry in top-half cache. */
  70         uint16_t head; /* Index of the oldest entry in top-half cache. */
  71         struct mr_cache_entry cache[MLX5_MR_CACHE_N]; /* Cache for top-half. */
  72         struct mlx5_mr_btree cache_bh; /* Cache for bottom-half. */
  73 } __rte_packed;
  74
  75 LIST_HEAD(mlx5_mr_list, mlx5_mr);
  76 LIST_HEAD(mlx5_mempool_reg_list, mlx5_mempool_reg);
  77
  78 /* Global per-device MR cache. */
  79 struct mlx5_mr_share_cache {
  80         uint32_t dev_gen; /* Generation number to flush local caches. */
  81         rte_rwlock_t rwlock; /* MR cache Lock. */
  82         struct mlx5_mr_btree cache; /* Global MR cache table. */
  83         struct mlx5_mr_list mr_list; /* Registered MR list. */
  84         struct mlx5_mr_list mr_free_list; /* Freed MR list. */
  85         struct mlx5_mempool_reg_list mempool_reg_list; /* Mempool database. */
  86         mlx5_reg_mr_t reg_mr_cb; /* Callback to reg_mr func */
  87         mlx5_dereg_mr_t dereg_mr_cb; /* Callback to dereg_mr func */
  88 } __rte_packed;
  89
  90 /**
  91  * Look up LKey from given lookup table by linear search. Firstly look up the
  92  * last-hit entry. If miss, the entire array is searched. If found, update the
  93  * last-hit index and return LKey.
  94  *
  95  * @param lkp_tbl
  96  *   Pointer to lookup table.
  97  * @param[in,out] cached_idx
  98  *   Pointer to last-hit index.
  99  * @param n
 100  *   Size of lookup table.
 101  * @param addr
 102  *   Search key.
 103  *
 104  * @return
 105  *   Searched LKey on success, UINT32_MAX on no match.
 106  */
 107 static __rte_always_inline uint32_t
 108 mlx5_mr_lookup_lkey(struct mr_cache_entry *lkp_tbl, uint16_t *cached_idx,
 109                     uint16_t n, uintptr_t addr)
 110 {
 111         uint16_t idx;
 112
 113         if (likely(addr >= lkp_tbl[*cached_idx].start &&
 114                    addr < lkp_tbl[*cached_idx].end))
 115                 return lkp_tbl[*cached_idx].lkey;
 116         for (idx = 0; idx < n && lkp_tbl[idx].start != 0; ++idx) {
 117                 if (addr >= lkp_tbl[idx].start &&
 118                     addr < lkp_tbl[idx].end) {
 119                         /* Found. */
 120                         *cached_idx = idx;
 121                         return lkp_tbl[idx].lkey;
 122                 }
 123         }
 124         return UINT32_MAX;
 125 }
 126
 127 __rte_internal
 128 int mlx5_mr_ctrl_init(struct mlx5_mr_ctrl *mr_ctrl, uint32_t *dev_gen_ptr,
 129                       int socket);
 130 __rte_internal
 131 void mlx5_mr_btree_free(struct mlx5_mr_btree *bt);
 132 __rte_internal
 133 void mlx5_mr_btree_dump(struct mlx5_mr_btree *bt __rte_unused);
 134 __rte_internal
 135 uint32_t mlx5_mr_addr2mr_bh(void *pd, struct mlx5_mp_id *mp_id,
 136                             struct mlx5_mr_share_cache *share_cache,
 137                             struct mlx5_mr_ctrl *mr_ctrl,
 138                             uintptr_t addr, unsigned int mr_ext_memseg_en);
 139 __rte_internal
 140 uint32_t mlx5_mr_mempool2mr_bh(struct mlx5_mr_share_cache *share_cache,
 141                                struct mlx5_mr_ctrl *mr_ctrl,
 142                                struct rte_mempool *mp, uintptr_t addr);
 143 void mlx5_mr_release_cache(struct mlx5_mr_share_cache *mr_cache);
 144 int mlx5_mr_create_cache(struct mlx5_mr_share_cache *share_cache, int socket);
 145 __rte_internal
 146 void mlx5_mr_dump_cache(struct mlx5_mr_share_cache *share_cache __rte_unused);
 147 __rte_internal
 148 void mlx5_mr_rebuild_cache(struct mlx5_mr_share_cache *share_cache);
 149 __rte_internal
 150 void mlx5_mr_flush_local_cache(struct mlx5_mr_ctrl *mr_ctrl);
 151 void mlx5_free_mr_by_addr(struct mlx5_mr_share_cache *share_cache,
 152                           const char *ibdev_name, const void *addr, size_t len);
 153 __rte_internal
 154 int
 155 mlx5_mr_insert_cache(struct mlx5_mr_share_cache *share_cache,
 156                      struct mlx5_mr *mr);
 157 __rte_internal
 158 uint32_t
 159 mlx5_mr_lookup_cache(struct mlx5_mr_share_cache *share_cache,
 160                      struct mr_cache_entry *entry, uintptr_t addr);
 161 __rte_internal
 162 struct mlx5_mr *
 163 mlx5_mr_lookup_list(struct mlx5_mr_share_cache *share_cache,
 164                     struct mr_cache_entry *entry, uintptr_t addr);
 165 __rte_internal
 166 struct mlx5_mr *
 167 mlx5_create_mr_ext(void *pd, uintptr_t addr, size_t len, int socket_id,
 168                    mlx5_reg_mr_t reg_mr_cb);
 169 __rte_internal
 170 uint32_t
 171 mlx5_mr_create_primary(void *pd,
 172                        struct mlx5_mr_share_cache *share_cache,
 173                        struct mr_cache_entry *entry, uintptr_t addr,
 174                        unsigned int mr_ext_memseg_en);
 175 __rte_internal
 176 int
 177 mlx5_common_verbs_reg_mr(void *pd, void *addr, size_t length,
 178                          struct mlx5_pmd_mr *pmd_mr);
 179 __rte_internal
 180 void
 181 mlx5_common_verbs_dereg_mr(struct mlx5_pmd_mr *pmd_mr);
 182
 183 void
 184 mlx5_os_set_reg_mr_cb(mlx5_reg_mr_t *reg_mr_cb, mlx5_dereg_mr_t *dereg_mr_cb);
 185
 186 __rte_internal
 187 void
 188 mlx5_mr_free(struct mlx5_mr *mr, mlx5_dereg_mr_t dereg_mr_cb);
 189
 190 __rte_internal
 191 int
 192 mlx5_mr_mempool_register(struct mlx5_mr_share_cache *share_cache, void *pd,
 193                          struct rte_mempool *mp, struct mlx5_mp_id *mp_id);
 194 __rte_internal
 195 int
 196 mlx5_mr_mempool_unregister(struct mlx5_mr_share_cache *share_cache,
 197                            struct rte_mempool *mp, struct mlx5_mp_id *mp_id);
 198
 199 #endif /* RTE_PMD_MLX5_COMMON_MR_H_ */