1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2018 6WIND S.A.
3 * Copyright 2018 Mellanox Technologies, Ltd
6 #ifndef RTE_PMD_MLX5_COMMON_MR_H_
7 #define RTE_PMD_MLX5_COMMON_MR_H_
11 #include <sys/queue.h>
14 /* ISO C doesn't support unnamed structs/unions, disabling -pedantic. */
16 #pragma GCC diagnostic ignored "-Wpedantic"
18 #include <infiniband/verbs.h>
19 #include <infiniband/mlx5dv.h>
21 #pragma GCC diagnostic error "-Wpedantic"
24 #include <rte_rwlock.h>
25 #include <rte_bitmap.h>
26 #include <rte_memory.h>
28 #include "mlx5_common_mp.h"
30 /* Size of per-queue MR cache array for linear search. */
31 #define MLX5_MR_CACHE_N 8
32 #define MLX5_MR_BTREE_CACHE_N 256
34 /* Memory Region object. */
36 LIST_ENTRY(mlx5_mr) mr; /**< Pointer to the prev/next entry. */
37 struct ibv_mr *ibv_mr; /* Verbs Memory Region. */
38 const struct rte_memseg_list *msl;
39 int ms_base_idx; /* Start index of msl->memseg_arr[]. */
40 int ms_n; /* Number of memsegs in use. */
41 uint32_t ms_bmp_n; /* Number of bits in memsegs bit-mask. */
42 struct rte_bitmap *ms_bmp; /* Bit-mask of memsegs belonged to MR. */
45 /* Cache entry for Memory Region. */
46 struct mr_cache_entry {
47 uintptr_t start; /* Start address of MR. */
48 uintptr_t end; /* End address of MR. */
49 uint32_t lkey; /* rte_cpu_to_be_32(ibv_mr->lkey). */
52 /* MR Cache table for Binary search. */
53 struct mlx5_mr_btree {
54 uint16_t len; /* Number of entries. */
55 uint16_t size; /* Total number of entries. */
56 int overflow; /* Mark failure of table expansion. */
57 struct mr_cache_entry (*table)[];
60 /* Per-queue MR control descriptor. */
62 uint32_t *dev_gen_ptr; /* Generation number of device to poll. */
63 uint32_t cur_gen; /* Generation number saved to flush caches. */
64 uint16_t mru; /* Index of last hit entry in top-half cache. */
65 uint16_t head; /* Index of the oldest entry in top-half cache. */
66 struct mr_cache_entry cache[MLX5_MR_CACHE_N]; /* Cache for top-half. */
67 struct mlx5_mr_btree cache_bh; /* Cache for bottom-half. */
70 LIST_HEAD(mlx5_mr_list, mlx5_mr);
72 /* Global per-device MR cache. */
73 struct mlx5_mr_share_cache {
74 uint32_t dev_gen; /* Generation number to flush local caches. */
75 rte_rwlock_t rwlock; /* MR cache Lock. */
76 struct mlx5_mr_btree cache; /* Global MR cache table. */
77 struct mlx5_mr_list mr_list; /* Registered MR list. */
78 struct mlx5_mr_list mr_free_list; /* Freed MR list. */
82 * Look up LKey from given lookup table by linear search. Firstly look up the
83 * last-hit entry. If miss, the entire array is searched. If found, update the
84 * last-hit index and return LKey.
87 * Pointer to lookup table.
88 * @param[in,out] cached_idx
89 * Pointer to last-hit index.
91 * Size of lookup table.
96 * Searched LKey on success, UINT32_MAX on no match.
98 static __rte_always_inline uint32_t
99 mlx5_mr_lookup_lkey(struct mr_cache_entry *lkp_tbl, uint16_t *cached_idx,
100 uint16_t n, uintptr_t addr)
104 if (likely(addr >= lkp_tbl[*cached_idx].start &&
105 addr < lkp_tbl[*cached_idx].end))
106 return lkp_tbl[*cached_idx].lkey;
107 for (idx = 0; idx < n && lkp_tbl[idx].start != 0; ++idx) {
108 if (addr >= lkp_tbl[idx].start &&
109 addr < lkp_tbl[idx].end) {
112 return lkp_tbl[idx].lkey;
119 int mlx5_mr_btree_init(struct mlx5_mr_btree *bt, int n, int socket);
121 void mlx5_mr_btree_free(struct mlx5_mr_btree *bt);
123 void mlx5_mr_btree_dump(struct mlx5_mr_btree *bt __rte_unused);
125 uint32_t mlx5_mr_addr2mr_bh(struct ibv_pd *pd, struct mlx5_mp_id *mp_id,
126 struct mlx5_mr_share_cache *share_cache,
127 struct mlx5_mr_ctrl *mr_ctrl,
128 uintptr_t addr, unsigned int mr_ext_memseg_en);
130 void mlx5_mr_release_cache(struct mlx5_mr_share_cache *mr_cache);
132 void mlx5_mr_dump_cache(struct mlx5_mr_share_cache *share_cache __rte_unused);
134 void mlx5_mr_rebuild_cache(struct mlx5_mr_share_cache *share_cache);
136 void mlx5_mr_flush_local_cache(struct mlx5_mr_ctrl *mr_ctrl);
139 mlx5_mr_insert_cache(struct mlx5_mr_share_cache *share_cache,
143 mlx5_mr_lookup_cache(struct mlx5_mr_share_cache *share_cache,
144 struct mr_cache_entry *entry, uintptr_t addr);
147 mlx5_mr_lookup_list(struct mlx5_mr_share_cache *share_cache,
148 struct mr_cache_entry *entry, uintptr_t addr);
151 mlx5_create_mr_ext(struct ibv_pd *pd, uintptr_t addr, size_t len,
155 mlx5_mr_create_primary(struct ibv_pd *pd,
156 struct mlx5_mr_share_cache *share_cache,
157 struct mr_cache_entry *entry, uintptr_t addr,
158 unsigned int mr_ext_memseg_en);
160 #endif /* RTE_PMD_MLX5_COMMON_MR_H_ */