drivers/net/mlx5/mlx5_utils.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2015 6WIND S.A.
   3  * Copyright 2015 Mellanox Technologies, Ltd
   4  */
   5
   6 #ifndef RTE_PMD_MLX5_UTILS_H_
   7 #define RTE_PMD_MLX5_UTILS_H_
   8
   9 #include <stddef.h>
  10 #include <stdint.h>
  11 #include <stdio.h>
  12 #include <limits.h>
  13 #include <errno.h>
  14
  15 #include <rte_spinlock.h>
  16 #include <rte_rwlock.h>
  17 #include <rte_memory.h>
  18 #include <rte_bitmap.h>
  19
  20 #include <mlx5_common.h>
  21 #include <mlx5_common_utils.h>
  22
  23 #include "mlx5_defs.h"
  24
  25 /* Convert a bit number to the corresponding 64-bit mask */
  26 #define MLX5_BITSHIFT(v) (UINT64_C(1) << (v))
  27
  28 /* Save and restore errno around argument evaluation. */
  29 #define ERRNO_SAFE(x) ((errno = (int []){ errno, ((x), 0) }[0]))
  30
  31 extern int mlx5_logtype;
  32
  33 #define MLX5_NET_LOG_PREFIX "mlx5_net"
  34
  35 /* Generic printf()-like logging macro with automatic line feed. */
  36 #define DRV_LOG(level, ...) \
  37         PMD_DRV_LOG_(level, mlx5_logtype, MLX5_NET_LOG_PREFIX, \
  38                 __VA_ARGS__ PMD_DRV_LOG_STRIP PMD_DRV_LOG_OPAREN, \
  39                 PMD_DRV_LOG_CPAREN)
  40
  41 /* Convenience macros for accessing mbuf fields. */
  42 #define NEXT(m) ((m)->next)
  43 #define DATA_LEN(m) ((m)->data_len)
  44 #define PKT_LEN(m) ((m)->pkt_len)
  45 #define DATA_OFF(m) ((m)->data_off)
  46 #define SET_DATA_OFF(m, o) ((m)->data_off = (o))
  47 #define NB_SEGS(m) ((m)->nb_segs)
  48 #define PORT(m) ((m)->port)
  49
  50 /* Transpose flags. Useful to convert IBV to DPDK flags. */
  51 #define TRANSPOSE(val, from, to) \
  52         (((from) >= (to)) ? \
  53          (((val) & (from)) / ((from) / (to))) : \
  54          (((val) & (from)) * ((to) / (from))))
  55
  56 /*
  57  * For the case which data is linked with sequence increased index, the
  58  * array table will be more efficiect than hash table once need to serarch
  59  * one data entry in large numbers of entries. Since the traditional hash
  60  * tables has fixed table size, when huge numbers of data saved to the hash
  61  * table, it also comes lots of hash conflict.
  62  *
  63  * But simple array table also has fixed size, allocates all the needed
  64  * memory at once will waste lots of memory. For the case don't know the
  65  * exactly number of entries will be impossible to allocate the array.
  66  *
  67  * Then the multiple level table helps to balance the two disadvantages.
  68  * Allocate a global high level table with sub table entries at first,
  69  * the global table contains the sub table entries, and the sub table will
  70  * be allocated only once the corresponding index entry need to be saved.
  71  * e.g. for up to 32-bits index, three level table with 10-10-12 splitting,
  72  * with sequence increased index, the memory grows with every 4K entries.
  73  *
  74  * The currently implementation introduces 10-10-12 32-bits splitting
  75  * Three-Level table to help the cases which have millions of enties to
  76  * save. The index entries can be addressed directly by the index, no
  77  * search will be needed.q
  78  */
  79
  80 /* L3 table global table define. */
  81 #define MLX5_L3T_GT_OFFSET 22
  82 #define MLX5_L3T_GT_SIZE (1 << 10)
  83 #define MLX5_L3T_GT_MASK (MLX5_L3T_GT_SIZE - 1)
  84
  85 /* L3 table middle table define. */
  86 #define MLX5_L3T_MT_OFFSET 12
  87 #define MLX5_L3T_MT_SIZE (1 << 10)
  88 #define MLX5_L3T_MT_MASK (MLX5_L3T_MT_SIZE - 1)
  89
  90 /* L3 table entry table define. */
  91 #define MLX5_L3T_ET_OFFSET 0
  92 #define MLX5_L3T_ET_SIZE (1 << 12)
  93 #define MLX5_L3T_ET_MASK (MLX5_L3T_ET_SIZE - 1)
  94
  95 /* L3 table type. */
  96 enum mlx5_l3t_type {
  97         MLX5_L3T_TYPE_WORD = 0,
  98         MLX5_L3T_TYPE_DWORD,
  99         MLX5_L3T_TYPE_QWORD,
 100         MLX5_L3T_TYPE_PTR,
 101         MLX5_L3T_TYPE_MAX,
 102 };
 103
 104 struct mlx5_indexed_pool;
 105
 106 /* Generic data struct. */
 107 union mlx5_l3t_data {
 108         uint16_t word;
 109         uint32_t dword;
 110         uint64_t qword;
 111         void *ptr;
 112 };
 113
 114 /* L3 level table data structure. */
 115 struct mlx5_l3t_level_tbl {
 116         uint64_t ref_cnt; /* Table ref_cnt. */
 117         void *tbl[]; /* Table array. */
 118 };
 119
 120 /* L3 word entry table data structure. */
 121 struct mlx5_l3t_entry_word {
 122         uint32_t idx; /* Table index. */
 123         uint64_t ref_cnt; /* Table ref_cnt. */
 124         struct {
 125                 uint16_t data;
 126                 uint32_t ref_cnt;
 127         } entry[MLX5_L3T_ET_SIZE]; /* Entry array */
 128 } __rte_packed;
 129
 130 /* L3 double word entry table data structure. */
 131 struct mlx5_l3t_entry_dword {
 132         uint32_t idx; /* Table index. */
 133         uint64_t ref_cnt; /* Table ref_cnt. */
 134         struct {
 135                 uint32_t data;
 136                 int32_t ref_cnt;
 137         } entry[MLX5_L3T_ET_SIZE]; /* Entry array */
 138 } __rte_packed;
 139
 140 /* L3 quad word entry table data structure. */
 141 struct mlx5_l3t_entry_qword {
 142         uint32_t idx; /* Table index. */
 143         uint64_t ref_cnt; /* Table ref_cnt. */
 144         struct {
 145                 uint64_t data;
 146                 uint32_t ref_cnt;
 147         } entry[MLX5_L3T_ET_SIZE]; /* Entry array */
 148 } __rte_packed;
 149
 150 /* L3 pointer entry table data structure. */
 151 struct mlx5_l3t_entry_ptr {
 152         uint32_t idx; /* Table index. */
 153         uint64_t ref_cnt; /* Table ref_cnt. */
 154         struct {
 155                 void *data;
 156                 uint32_t ref_cnt;
 157         } entry[MLX5_L3T_ET_SIZE]; /* Entry array */
 158 } __rte_packed;
 159
 160 /* L3 table data structure. */
 161 struct mlx5_l3t_tbl {
 162         enum mlx5_l3t_type type; /* Table type. */
 163         struct mlx5_indexed_pool *eip;
 164         /* Table index pool handles. */
 165         struct mlx5_l3t_level_tbl *tbl; /* Global table index. */
 166         rte_spinlock_t sl; /* The table lock. */
 167 };
 168
 169 /** Type of function that is used to handle the data before freeing. */
 170 typedef int32_t (*mlx5_l3t_alloc_callback_fn)(void *ctx,
 171                                            union mlx5_l3t_data *data);
 172
 173 /*
 174  * The indexed memory entry index is made up of trunk index and offset of
 175  * the entry in the trunk. Since the entry index is 32 bits, in case user
 176  * prefers to have small trunks, user can change the macro below to a big
 177  * number which helps the pool contains more trunks with lots of entries
 178  * allocated.
 179  */
 180 #define TRUNK_IDX_BITS 16
 181 #define TRUNK_MAX_IDX ((1 << TRUNK_IDX_BITS) - 1)
 182 #define TRUNK_INVALID TRUNK_MAX_IDX
 183 #define MLX5_IPOOL_DEFAULT_TRUNK_SIZE (1 << (28 - TRUNK_IDX_BITS))
 184 #ifdef RTE_LIBRTE_MLX5_DEBUG
 185 #define POOL_DEBUG 1
 186 #endif
 187
 188 struct mlx5_indexed_pool_config {
 189         uint32_t size; /* Pool entry size. */
 190         uint32_t trunk_size:22;
 191         /*
 192          * Trunk entry number. Must be power of 2. It can be increased
 193          * if trunk_grow enable. The trunk entry number increases with
 194          * left shift grow_shift. Trunks with index are after grow_trunk
 195          * will keep the entry number same with the last grow trunk.
 196          */
 197         uint32_t grow_trunk:4;
 198         /*
 199          * Trunks with entry number increase in the pool. Set it to 0
 200          * to make the pool works as trunk entry fixed pool. It works
 201          * only if grow_shift is not 0.
 202          */
 203         uint32_t grow_shift:4;
 204         /*
 205          * Trunk entry number increase shift value, stop after grow_trunk.
 206          * It works only if grow_trunk is not 0.
 207          */
 208         uint32_t need_lock:1;
 209         /* Lock is needed for multiple thread usage. */
 210         uint32_t release_mem_en:1; /* Rlease trunk when it is free. */
 211         uint32_t max_idx; /* The maximum index can be allocated. */
 212         uint32_t per_core_cache;
 213         /*
 214          * Cache entry number per core for performance. Should not be
 215          * set with release_mem_en.
 216          */
 217         const char *type; /* Memory allocate type name. */
 218         void *(*malloc)(uint32_t flags, size_t size, unsigned int align,
 219                         int socket);
 220         /* User defined memory allocator. */
 221         void (*free)(void *addr); /* User defined memory release. */
 222 };
 223
 224 struct mlx5_indexed_trunk {
 225         uint32_t idx; /* Trunk id. */
 226         uint32_t prev; /* Previous free trunk in free list. */
 227         uint32_t next; /* Next free trunk in free list. */
 228         uint32_t free; /* Free entries available */
 229         struct rte_bitmap *bmp;
 230         uint8_t data[] __rte_cache_aligned; /* Entry data start. */
 231 };
 232
 233 struct mlx5_indexed_cache {
 234         struct mlx5_indexed_trunk **trunks;
 235         volatile uint32_t n_trunk_valid; /* Trunks allocated. */
 236         uint32_t n_trunk; /* Trunk pointer array size. */
 237         uint32_t ref_cnt;
 238         uint32_t len;
 239         uint32_t idx[];
 240 };
 241
 242 struct mlx5_ipool_per_lcore {
 243         struct mlx5_indexed_cache *lc;
 244         uint32_t len; /**< Current cache count. */
 245         uint32_t idx[]; /**< Cache objects. */
 246 };
 247
 248 struct mlx5_indexed_pool {
 249         struct mlx5_indexed_pool_config cfg; /* Indexed pool configuration. */
 250         rte_spinlock_t rsz_lock; /* Pool lock for multiple thread usage. */
 251         /* Dim of trunk pointer array. */
 252         union {
 253                 struct {
 254                         uint32_t n_trunk_valid; /* Trunks allocated. */
 255                         uint32_t n_trunk; /* Trunk pointer array size. */
 256                         struct mlx5_indexed_trunk **trunks;
 257                         uint32_t free_list; /* Index to first free trunk. */
 258                 };
 259                 struct {
 260                         struct mlx5_indexed_cache *gc;
 261                         /* Global cache. */
 262                         struct mlx5_ipool_per_lcore *cache[RTE_MAX_LCORE];
 263                         /* Local cache. */
 264                 };
 265         };
 266 #ifdef POOL_DEBUG
 267         uint32_t n_entry;
 268         uint32_t trunk_new;
 269         uint32_t trunk_avail;
 270         uint32_t trunk_empty;
 271         uint32_t trunk_free;
 272 #endif
 273         uint32_t grow_tbl[]; /* Save the index offset for the grow trunks. */
 274 };
 275
 276 /**
 277  * Return logarithm of the nearest power of two above input value.
 278  *
 279  * @param v
 280  *   Input value.
 281  *
 282  * @return
 283  *   Logarithm of the nearest power of two above input value.
 284  */
 285 static inline unsigned int
 286 log2above(unsigned int v)
 287 {
 288         unsigned int l;
 289         unsigned int r;
 290
 291         for (l = 0, r = 0; (v >> 1); ++l, v >>= 1)
 292                 r |= (v & 1);
 293         return l + r;
 294 }
 295
 296 /************************ cache list *****************************/
 297
 298 /** Maximum size of string for naming. */
 299 #define MLX5_NAME_SIZE                  32
 300
 301 struct mlx5_cache_list;
 302
 303 /**
 304  * Structure of the entry in the cache list, user should define its own struct
 305  * that contains this in order to store the data.
 306  */
 307 struct mlx5_cache_entry {
 308         LIST_ENTRY(mlx5_cache_entry) next; /* Entry pointers in the list. */
 309         uint32_t ref_cnt; /* Reference count. */
 310 };
 311
 312 /**
 313  * Type of callback function for entry removal.
 314  *
 315  * @param list
 316  *   The cache list.
 317  * @param entry
 318  *   The entry in the list.
 319  */
 320 typedef void (*mlx5_cache_remove_cb)(struct mlx5_cache_list *list,
 321                                      struct mlx5_cache_entry *entry);
 322
 323 /**
 324  * Type of function for user defined matching.
 325  *
 326  * @param list
 327  *   The cache list.
 328  * @param entry
 329  *   The entry in the list.
 330  * @param ctx
 331  *   The pointer to new entry context.
 332  *
 333  * @return
 334  *   0 if matching, non-zero number otherwise.
 335  */
 336 typedef int (*mlx5_cache_match_cb)(struct mlx5_cache_list *list,
 337                                    struct mlx5_cache_entry *entry, void *ctx);
 338
 339 /**
 340  * Type of function for user defined cache list entry creation.
 341  *
 342  * @param list
 343  *   The cache list.
 344  * @param entry
 345  *   The new allocated entry, NULL if list entry size unspecified,
 346  *   New entry has to be allocated in callback and return.
 347  * @param ctx
 348  *   The pointer to new entry context.
 349  *
 350  * @return
 351  *   Pointer of entry on success, NULL otherwise.
 352  */
 353 typedef struct mlx5_cache_entry *(*mlx5_cache_create_cb)
 354                                  (struct mlx5_cache_list *list,
 355                                   struct mlx5_cache_entry *entry,
 356                                   void *ctx);
 357
 358 /**
 359  * Linked cache list structure.
 360  *
 361  * Entry in cache list could be reused if entry already exists,
 362  * reference count will increase and the existing entry returns.
 363  *
 364  * When destroy an entry from list, decrease reference count and only
 365  * destroy when no further reference.
 366  *
 367  * Linked list cache is designed for limited number of entries cache,
 368  * read mostly, less modification.
 369  *
 370  * For huge amount of entries cache, please consider hash list cache.
 371  *
 372  */
 373 struct mlx5_cache_list {
 374         char name[MLX5_NAME_SIZE]; /**< Name of the cache list. */
 375         uint32_t entry_sz; /**< Entry size, 0: use create callback. */
 376         rte_rwlock_t lock; /* read/write lock. */
 377         uint32_t gen_cnt; /* List modification will update generation count. */
 378         uint32_t count; /* number of entries in list. */
 379         void *ctx; /* user objects target to callback. */
 380         mlx5_cache_create_cb cb_create; /**< entry create callback. */
 381         mlx5_cache_match_cb cb_match; /**< entry match callback. */
 382         mlx5_cache_remove_cb cb_remove; /**< entry remove callback. */
 383         LIST_HEAD(mlx5_cache_head, mlx5_cache_entry) head;
 384 };
 385
 386 /**
 387  * Initialize a cache list.
 388  *
 389  * @param list
 390  *   Pointer to the hast list table.
 391  * @param name
 392  *   Name of the cache list.
 393  * @param entry_size
 394  *   Entry size to allocate, 0 to allocate by creation callback.
 395  * @param ctx
 396  *   Pointer to the list context data.
 397  * @param cb_create
 398  *   Callback function for entry create.
 399  * @param cb_match
 400  *   Callback function for entry match.
 401  * @param cb_remove
 402  *   Callback function for entry remove.
 403  * @return
 404  *   0 on success, otherwise failure.
 405  */
 406 int mlx5_cache_list_init(struct mlx5_cache_list *list,
 407                          const char *name, uint32_t entry_size, void *ctx,
 408                          mlx5_cache_create_cb cb_create,
 409                          mlx5_cache_match_cb cb_match,
 410                          mlx5_cache_remove_cb cb_remove);
 411
 412 /**
 413  * Search an entry matching the key.
 414  *
 415  * Result returned might be destroyed by other thread, must use
 416  * this function only in main thread.
 417  *
 418  * @param list
 419  *   Pointer to the cache list.
 420  * @param ctx
 421  *   Common context parameter used by entry callback function.
 422  *
 423  * @return
 424  *   Pointer of the cache entry if found, NULL otherwise.
 425  */
 426 struct mlx5_cache_entry *mlx5_cache_lookup(struct mlx5_cache_list *list,
 427                                            void *ctx);
 428
 429 /**
 430  * Reuse or create an entry to the cache list.
 431  *
 432  * @param list
 433  *   Pointer to the hast list table.
 434  * @param ctx
 435  *   Common context parameter used by callback function.
 436  *
 437  * @return
 438  *   registered entry on success, NULL otherwise
 439  */
 440 struct mlx5_cache_entry *mlx5_cache_register(struct mlx5_cache_list *list,
 441                                              void *ctx);
 442
 443 /**
 444  * Remove an entry from the cache list.
 445  *
 446  * User should guarantee the validity of the entry.
 447  *
 448  * @param list
 449  *   Pointer to the hast list.
 450  * @param entry
 451  *   Entry to be removed from the cache list table.
 452  * @return
 453  *   0 on entry removed, 1 on entry still referenced.
 454  */
 455 int mlx5_cache_unregister(struct mlx5_cache_list *list,
 456                           struct mlx5_cache_entry *entry);
 457
 458 /**
 459  * Destroy the cache list.
 460  *
 461  * @param list
 462  *   Pointer to the cache list.
 463  */
 464 void mlx5_cache_list_destroy(struct mlx5_cache_list *list);
 465
 466 /**
 467  * Get entry number from the cache list.
 468  *
 469  * @param list
 470  *   Pointer to the hast list.
 471  * @return
 472  *   Cache list entry number.
 473  */
 474 uint32_t
 475 mlx5_cache_list_get_entry_num(struct mlx5_cache_list *list);
 476
 477 /********************************* indexed pool *************************/
 478
 479 /**
 480  * This function allocates non-initialized memory entry from pool.
 481  * In NUMA systems, the memory entry allocated resides on the same
 482  * NUMA socket as the core that calls this function.
 483  *
 484  * Memory entry is allocated from memory trunk, no alignment.
 485  *
 486  * @param pool
 487  *   Pointer to indexed memory entry pool.
 488  *   No initialization required.
 489  * @param[out] idx
 490  *   Pointer to memory to save allocated index.
 491  *   Memory index always positive value.
 492  * @return
 493  *   - Pointer to the allocated memory entry.
 494  *   - NULL on error. Not enough memory, or invalid arguments.
 495  */
 496 void *mlx5_ipool_malloc(struct mlx5_indexed_pool *pool, uint32_t *idx);
 497
 498 /**
 499  * This function allocates zero initialized memory entry from pool.
 500  * In NUMA systems, the memory entry allocated resides on the same
 501  * NUMA socket as the core that calls this function.
 502  *
 503  * Memory entry is allocated from memory trunk, no alignment.
 504  *
 505  * @param pool
 506  *   Pointer to indexed memory pool.
 507  *   No initialization required.
 508  * @param[out] idx
 509  *   Pointer to memory to save allocated index.
 510  *   Memory index always positive value.
 511  * @return
 512  *   - Pointer to the allocated memory entry .
 513  *   - NULL on error. Not enough memory, or invalid arguments.
 514  */
 515 void *mlx5_ipool_zmalloc(struct mlx5_indexed_pool *pool, uint32_t *idx);
 516
 517 /**
 518  * This function frees indexed memory entry to pool.
 519  * Caller has to make sure that the index is allocated from same pool.
 520  *
 521  * @param pool
 522  *   Pointer to indexed memory pool.
 523  * @param idx
 524  *   Allocated memory entry index.
 525  */
 526 void mlx5_ipool_free(struct mlx5_indexed_pool *pool, uint32_t idx);
 527
 528 /**
 529  * This function returns pointer of indexed memory entry from index.
 530  * Caller has to make sure that the index is valid, and allocated
 531  * from same pool.
 532  *
 533  * @param pool
 534  *   Pointer to indexed memory pool.
 535  * @param idx
 536  *   Allocated memory index.
 537  * @return
 538  *   - Pointer to indexed memory entry.
 539  */
 540 void *mlx5_ipool_get(struct mlx5_indexed_pool *pool, uint32_t idx);
 541
 542 /**
 543  * This function creates indexed memory pool.
 544  * Caller has to configure the configuration accordingly.
 545  *
 546  * @param pool
 547  *   Pointer to indexed memory pool.
 548  * @param cfg
 549  *   Allocated memory index.
 550  */
 551 struct mlx5_indexed_pool *
 552 mlx5_ipool_create(struct mlx5_indexed_pool_config *cfg);
 553
 554 /**
 555  * This function releases all resources of pool.
 556  * Caller has to make sure that all indexes and memories allocated
 557  * from this pool not referenced anymore.
 558  *
 559  * @param pool
 560  *   Pointer to indexed memory pool.
 561  * @return
 562  *   - non-zero value on error.
 563  *   - 0 on success.
 564  */
 565 int mlx5_ipool_destroy(struct mlx5_indexed_pool *pool);
 566
 567 /**
 568  * This function dumps debug info of pool.
 569  *
 570  * @param pool
 571  *   Pointer to indexed memory pool.
 572  */
 573 void mlx5_ipool_dump(struct mlx5_indexed_pool *pool);
 574
 575 /**
 576  * This function flushes all the cache index back to pool trunk.
 577  *
 578  * @param pool
 579  *   Pointer to the index memory pool handler.
 580  *
 581  */
 582
 583 void mlx5_ipool_flush_cache(struct mlx5_indexed_pool *pool);
 584
 585 /**
 586  * This function gets the available entry from pos.
 587  *
 588  * @param pool
 589  *   Pointer to the index memory pool handler.
 590  * @param pos
 591  *   Pointer to the index position start from.
 592  *
 593  * @return
 594  *  - Pointer to the next available entry.
 595  *
 596  */
 597 void *mlx5_ipool_get_next(struct mlx5_indexed_pool *pool, uint32_t *pos);
 598
 599 /**
 600  * This function allocates new empty Three-level table.
 601  *
 602  * @param type
 603  *   The l3t can set as word, double word, quad word or pointer with index.
 604  *
 605  * @return
 606  *   - Pointer to the allocated l3t.
 607  *   - NULL on error. Not enough memory, or invalid arguments.
 608  */
 609 struct mlx5_l3t_tbl *mlx5_l3t_create(enum mlx5_l3t_type type);
 610
 611 /**
 612  * This function destroys Three-level table.
 613  *
 614  * @param tbl
 615  *   Pointer to the l3t.
 616  */
 617 void mlx5_l3t_destroy(struct mlx5_l3t_tbl *tbl);
 618
 619 /**
 620  * This function gets the index entry from Three-level table.
 621  *
 622  * @param tbl
 623  *   Pointer to the l3t.
 624  * @param idx
 625  *   Index to the entry.
 626  * @param data
 627  *   Pointer to the memory which saves the entry data.
 628  *   When function call returns 0, data contains the entry data get from
 629  *   l3t.
 630  *   When function call returns -1, data is not modified.
 631  *
 632  * @return
 633  *   0 if success, -1 on error.
 634  */
 635
 636 int32_t mlx5_l3t_get_entry(struct mlx5_l3t_tbl *tbl, uint32_t idx,
 637                             union mlx5_l3t_data *data);
 638
 639 /**
 640  * This function gets the index entry from Three-level table.
 641  *
 642  * If the index entry is not available, allocate new one by callback
 643  * function and fill in the entry.
 644  *
 645  * @param tbl
 646  *   Pointer to the l3t.
 647  * @param idx
 648  *   Index to the entry.
 649  * @param data
 650  *   Pointer to the memory which saves the entry data.
 651  *   When function call returns 0, data contains the entry data get from
 652  *   l3t.
 653  *   When function call returns -1, data is not modified.
 654  * @param cb
 655  *   Callback function to allocate new data.
 656  * @param ctx
 657  *   Context for callback function.
 658  *
 659  * @return
 660  *   0 if success, -1 on error.
 661  */
 662
 663 int32_t mlx5_l3t_prepare_entry(struct mlx5_l3t_tbl *tbl, uint32_t idx,
 664                                union mlx5_l3t_data *data,
 665                                mlx5_l3t_alloc_callback_fn cb, void *ctx);
 666
 667 /**
 668  * This function decreases and clear index entry if reference
 669  * counter is 0 from Three-level table.
 670  *
 671  * @param tbl
 672  *   Pointer to the l3t.
 673  * @param idx
 674  *   Index to the entry.
 675  *
 676  * @return
 677  *   The remaining reference count, 0 means entry be cleared, -1 on error.
 678  */
 679 int32_t mlx5_l3t_clear_entry(struct mlx5_l3t_tbl *tbl, uint32_t idx);
 680
 681 /**
 682  * This function sets the index entry to Three-level table.
 683  * If the entry is already set, the EEXIST errno will be given, and
 684  * the set data will be filled to the data.
 685  *
 686  * @param tbl[in]
 687  *   Pointer to the l3t.
 688  * @param idx[in]
 689  *   Index to the entry.
 690  * @param data[in/out]
 691  *   Pointer to the memory which contains the entry data save to l3t.
 692  *   If the entry is already set, the set data will be filled.
 693  *
 694  * @return
 695  *   0 if success, -1 on error.
 696  */
 697 int32_t mlx5_l3t_set_entry(struct mlx5_l3t_tbl *tbl, uint32_t idx,
 698                             union mlx5_l3t_data *data);
 699
 700 static inline void *
 701 mlx5_l3t_get_next(struct mlx5_l3t_tbl *tbl, uint32_t *pos)
 702 {
 703         struct mlx5_l3t_level_tbl *g_tbl, *m_tbl;
 704         uint32_t i, j, k, g_start, m_start, e_start;
 705         uint32_t idx = *pos;
 706         void *e_tbl;
 707         struct mlx5_l3t_entry_word *w_e_tbl;
 708         struct mlx5_l3t_entry_dword *dw_e_tbl;
 709         struct mlx5_l3t_entry_qword *qw_e_tbl;
 710         struct mlx5_l3t_entry_ptr *ptr_e_tbl;
 711
 712         if (!tbl)
 713                 return NULL;
 714         g_tbl = tbl->tbl;
 715         if (!g_tbl)
 716                 return NULL;
 717         g_start = (idx >> MLX5_L3T_GT_OFFSET) & MLX5_L3T_GT_MASK;
 718         m_start = (idx >> MLX5_L3T_MT_OFFSET) & MLX5_L3T_MT_MASK;
 719         e_start = idx & MLX5_L3T_ET_MASK;
 720         for (i = g_start; i < MLX5_L3T_GT_SIZE; i++) {
 721                 m_tbl = g_tbl->tbl[i];
 722                 if (!m_tbl) {
 723                         /* Jump to new table, reset the sub table start. */
 724                         m_start = 0;
 725                         e_start = 0;
 726                         continue;
 727                 }
 728                 for (j = m_start; j < MLX5_L3T_MT_SIZE; j++) {
 729                         if (!m_tbl->tbl[j]) {
 730                                 /*
 731                                  * Jump to new table, reset the sub table
 732                                  * start.
 733                                  */
 734                                 e_start = 0;
 735                                 continue;
 736                         }
 737                         e_tbl = m_tbl->tbl[j];
 738                         switch (tbl->type) {
 739                         case MLX5_L3T_TYPE_WORD:
 740                                 w_e_tbl = (struct mlx5_l3t_entry_word *)e_tbl;
 741                                 for (k = e_start; k < MLX5_L3T_ET_SIZE; k++) {
 742                                         if (!w_e_tbl->entry[k].data)
 743                                                 continue;
 744                                         *pos = (i << MLX5_L3T_GT_OFFSET) |
 745                                                (j << MLX5_L3T_MT_OFFSET) | k;
 746                                         return (void *)&w_e_tbl->entry[k].data;
 747                                 }
 748                                 break;
 749                         case MLX5_L3T_TYPE_DWORD:
 750                                 dw_e_tbl = (struct mlx5_l3t_entry_dword *)e_tbl;
 751                                 for (k = e_start; k < MLX5_L3T_ET_SIZE; k++) {
 752                                         if (!dw_e_tbl->entry[k].data)
 753                                                 continue;
 754                                         *pos = (i << MLX5_L3T_GT_OFFSET) |
 755                                                (j << MLX5_L3T_MT_OFFSET) | k;
 756                                         return (void *)&dw_e_tbl->entry[k].data;
 757                                 }
 758                                 break;
 759                         case MLX5_L3T_TYPE_QWORD:
 760                                 qw_e_tbl = (struct mlx5_l3t_entry_qword *)e_tbl;
 761                                 for (k = e_start; k < MLX5_L3T_ET_SIZE; k++) {
 762                                         if (!qw_e_tbl->entry[k].data)
 763                                                 continue;
 764                                         *pos = (i << MLX5_L3T_GT_OFFSET) |
 765                                                (j << MLX5_L3T_MT_OFFSET) | k;
 766                                         return (void *)&qw_e_tbl->entry[k].data;
 767                                 }
 768                                 break;
 769                         default:
 770                                 ptr_e_tbl = (struct mlx5_l3t_entry_ptr *)e_tbl;
 771                                 for (k = e_start; k < MLX5_L3T_ET_SIZE; k++) {
 772                                         if (!ptr_e_tbl->entry[k].data)
 773                                                 continue;
 774                                         *pos = (i << MLX5_L3T_GT_OFFSET) |
 775                                                (j << MLX5_L3T_MT_OFFSET) | k;
 776                                         return ptr_e_tbl->entry[k].data;
 777                                 }
 778                                 break;
 779                         }
 780                 }
 781         }
 782         return NULL;
 783 }
 784
 785 /*
 786  * Macros for linked list based on indexed memory.
 787  * Example data structure:
 788  * struct Foo {
 789  *      ILIST_ENTRY(uint16_t) next;
 790  *      ...
 791  * }
 792  *
 793  */
 794 #define ILIST_ENTRY(type)                                               \
 795 struct {                                                                \
 796         type prev; /* Index of previous element. */                     \
 797         type next; /* Index of next element. */                         \
 798 }
 799
 800 #define ILIST_INSERT(pool, head, idx, elem, field)                      \
 801         do {                                                            \
 802                 typeof(elem) peer;                                      \
 803                 MLX5_ASSERT((elem) && (idx));                           \
 804                 (elem)->field.next = *(head);                           \
 805                 (elem)->field.prev = 0;                                 \
 806                 if (*(head)) {                                          \
 807                         (peer) = mlx5_ipool_get(pool, *(head));         \
 808                         if (peer)                                       \
 809                                 (peer)->field.prev = (idx);             \
 810                 }                                                       \
 811                 *(head) = (idx);                                        \
 812         } while (0)
 813
 814 #define ILIST_REMOVE(pool, head, idx, elem, field)                      \
 815         do {                                                            \
 816                 typeof(elem) peer;                                      \
 817                 MLX5_ASSERT(elem);                                      \
 818                 MLX5_ASSERT(head);                                      \
 819                 if ((elem)->field.prev) {                               \
 820                         (peer) = mlx5_ipool_get                         \
 821                                  (pool, (elem)->field.prev);            \
 822                         if (peer)                                       \
 823                                 (peer)->field.next = (elem)->field.next;\
 824                 }                                                       \
 825                 if ((elem)->field.next) {                               \
 826                         (peer) = mlx5_ipool_get                         \
 827                                  (pool, (elem)->field.next);            \
 828                         if (peer)                                       \
 829                                 (peer)->field.prev = (elem)->field.prev;\
 830                 }                                                       \
 831                 if (*(head) == (idx))                                   \
 832                         *(head) = (elem)->field.next;                   \
 833         } while (0)
 834
 835 #define ILIST_FOREACH(pool, head, idx, elem, field)                     \
 836         for ((idx) = (head), (elem) =                                   \
 837              (idx) ? mlx5_ipool_get(pool, (idx)) : NULL; (elem);        \
 838              idx = (elem)->field.next, (elem) =                         \
 839              (idx) ? mlx5_ipool_get(pool, idx) : NULL)
 840
 841 /* Single index list. */
 842 #define SILIST_ENTRY(type)                                              \
 843 struct {                                                                \
 844         type next; /* Index of next element. */                         \
 845 }
 846
 847 #define SILIST_INSERT(head, idx, elem, field)                           \
 848         do {                                                            \
 849                 MLX5_ASSERT((elem) && (idx));                           \
 850                 (elem)->field.next = *(head);                           \
 851                 *(head) = (idx);                                        \
 852         } while (0)
 853
 854 #define SILIST_FOREACH(pool, head, idx, elem, field)                    \
 855         for ((idx) = (head), (elem) =                                   \
 856              (idx) ? mlx5_ipool_get(pool, (idx)) : NULL; (elem);        \
 857              idx = (elem)->field.next, (elem) =                         \
 858              (idx) ? mlx5_ipool_get(pool, idx) : NULL)
 859
 860 #define MLX5_L3T_FOREACH(tbl, idx, entry)                               \
 861         for (idx = 0, (entry) = mlx5_l3t_get_next((tbl), &idx);         \
 862              (entry);                                                   \
 863              idx++, (entry) = mlx5_l3t_get_next((tbl), &idx))
 864
 865 #endif /* RTE_PMD_MLX5_UTILS_H_ */