1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2015 6WIND S.A.
3 * Copyright 2015 Mellanox Technologies, Ltd
6 #ifndef RTE_PMD_MLX5_UTILS_H_
7 #define RTE_PMD_MLX5_UTILS_H_
15 #include <rte_spinlock.h>
16 #include <rte_memory.h>
17 #include <rte_bitmap.h>
19 #include <mlx5_common.h>
21 #include "mlx5_defs.h"
24 /* Convert a bit number to the corresponding 64-bit mask */
25 #define MLX5_BITSHIFT(v) (UINT64_C(1) << (v))
27 /* Save and restore errno around argument evaluation. */
28 #define ERRNO_SAFE(x) ((errno = (int []){ errno, ((x), 0) }[0]))
30 extern int mlx5_logtype;
32 /* Generic printf()-like logging macro with automatic line feed. */
33 #define DRV_LOG(level, ...) \
34 PMD_DRV_LOG_(level, mlx5_logtype, MLX5_DRIVER_NAME, \
35 __VA_ARGS__ PMD_DRV_LOG_STRIP PMD_DRV_LOG_OPAREN, \
38 /* Convenience macros for accessing mbuf fields. */
39 #define NEXT(m) ((m)->next)
40 #define DATA_LEN(m) ((m)->data_len)
41 #define PKT_LEN(m) ((m)->pkt_len)
42 #define DATA_OFF(m) ((m)->data_off)
43 #define SET_DATA_OFF(m, o) ((m)->data_off = (o))
44 #define NB_SEGS(m) ((m)->nb_segs)
45 #define PORT(m) ((m)->port)
47 /* Transpose flags. Useful to convert IBV to DPDK flags. */
48 #define TRANSPOSE(val, from, to) \
50 (((val) & (from)) / ((from) / (to))) : \
51 (((val) & (from)) * ((to) / (from))))
54 * For the case which data is linked with sequence increased index, the
55 * array table will be more efficiect than hash table once need to serarch
56 * one data entry in large numbers of entries. Since the traditional hash
57 * tables has fixed table size, when huge numbers of data saved to the hash
58 * table, it also comes lots of hash conflict.
60 * But simple array table also has fixed size, allocates all the needed
61 * memory at once will waste lots of memory. For the case don't know the
62 * exactly number of entries will be impossible to allocate the array.
64 * Then the multiple level table helps to balance the two disadvantages.
65 * Allocate a global high level table with sub table entries at first,
66 * the global table contains the sub table entries, and the sub table will
67 * be allocated only once the corresponding index entry need to be saved.
68 * e.g. for up to 32-bits index, three level table with 10-10-12 splitting,
69 * with sequence increased index, the memory grows with every 4K entries.
71 * The currently implementation introduces 10-10-12 32-bits splitting
72 * Three-Level table to help the cases which have millions of enties to
73 * save. The index entries can be addressed directly by the index, no
74 * search will be needed.q
77 /* L3 table global table define. */
78 #define MLX5_L3T_GT_OFFSET 22
79 #define MLX5_L3T_GT_SIZE (1 << 10)
80 #define MLX5_L3T_GT_MASK (MLX5_L3T_GT_SIZE - 1)
82 /* L3 table middle table define. */
83 #define MLX5_L3T_MT_OFFSET 12
84 #define MLX5_L3T_MT_SIZE (1 << 10)
85 #define MLX5_L3T_MT_MASK (MLX5_L3T_MT_SIZE - 1)
87 /* L3 table entry table define. */
88 #define MLX5_L3T_ET_OFFSET 0
89 #define MLX5_L3T_ET_SIZE (1 << 12)
90 #define MLX5_L3T_ET_MASK (MLX5_L3T_ET_SIZE - 1)
94 MLX5_L3T_TYPE_WORD = 0,
101 struct mlx5_indexed_pool;
103 /* Generic data struct. */
104 union mlx5_l3t_data {
111 /* L3 level table data structure. */
112 struct mlx5_l3t_level_tbl {
113 uint64_t ref_cnt; /* Table ref_cnt. */
114 void *tbl[]; /* Table array. */
117 /* L3 word entry table data structure. */
118 struct mlx5_l3t_entry_word {
119 uint32_t idx; /* Table index. */
120 uint64_t ref_cnt; /* Table ref_cnt. */
121 uint16_t entry[]; /* Entry array. */
124 /* L3 double word entry table data structure. */
125 struct mlx5_l3t_entry_dword {
126 uint32_t idx; /* Table index. */
127 uint64_t ref_cnt; /* Table ref_cnt. */
128 uint32_t entry[]; /* Entry array. */
131 /* L3 quad word entry table data structure. */
132 struct mlx5_l3t_entry_qword {
133 uint32_t idx; /* Table index. */
134 uint64_t ref_cnt; /* Table ref_cnt. */
135 uint64_t entry[]; /* Entry array. */
138 /* L3 pointer entry table data structure. */
139 struct mlx5_l3t_entry_ptr {
140 uint32_t idx; /* Table index. */
141 uint64_t ref_cnt; /* Table ref_cnt. */
142 void *entry[]; /* Entry array. */
145 /* L3 table data structure. */
146 struct mlx5_l3t_tbl {
147 enum mlx5_l3t_type type; /* Table type. */
148 struct mlx5_indexed_pool *eip;
149 /* Table index pool handles. */
150 struct mlx5_l3t_level_tbl *tbl; /* Global table index. */
154 * The indexed memory entry index is made up of trunk index and offset of
155 * the entry in the trunk. Since the entry index is 32 bits, in case user
156 * prefers to have small trunks, user can change the macro below to a big
157 * number which helps the pool contains more trunks with lots of entries
160 #define TRUNK_IDX_BITS 16
161 #define TRUNK_MAX_IDX ((1 << TRUNK_IDX_BITS) - 1)
162 #define TRUNK_INVALID TRUNK_MAX_IDX
163 #define MLX5_IPOOL_DEFAULT_TRUNK_SIZE (1 << (28 - TRUNK_IDX_BITS))
164 #ifdef RTE_LIBRTE_MLX5_DEBUG
168 struct mlx5_indexed_pool_config {
169 uint32_t size; /* Pool entry size. */
170 uint32_t trunk_size:22;
172 * Trunk entry number. Must be power of 2. It can be increased
173 * if trunk_grow enable. The trunk entry number increases with
174 * left shift grow_shift. Trunks with index are after grow_trunk
175 * will keep the entry number same with the last grow trunk.
177 uint32_t grow_trunk:4;
179 * Trunks with entry number increase in the pool. Set it to 0
180 * to make the pool works as trunk entry fixed pool. It works
181 * only if grow_shift is not 0.
183 uint32_t grow_shift:4;
185 * Trunk entry number increase shift value, stop after grow_trunk.
186 * It works only if grow_trunk is not 0.
188 uint32_t need_lock:1;
189 /* Lock is needed for multiple thread usage. */
190 uint32_t release_mem_en:1; /* Rlease trunk when it is free. */
191 const char *type; /* Memory allocate type name. */
192 void *(*malloc)(uint32_t flags, size_t size, unsigned int align,
194 /* User defined memory allocator. */
195 void (*free)(void *addr); /* User defined memory release. */
198 struct mlx5_indexed_trunk {
199 uint32_t idx; /* Trunk id. */
200 uint32_t prev; /* Previous free trunk in free list. */
201 uint32_t next; /* Next free trunk in free list. */
202 uint32_t free; /* Free entries available */
203 struct rte_bitmap *bmp;
204 uint8_t data[] __rte_cache_aligned; /* Entry data start. */
207 struct mlx5_indexed_pool {
208 struct mlx5_indexed_pool_config cfg; /* Indexed pool configuration. */
209 rte_spinlock_t lock; /* Pool lock for multiple thread usage. */
210 uint32_t n_trunk_valid; /* Trunks allocated. */
211 uint32_t n_trunk; /* Trunk pointer array size. */
212 /* Dim of trunk pointer array. */
213 struct mlx5_indexed_trunk **trunks;
214 uint32_t free_list; /* Index to first free trunk. */
218 uint32_t trunk_avail;
219 uint32_t trunk_empty;
222 uint32_t grow_tbl[]; /* Save the index offset for the grow trunks. */
226 * Return logarithm of the nearest power of two above input value.
232 * Logarithm of the nearest power of two above input value.
234 static inline unsigned int
235 log2above(unsigned int v)
240 for (l = 0, r = 0; (v >> 1); ++l, v >>= 1)
245 /** Maximum size of string for naming the hlist table. */
246 #define MLX5_HLIST_NAMESIZE 32
249 * Structure of the entry in the hash list, user should define its own struct
250 * that contains this in order to store the data. The 'key' is 64-bits right
251 * now and its user's responsibility to guarantee there is no collision.
253 struct mlx5_hlist_entry {
254 LIST_ENTRY(mlx5_hlist_entry) next; /* entry pointers in the list. */
255 uint64_t key; /* user defined 'key', could be the hash signature. */
258 /** Structure for hash head. */
259 LIST_HEAD(mlx5_hlist_head, mlx5_hlist_entry);
261 /** Type of function that is used to handle the data before freeing. */
262 typedef void (*mlx5_hlist_destroy_callback_fn)(void *p, void *ctx);
265 * Type of function for user defined matching.
268 * The entry in the list.
270 * The pointer to new entry context.
273 * 0 if matching, -1 otherwise.
275 typedef int (*mlx5_hlist_match_callback_fn)(struct mlx5_hlist_entry *entry,
278 /** hash list table structure */
280 char name[MLX5_HLIST_NAMESIZE]; /**< Name of the hash list. */
281 /**< number of heads, need to be power of 2. */
283 /**< mask to get the index of the list heads. */
285 struct mlx5_hlist_head heads[]; /**< list head arrays. */
289 * Create a hash list table, the user can specify the list heads array size
290 * of the table, now the size should be a power of 2 in order to get better
291 * distribution for the entries. Each entry is a part of the whole data element
292 * and the caller should be responsible for the data element's allocation and
293 * cleanup / free. Key of each entry will be calculated with CRC in order to
294 * generate a little fairer distribution.
297 * Name of the hash list(optional).
299 * Heads array size of the hash list.
302 * Pointer of the hash list table created, NULL on failure.
304 struct mlx5_hlist *mlx5_hlist_create(const char *name, uint32_t size);
307 * Search an entry matching the key.
310 * Pointer to the hast list table.
312 * Key for the searching entry.
315 * Pointer of the hlist entry if found, NULL otherwise.
317 struct mlx5_hlist_entry *mlx5_hlist_lookup(struct mlx5_hlist *h, uint64_t key);
320 * Insert an entry to the hash list table, the entry is only part of whole data
321 * element and a 64B key is used for matching. User should construct the key or
322 * give a calculated hash signature and guarantee there is no collision.
325 * Pointer to the hast list table.
327 * Entry to be inserted into the hash list table.
330 * - zero for success.
331 * - -EEXIST if the entry is already inserted.
333 int mlx5_hlist_insert(struct mlx5_hlist *h, struct mlx5_hlist_entry *entry);
336 * Extended routine to search an entry matching the context with
337 * user defined match function.
340 * Pointer to the hast list table.
342 * Key for the searching entry.
344 * Callback function to match the node with context.
346 * Common context parameter used by callback function.
349 * Pointer of the hlist entry if found, NULL otherwise.
351 struct mlx5_hlist_entry *mlx5_hlist_lookup_ex(struct mlx5_hlist *h,
353 mlx5_hlist_match_callback_fn cb,
357 * Extended routine to insert an entry to the list with key collisions.
359 * For the list have key collision, the extra user defined match function
360 * allows node with same key will be inserted.
363 * Pointer to the hast list table.
365 * Entry to be inserted into the hash list table.
367 * Callback function to match the node with context.
369 * Common context parameter used by callback function.
372 * - zero for success.
373 * - -EEXIST if the entry is already inserted.
375 int mlx5_hlist_insert_ex(struct mlx5_hlist *h, struct mlx5_hlist_entry *entry,
376 mlx5_hlist_match_callback_fn cb, void *ctx);
379 * Remove an entry from the hash list table. User should guarantee the validity
383 * Pointer to the hast list table. (not used)
385 * Entry to be removed from the hash list table.
387 void mlx5_hlist_remove(struct mlx5_hlist *h __rte_unused,
388 struct mlx5_hlist_entry *entry);
391 * Destroy the hash list table, all the entries already inserted into the lists
392 * will be handled by the callback function provided by the user (including
393 * free if needed) before the table is freed.
396 * Pointer to the hast list table.
398 * Callback function for each inserted entry when destroying the hash list.
400 * Common context parameter used by callback function for each entry.
402 void mlx5_hlist_destroy(struct mlx5_hlist *h,
403 mlx5_hlist_destroy_callback_fn cb, void *ctx);
406 * This function allocates non-initialized memory entry from pool.
407 * In NUMA systems, the memory entry allocated resides on the same
408 * NUMA socket as the core that calls this function.
410 * Memory entry is allocated from memory trunk, no alignment.
413 * Pointer to indexed memory entry pool.
414 * No initialization required.
416 * Pointer to memory to save allocated index.
417 * Memory index always positive value.
419 * - Pointer to the allocated memory entry.
420 * - NULL on error. Not enough memory, or invalid arguments.
422 void *mlx5_ipool_malloc(struct mlx5_indexed_pool *pool, uint32_t *idx);
425 * This function allocates zero initialized memory entry from pool.
426 * In NUMA systems, the memory entry allocated resides on the same
427 * NUMA socket as the core that calls this function.
429 * Memory entry is allocated from memory trunk, no alignment.
432 * Pointer to indexed memory pool.
433 * No initialization required.
435 * Pointer to memory to save allocated index.
436 * Memory index always positive value.
438 * - Pointer to the allocated memory entry .
439 * - NULL on error. Not enough memory, or invalid arguments.
441 void *mlx5_ipool_zmalloc(struct mlx5_indexed_pool *pool, uint32_t *idx);
444 * This function frees indexed memory entry to pool.
445 * Caller has to make sure that the index is allocated from same pool.
448 * Pointer to indexed memory pool.
450 * Allocated memory entry index.
452 void mlx5_ipool_free(struct mlx5_indexed_pool *pool, uint32_t idx);
455 * This function returns pointer of indexed memory entry from index.
456 * Caller has to make sure that the index is valid, and allocated
460 * Pointer to indexed memory pool.
462 * Allocated memory index.
464 * - Pointer to indexed memory entry.
466 void *mlx5_ipool_get(struct mlx5_indexed_pool *pool, uint32_t idx);
469 * This function creates indexed memory pool.
470 * Caller has to configure the configuration accordingly.
473 * Pointer to indexed memory pool.
475 * Allocated memory index.
477 struct mlx5_indexed_pool *
478 mlx5_ipool_create(struct mlx5_indexed_pool_config *cfg);
481 * This function releases all resources of pool.
482 * Caller has to make sure that all indexes and memories allocated
483 * from this pool not referenced anymore.
486 * Pointer to indexed memory pool.
488 * - non-zero value on error.
491 int mlx5_ipool_destroy(struct mlx5_indexed_pool *pool);
494 * This function dumps debug info of pool.
497 * Pointer to indexed memory pool.
499 void mlx5_ipool_dump(struct mlx5_indexed_pool *pool);
502 * This function allocates new empty Three-level table.
505 * The l3t can set as word, double word, quad word or pointer with index.
508 * - Pointer to the allocated l3t.
509 * - NULL on error. Not enough memory, or invalid arguments.
511 struct mlx5_l3t_tbl *mlx5_l3t_create(enum mlx5_l3t_type type);
514 * This function destroys Three-level table.
517 * Pointer to the l3t.
519 void mlx5_l3t_destroy(struct mlx5_l3t_tbl *tbl);
522 * This function gets the index entry from Three-level table.
525 * Pointer to the l3t.
527 * Index to the entry.
529 * Pointer to the memory which saves the entry data.
530 * When function call returns 0, data contains the entry data get from
532 * When function call returns -1, data is not modified.
535 * 0 if success, -1 on error.
538 uint32_t mlx5_l3t_get_entry(struct mlx5_l3t_tbl *tbl, uint32_t idx,
539 union mlx5_l3t_data *data);
541 * This function clears the index entry from Three-level table.
544 * Pointer to the l3t.
546 * Index to the entry.
548 void mlx5_l3t_clear_entry(struct mlx5_l3t_tbl *tbl, uint32_t idx);
551 * This function gets the index entry from Three-level table.
554 * Pointer to the l3t.
556 * Index to the entry.
558 * Pointer to the memory which contains the entry data save to l3t.
561 * 0 if success, -1 on error.
563 uint32_t mlx5_l3t_set_entry(struct mlx5_l3t_tbl *tbl, uint32_t idx,
564 union mlx5_l3t_data *data);
567 * Macros for linked list based on indexed memory.
568 * Example data structure:
570 * ILIST_ENTRY(uint16_t) next;
575 #define ILIST_ENTRY(type) \
577 type prev; /* Index of previous element. */ \
578 type next; /* Index of next element. */ \
581 #define ILIST_INSERT(pool, head, idx, elem, field) \
584 MLX5_ASSERT((elem) && (idx)); \
585 (elem)->field.next = *(head); \
586 (elem)->field.prev = 0; \
588 (peer) = mlx5_ipool_get(pool, *(head)); \
590 (peer)->field.prev = (idx); \
595 #define ILIST_REMOVE(pool, head, idx, elem, field) \
600 if ((elem)->field.prev) { \
601 (peer) = mlx5_ipool_get \
602 (pool, (elem)->field.prev); \
604 (peer)->field.next = (elem)->field.next;\
606 if ((elem)->field.next) { \
607 (peer) = mlx5_ipool_get \
608 (pool, (elem)->field.next); \
610 (peer)->field.prev = (elem)->field.prev;\
612 if (*(head) == (idx)) \
613 *(head) = (elem)->field.next; \
616 #define ILIST_FOREACH(pool, head, idx, elem, field) \
617 for ((idx) = (head), (elem) = \
618 (idx) ? mlx5_ipool_get(pool, (idx)) : NULL; (elem); \
619 idx = (elem)->field.next, (elem) = \
620 (idx) ? mlx5_ipool_get(pool, idx) : NULL)
622 /* Single index list. */
623 #define SILIST_ENTRY(type) \
625 type next; /* Index of next element. */ \
628 #define SILIST_INSERT(head, idx, elem, field) \
630 MLX5_ASSERT((elem) && (idx)); \
631 (elem)->field.next = *(head); \
635 #define SILIST_FOREACH(pool, head, idx, elem, field) \
636 for ((idx) = (head), (elem) = \
637 (idx) ? mlx5_ipool_get(pool, (idx)) : NULL; (elem); \
638 idx = (elem)->field.next, (elem) = \
639 (idx) ? mlx5_ipool_get(pool, idx) : NULL)
641 #endif /* RTE_PMD_MLX5_UTILS_H_ */