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 22 /* Size of per-queue MR cache array for linear search. */ 23 #define MLX5_MR_CACHE_N 8 24 #define MLX5_MR_BTREE_CACHE_N 256 25 26 /* mlx5 PMD MR struct. */ 27 struct mlx5_pmd_mr { 28 uint32_t lkey; 29 void *addr; 30 size_t len; 31 void *obj; /* verbs mr object or devx umem object. */ 32 struct mlx5_devx_obj *mkey; /* devx mkey object. */ 33 }; 34 35 /** 36 * mr operations typedef 37 */ 38 typedef int (*mlx5_reg_mr_t)(void *pd, void *addr, size_t length, 39 struct mlx5_pmd_mr *pmd_mr); 40 typedef void (*mlx5_dereg_mr_t)(struct mlx5_pmd_mr *pmd_mr); 41 42 /* Memory Region object. */ 43 struct mlx5_mr { 44 LIST_ENTRY(mlx5_mr) mr; /**< Pointer to the prev/next entry. */ 45 struct mlx5_pmd_mr pmd_mr; /* PMD memory region. */ 46 const struct rte_memseg_list *msl; 47 int ms_base_idx; /* Start index of msl->memseg_arr[]. */ 48 int ms_n; /* Number of memsegs in use. */ 49 uint32_t ms_bmp_n; /* Number of bits in memsegs bit-mask. */ 50 struct rte_bitmap *ms_bmp; /* Bit-mask of memsegs belonged to MR. */ 51 }; 52 53 /* Cache entry for Memory Region. */ 54 struct mr_cache_entry { 55 uintptr_t start; /* Start address of MR. */ 56 uintptr_t end; /* End address of MR. */ 57 uint32_t lkey; /* rte_cpu_to_be_32(lkey). */ 58 } __rte_packed; 59 60 /* MR Cache table for Binary search. */ 61 struct mlx5_mr_btree { 62 uint16_t len; /* Number of entries. */ 63 uint16_t size; /* Total number of entries. */ 64 int overflow; /* Mark failure of table expansion. */ 65 struct mr_cache_entry (*table)[]; 66 } __rte_packed; 67 68 /* Per-queue MR control descriptor. */ 69 struct mlx5_mr_ctrl { 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 struct mlx5_mr_btree cache; /* Global MR cache table. */ 86 struct mlx5_mr_list mr_list; /* Registered MR list. */ 87 struct mlx5_mr_list mr_free_list; /* Freed MR list. */ 88 struct mlx5_mempool_reg_list mempool_reg_list; /* Mempool database. */ 89 mlx5_reg_mr_t reg_mr_cb; /* Callback to reg_mr func */ 90 mlx5_dereg_mr_t dereg_mr_cb; /* Callback to dereg_mr func */ 91 } __rte_packed; 92 93 /** 94 * Look up LKey from given lookup table by linear search. Firstly look up the 95 * last-hit entry. If miss, the entire array is searched. If found, update the 96 * last-hit index and return LKey. 97 * 98 * @param lkp_tbl 99 * Pointer to lookup table. 100 * @param[in,out] cached_idx 101 * Pointer to last-hit index. 102 * @param n 103 * Size of lookup table. 104 * @param addr 105 * Search key. 106 * 107 * @return 108 * Searched LKey on success, UINT32_MAX on no match. 109 */ 110 static __rte_always_inline uint32_t 111 mlx5_mr_lookup_lkey(struct mr_cache_entry *lkp_tbl, uint16_t *cached_idx, 112 uint16_t n, uintptr_t addr) 113 { 114 uint16_t idx; 115 116 if (likely(addr >= lkp_tbl[*cached_idx].start && 117 addr < lkp_tbl[*cached_idx].end)) 118 return lkp_tbl[*cached_idx].lkey; 119 for (idx = 0; idx < n && lkp_tbl[idx].start != 0; ++idx) { 120 if (addr >= lkp_tbl[idx].start && 121 addr < lkp_tbl[idx].end) { 122 /* Found. */ 123 *cached_idx = idx; 124 return lkp_tbl[idx].lkey; 125 } 126 } 127 return UINT32_MAX; 128 } 129 130 __rte_internal 131 int mlx5_mr_btree_init(struct mlx5_mr_btree *bt, int n, int socket); 132 __rte_internal 133 void mlx5_mr_btree_free(struct mlx5_mr_btree *bt); 134 __rte_internal 135 void mlx5_mr_btree_dump(struct mlx5_mr_btree *bt __rte_unused); 136 __rte_internal 137 uint32_t mlx5_mr_addr2mr_bh(void *pd, struct mlx5_mp_id *mp_id, 138 struct mlx5_mr_share_cache *share_cache, 139 struct mlx5_mr_ctrl *mr_ctrl, 140 uintptr_t addr, unsigned int mr_ext_memseg_en); 141 __rte_internal 142 uint32_t mlx5_mr_mempool2mr_bh(struct mlx5_mr_share_cache *share_cache, 143 struct mlx5_mr_ctrl *mr_ctrl, 144 struct rte_mempool *mp, uintptr_t addr); 145 __rte_internal 146 void mlx5_mr_release_cache(struct mlx5_mr_share_cache *mr_cache); 147 __rte_internal 148 void mlx5_mr_dump_cache(struct mlx5_mr_share_cache *share_cache __rte_unused); 149 __rte_internal 150 void mlx5_mr_rebuild_cache(struct mlx5_mr_share_cache *share_cache); 151 __rte_internal 152 void mlx5_mr_flush_local_cache(struct mlx5_mr_ctrl *mr_ctrl); 153 __rte_internal 154 void mlx5_free_mr_by_addr(struct mlx5_mr_share_cache *share_cache, 155 const char *ibdev_name, const void *addr, size_t len); 156 __rte_internal 157 int 158 mlx5_mr_insert_cache(struct mlx5_mr_share_cache *share_cache, 159 struct mlx5_mr *mr); 160 __rte_internal 161 uint32_t 162 mlx5_mr_lookup_cache(struct mlx5_mr_share_cache *share_cache, 163 struct mr_cache_entry *entry, uintptr_t addr); 164 __rte_internal 165 struct mlx5_mr * 166 mlx5_mr_lookup_list(struct mlx5_mr_share_cache *share_cache, 167 struct mr_cache_entry *entry, uintptr_t addr); 168 __rte_internal 169 struct mlx5_mr * 170 mlx5_create_mr_ext(void *pd, uintptr_t addr, size_t len, int socket_id, 171 mlx5_reg_mr_t reg_mr_cb); 172 __rte_internal 173 uint32_t 174 mlx5_mr_create_primary(void *pd, 175 struct mlx5_mr_share_cache *share_cache, 176 struct mr_cache_entry *entry, uintptr_t addr, 177 unsigned int mr_ext_memseg_en); 178 __rte_internal 179 int 180 mlx5_common_verbs_reg_mr(void *pd, void *addr, size_t length, 181 struct mlx5_pmd_mr *pmd_mr); 182 __rte_internal 183 void 184 mlx5_common_verbs_dereg_mr(struct mlx5_pmd_mr *pmd_mr); 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_ */ 200