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 struct mlx5_common_device;
  66
  67 /* Per-queue MR control descriptor. */
  68 struct mlx5_mr_ctrl {
  69         struct mlx5_common_device *cdev; /* Pointer to the mlx5 common device.*/
  70         uint32_t *dev_gen_ptr; /* Generation number of device to poll. */
  71         uint32_t cur_gen; /* Generation number saved to flush caches. */
  72         uint16_t mru; /* Index of last hit entry in top-half cache. */
  73         uint16_t head; /* Index of the oldest entry in top-half cache. */
  74         struct mr_cache_entry cache[MLX5_MR_CACHE_N]; /* Cache for top-half. */
  75         struct mlx5_mr_btree cache_bh; /* Cache for bottom-half. */
  76 } __rte_packed;
  77
  78 LIST_HEAD(mlx5_mr_list, mlx5_mr);
  79 LIST_HEAD(mlx5_mempool_reg_list, mlx5_mempool_reg);
  80
  81 /* Global per-device MR cache. */
  82 struct mlx5_mr_share_cache {
  83         uint32_t dev_gen; /* Generation number to flush local caches. */
  84         rte_rwlock_t rwlock; /* MR cache Lock. */
  85         rte_rwlock_t mprwlock; /* Mempool Registration Lock. */
  86         uint8_t mp_cb_registered; /* Mempool are Registered. */
  87         struct mlx5_mr_btree cache; /* Global MR cache table. */
  88         struct mlx5_mr_list mr_list; /* Registered MR list. */
  89         struct mlx5_mr_list mr_free_list; /* Freed MR list. */
  90         struct mlx5_mempool_reg_list mempool_reg_list; /* Mempool database. */
  91         mlx5_reg_mr_t reg_mr_cb; /* Callback to reg_mr func */
  92         mlx5_dereg_mr_t dereg_mr_cb; /* Callback to dereg_mr func */
  93 } __rte_packed;
  94
  95 /* Multi-Packet RQ buffer header. */
  96 struct mlx5_mprq_buf {
  97         struct rte_mempool *mp;
  98         uint16_t refcnt; /* Atomically accessed refcnt. */
  99         uint8_t pad[RTE_PKTMBUF_HEADROOM]; /* Headroom for the first packet. */
 100         struct rte_mbuf_ext_shared_info shinfos[];
 101         /*
 102          * Shared information per stride.
 103          * More memory will be allocated for the first stride head-room and for
 104          * the strides data.
 105          */
 106 } __rte_cache_aligned;
 107
 108 __rte_internal
 109 void mlx5_mprq_buf_free_cb(void *addr, void *opaque);
 110
 111 /**
 112  * Get Memory Pool (MP) from mbuf. If mbuf is indirect, the pool from which the
 113  * cloned mbuf is allocated is returned instead.
 114  *
 115  * @param buf
 116  *   Pointer to mbuf.
 117  *
 118  * @return
 119  *   Memory pool where data is located for given mbuf.
 120  */
 121 static inline struct rte_mempool *
 122 mlx5_mb2mp(struct rte_mbuf *buf)
 123 {
 124         if (unlikely(RTE_MBUF_CLONED(buf)))
 125                 return rte_mbuf_from_indirect(buf)->pool;
 126         return buf->pool;
 127 }
 128
 129 /**
 130  * Look up LKey from given lookup table by linear search. Firstly look up the
 131  * last-hit entry. If miss, the entire array is searched. If found, update the
 132  * last-hit index and return LKey.
 133  *
 134  * @param lkp_tbl
 135  *   Pointer to lookup table.
 136  * @param[in,out] cached_idx
 137  *   Pointer to last-hit index.
 138  * @param n
 139  *   Size of lookup table.
 140  * @param addr
 141  *   Search key.
 142  *
 143  * @return
 144  *   Searched LKey on success, UINT32_MAX on no match.
 145  */
 146 static __rte_always_inline uint32_t
 147 mlx5_mr_lookup_lkey(struct mr_cache_entry *lkp_tbl, uint16_t *cached_idx,
 148                     uint16_t n, uintptr_t addr)
 149 {
 150         uint16_t idx;
 151
 152         if (likely(addr >= lkp_tbl[*cached_idx].start &&
 153                    addr < lkp_tbl[*cached_idx].end))
 154                 return lkp_tbl[*cached_idx].lkey;
 155         for (idx = 0; idx < n && lkp_tbl[idx].start != 0; ++idx) {
 156                 if (addr >= lkp_tbl[idx].start &&
 157                     addr < lkp_tbl[idx].end) {
 158                         /* Found. */
 159                         *cached_idx = idx;
 160                         return lkp_tbl[idx].lkey;
 161                 }
 162         }
 163         return UINT32_MAX;
 164 }
 165
 166 __rte_internal
 167 void mlx5_mr_flush_local_cache(struct mlx5_mr_ctrl *mr_ctrl);
 168
 169 /**
 170  * Bottom-half of LKey search on. If supported, lookup for the address from
 171  * the mempool. Otherwise, search in old mechanism caches.
 172  *
 173  * @param mr_ctrl
 174  *   Pointer to per-queue MR control structure.
 175  * @param mb
 176  *   Pointer to mbuf.
 177  * @param mp_id
 178  *   Multi-process identifier, may be NULL for the primary process.
 179  *
 180  * @return
 181  *   Searched LKey on success, UINT32_MAX on no match.
 182  */
 183 __rte_internal
 184 uint32_t mlx5_mr_mb2mr_bh(struct mlx5_mr_ctrl *mr_ctrl, struct rte_mbuf *mbuf,
 185                           struct mlx5_mp_id *mp_id);
 186
 187 /**
 188  * Query LKey from a packet buffer.
 189  *
 190  * @param mr_ctrl
 191  *   Pointer to per-queue MR control structure.
 192  * @param mbuf
 193  *   Pointer to mbuf.
 194  * @param mp_id
 195  *   Multi-process identifier, may be NULL for the primary process.
 196  *
 197  * @return
 198  *   Searched LKey on success, UINT32_MAX on no match.
 199  */
 200 static __rte_always_inline uint32_t
 201 mlx5_mr_mb2mr(struct mlx5_mr_ctrl *mr_ctrl, struct rte_mbuf *mbuf,
 202               struct mlx5_mp_id *mp_id)
 203 {
 204         uint32_t lkey;
 205
 206         /* Check generation bit to see if there's any change on existing MRs. */
 207         if (unlikely(*mr_ctrl->dev_gen_ptr != mr_ctrl->cur_gen))
 208                 mlx5_mr_flush_local_cache(mr_ctrl);
 209         /* Linear search on MR cache array. */
 210         lkey = mlx5_mr_lookup_lkey(mr_ctrl->cache, &mr_ctrl->mru,
 211                                    MLX5_MR_CACHE_N, (uintptr_t)mbuf->buf_addr);
 212         if (likely(lkey != UINT32_MAX))
 213                 return lkey;
 214         /* Take slower bottom-half on miss. */
 215         return mlx5_mr_mb2mr_bh(mr_ctrl, mbuf, mp_id);
 216 }
 217
 218 /* mlx5_common_mr.c */
 219
 220 __rte_internal
 221 int mlx5_mr_ctrl_init(struct mlx5_mr_ctrl *mr_ctrl,
 222                       struct mlx5_common_device *cdev, int socket);
 223 __rte_internal
 224 void mlx5_mr_btree_free(struct mlx5_mr_btree *bt);
 225 void mlx5_mr_btree_dump(struct mlx5_mr_btree *bt __rte_unused);
 226 __rte_internal
 227 uint32_t mlx5_mr_mempool2mr_bh(struct mlx5_mr_share_cache *share_cache,
 228                                struct mlx5_mr_ctrl *mr_ctrl,
 229                                struct rte_mempool *mp, uintptr_t addr);
 230 void mlx5_mr_release_cache(struct mlx5_mr_share_cache *mr_cache);
 231 int mlx5_mr_create_cache(struct mlx5_mr_share_cache *share_cache, int socket);
 232 void mlx5_mr_dump_cache(struct mlx5_mr_share_cache *share_cache __rte_unused);
 233 void mlx5_mr_rebuild_cache(struct mlx5_mr_share_cache *share_cache);
 234 void mlx5_free_mr_by_addr(struct mlx5_mr_share_cache *share_cache,
 235                           const char *ibdev_name, const void *addr, size_t len);
 236 int mlx5_mr_insert_cache(struct mlx5_mr_share_cache *share_cache,
 237                          struct mlx5_mr *mr);
 238 struct mlx5_mr *
 239 mlx5_mr_lookup_list(struct mlx5_mr_share_cache *share_cache,
 240                     struct mr_cache_entry *entry, uintptr_t addr);
 241 struct mlx5_mr *
 242 mlx5_create_mr_ext(void *pd, uintptr_t addr, size_t len, int socket_id,
 243                    mlx5_reg_mr_t reg_mr_cb);
 244 void mlx5_mr_free(struct mlx5_mr *mr, mlx5_dereg_mr_t dereg_mr_cb);
 245 __rte_internal
 246 uint32_t
 247 mlx5_mr_create_primary(void *pd,
 248                        struct mlx5_mr_share_cache *share_cache,
 249                        struct mr_cache_entry *entry, uintptr_t addr,
 250                        unsigned int mr_ext_memseg_en);
 251
 252 /* mlx5_common_verbs.c */
 253
 254 __rte_internal
 255 int
 256 mlx5_common_verbs_reg_mr(void *pd, void *addr, size_t length,
 257                          struct mlx5_pmd_mr *pmd_mr);
 258 __rte_internal
 259 void
 260 mlx5_common_verbs_dereg_mr(struct mlx5_pmd_mr *pmd_mr);
 261
 262 void
 263 mlx5_os_set_reg_mr_cb(mlx5_reg_mr_t *reg_mr_cb, mlx5_dereg_mr_t *dereg_mr_cb);
 264
 265 __rte_internal
 266 int
 267 mlx5_mr_mempool_register(struct mlx5_mr_share_cache *share_cache, void *pd,
 268                          struct rte_mempool *mp, struct mlx5_mp_id *mp_id);
 269 __rte_internal
 270 int
 271 mlx5_mr_mempool_unregister(struct mlx5_mr_share_cache *share_cache,
 272                            struct rte_mempool *mp, struct mlx5_mp_id *mp_id);
 273
 274 #endif /* RTE_PMD_MLX5_COMMON_MR_H_ */