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         rte_spinlock_t lcore_lock;
 252         /* Dim of trunk pointer array. */
 253         union {
 254                 struct {
 255                         uint32_t n_trunk_valid; /* Trunks allocated. */
 256                         uint32_t n_trunk; /* Trunk pointer array size. */
 257                         struct mlx5_indexed_trunk **trunks;
 258                         uint32_t free_list; /* Index to first free trunk. */
 259                 };
 260                 struct {
 261                         struct mlx5_indexed_cache *gc;
 262                         /* Global cache. */
 263                         struct mlx5_ipool_per_lcore *cache[RTE_MAX_LCORE + 1];
 264                         /* Local cache. */
 265                         struct rte_bitmap *ibmp;
 266                         void *bmp_mem;
 267                         /* Allocate objects bitmap. Use during flush. */
 268                 };
 269         };
 270 #ifdef POOL_DEBUG
 271         uint32_t n_entry;
 272         uint32_t trunk_new;
 273         uint32_t trunk_avail;
 274         uint32_t trunk_empty;
 275         uint32_t trunk_free;
 276 #endif
 277         uint32_t grow_tbl[]; /* Save the index offset for the grow trunks. */
 278 };
 279
 280 /**
 281  * Return logarithm of the nearest power of two above input value.
 282  *
 283  * @param v
 284  *   Input value.
 285  *
 286  * @return
 287  *   Logarithm of the nearest power of two above input value.
 288  */
 289 static inline unsigned int
 290 log2above(unsigned int v)
 291 {
 292         unsigned int l;
 293         unsigned int r;
 294
 295         for (l = 0, r = 0; (v >> 1); ++l, v >>= 1)
 296                 r |= (v & 1);
 297         return l + r;
 298 }
 299
 300 /************************ cache list *****************************/
 301
 302 /** Maximum size of string for naming. */
 303 #define MLX5_NAME_SIZE                  32
 304
 305 struct mlx5_cache_list;
 306
 307 /**
 308  * Structure of the entry in the cache list, user should define its own struct
 309  * that contains this in order to store the data.
 310  */
 311 struct mlx5_cache_entry {
 312         LIST_ENTRY(mlx5_cache_entry) next; /* Entry pointers in the list. */
 313         uint32_t ref_cnt; /* Reference count. */
 314 };
 315
 316 /**
 317  * Type of callback function for entry removal.
 318  *
 319  * @param list
 320  *   The cache list.
 321  * @param entry
 322  *   The entry in the list.
 323  */
 324 typedef void (*mlx5_cache_remove_cb)(struct mlx5_cache_list *list,
 325                                      struct mlx5_cache_entry *entry);
 326
 327 /**
 328  * Type of function for user defined matching.
 329  *
 330  * @param list
 331  *   The cache list.
 332  * @param entry
 333  *   The entry in the list.
 334  * @param ctx
 335  *   The pointer to new entry context.
 336  *
 337  * @return
 338  *   0 if matching, non-zero number otherwise.
 339  */
 340 typedef int (*mlx5_cache_match_cb)(struct mlx5_cache_list *list,
 341                                    struct mlx5_cache_entry *entry, void *ctx);
 342
 343 /**
 344  * Type of function for user defined cache list entry creation.
 345  *
 346  * @param list
 347  *   The cache list.
 348  * @param entry
 349  *   The new allocated entry, NULL if list entry size unspecified,
 350  *   New entry has to be allocated in callback and return.
 351  * @param ctx
 352  *   The pointer to new entry context.
 353  *
 354  * @return
 355  *   Pointer of entry on success, NULL otherwise.
 356  */
 357 typedef struct mlx5_cache_entry *(*mlx5_cache_create_cb)
 358                                  (struct mlx5_cache_list *list,
 359                                   struct mlx5_cache_entry *entry,
 360                                   void *ctx);
 361
 362 /**
 363  * Linked cache list structure.
 364  *
 365  * Entry in cache list could be reused if entry already exists,
 366  * reference count will increase and the existing entry returns.
 367  *
 368  * When destroy an entry from list, decrease reference count and only
 369  * destroy when no further reference.
 370  *
 371  * Linked list cache is designed for limited number of entries cache,
 372  * read mostly, less modification.
 373  *
 374  * For huge amount of entries cache, please consider hash list cache.
 375  *
 376  */
 377 struct mlx5_cache_list {
 378         char name[MLX5_NAME_SIZE]; /**< Name of the cache list. */
 379         uint32_t entry_sz; /**< Entry size, 0: use create callback. */
 380         rte_rwlock_t lock; /* read/write lock. */
 381         uint32_t gen_cnt; /* List modification will update generation count. */
 382         uint32_t count; /* number of entries in list. */
 383         void *ctx; /* user objects target to callback. */
 384         mlx5_cache_create_cb cb_create; /**< entry create callback. */
 385         mlx5_cache_match_cb cb_match; /**< entry match callback. */
 386         mlx5_cache_remove_cb cb_remove; /**< entry remove callback. */
 387         LIST_HEAD(mlx5_cache_head, mlx5_cache_entry) head;
 388 };
 389
 390 /**
 391  * Initialize a cache list.
 392  *
 393  * @param list
 394  *   Pointer to the hast list table.
 395  * @param name
 396  *   Name of the cache list.
 397  * @param entry_size
 398  *   Entry size to allocate, 0 to allocate by creation callback.
 399  * @param ctx
 400  *   Pointer to the list context data.
 401  * @param cb_create
 402  *   Callback function for entry create.
 403  * @param cb_match
 404  *   Callback function for entry match.
 405  * @param cb_remove
 406  *   Callback function for entry remove.
 407  * @return
 408  *   0 on success, otherwise failure.
 409  */
 410 int mlx5_cache_list_init(struct mlx5_cache_list *list,
 411                          const char *name, uint32_t entry_size, void *ctx,
 412                          mlx5_cache_create_cb cb_create,
 413                          mlx5_cache_match_cb cb_match,
 414                          mlx5_cache_remove_cb cb_remove);
 415
 416 /**
 417  * Search an entry matching the key.
 418  *
 419  * Result returned might be destroyed by other thread, must use
 420  * this function only in main thread.
 421  *
 422  * @param list
 423  *   Pointer to the cache list.
 424  * @param ctx
 425  *   Common context parameter used by entry callback function.
 426  *
 427  * @return
 428  *   Pointer of the cache entry if found, NULL otherwise.
 429  */
 430 struct mlx5_cache_entry *mlx5_cache_lookup(struct mlx5_cache_list *list,
 431                                            void *ctx);
 432
 433 /**
 434  * Reuse or create an entry to the cache list.
 435  *
 436  * @param list
 437  *   Pointer to the hast list table.
 438  * @param ctx
 439  *   Common context parameter used by callback function.
 440  *
 441  * @return
 442  *   registered entry on success, NULL otherwise
 443  */
 444 struct mlx5_cache_entry *mlx5_cache_register(struct mlx5_cache_list *list,
 445                                              void *ctx);
 446
 447 /**
 448  * Remove an entry from the cache list.
 449  *
 450  * User should guarantee the validity of the entry.
 451  *
 452  * @param list
 453  *   Pointer to the hast list.
 454  * @param entry
 455  *   Entry to be removed from the cache list table.
 456  * @return
 457  *   0 on entry removed, 1 on entry still referenced.
 458  */
 459 int mlx5_cache_unregister(struct mlx5_cache_list *list,
 460                           struct mlx5_cache_entry *entry);
 461
 462 /**
 463  * Destroy the cache list.
 464  *
 465  * @param list
 466  *   Pointer to the cache list.
 467  */
 468 void mlx5_cache_list_destroy(struct mlx5_cache_list *list);
 469
 470 /**
 471  * Get entry number from the cache list.
 472  *
 473  * @param list
 474  *   Pointer to the hast list.
 475  * @return
 476  *   Cache list entry number.
 477  */
 478 uint32_t
 479 mlx5_cache_list_get_entry_num(struct mlx5_cache_list *list);
 480
 481 /********************************* indexed pool *************************/
 482
 483 /**
 484  * This function allocates non-initialized memory entry from pool.
 485  * In NUMA systems, the memory entry allocated resides on the same
 486  * NUMA socket as the core that calls this function.
 487  *
 488  * Memory entry is allocated from memory trunk, no alignment.
 489  *
 490  * @param pool
 491  *   Pointer to indexed memory entry pool.
 492  *   No initialization required.
 493  * @param[out] idx
 494  *   Pointer to memory to save allocated index.
 495  *   Memory index always positive value.
 496  * @return
 497  *   - Pointer to the allocated memory entry.
 498  *   - NULL on error. Not enough memory, or invalid arguments.
 499  */
 500 void *mlx5_ipool_malloc(struct mlx5_indexed_pool *pool, uint32_t *idx);
 501
 502 /**
 503  * This function allocates zero initialized memory entry from pool.
 504  * In NUMA systems, the memory entry allocated resides on the same
 505  * NUMA socket as the core that calls this function.
 506  *
 507  * Memory entry is allocated from memory trunk, no alignment.
 508  *
 509  * @param pool
 510  *   Pointer to indexed memory pool.
 511  *   No initialization required.
 512  * @param[out] idx
 513  *   Pointer to memory to save allocated index.
 514  *   Memory index always positive value.
 515  * @return
 516  *   - Pointer to the allocated memory entry .
 517  *   - NULL on error. Not enough memory, or invalid arguments.
 518  */
 519 void *mlx5_ipool_zmalloc(struct mlx5_indexed_pool *pool, uint32_t *idx);
 520
 521 /**
 522  * This function frees indexed memory entry to pool.
 523  * Caller has to make sure that the index is allocated from same pool.
 524  *
 525  * @param pool
 526  *   Pointer to indexed memory pool.
 527  * @param idx
 528  *   Allocated memory entry index.
 529  */
 530 void mlx5_ipool_free(struct mlx5_indexed_pool *pool, uint32_t idx);
 531
 532 /**
 533  * This function returns pointer of indexed memory entry from index.
 534  * Caller has to make sure that the index is valid, and allocated
 535  * from same pool.
 536  *
 537  * @param pool
 538  *   Pointer to indexed memory pool.
 539  * @param idx
 540  *   Allocated memory index.
 541  * @return
 542  *   - Pointer to indexed memory entry.
 543  */
 544 void *mlx5_ipool_get(struct mlx5_indexed_pool *pool, uint32_t idx);
 545
 546 /**
 547  * This function creates indexed memory pool.
 548  * Caller has to configure the configuration accordingly.
 549  *
 550  * @param pool
 551  *   Pointer to indexed memory pool.
 552  * @param cfg
 553  *   Allocated memory index.
 554  */
 555 struct mlx5_indexed_pool *
 556 mlx5_ipool_create(struct mlx5_indexed_pool_config *cfg);
 557
 558 /**
 559  * This function releases all resources of pool.
 560  * Caller has to make sure that all indexes and memories allocated
 561  * from this pool not referenced anymore.
 562  *
 563  * @param pool
 564  *   Pointer to indexed memory pool.
 565  * @return
 566  *   - non-zero value on error.
 567  *   - 0 on success.
 568  */
 569 int mlx5_ipool_destroy(struct mlx5_indexed_pool *pool);
 570
 571 /**
 572  * This function dumps debug info of pool.
 573  *
 574  * @param pool
 575  *   Pointer to indexed memory pool.
 576  */
 577 void mlx5_ipool_dump(struct mlx5_indexed_pool *pool);
 578
 579 /**
 580  * This function flushes all the cache index back to pool trunk.
 581  *
 582  * @param pool
 583  *   Pointer to the index memory pool handler.
 584  *
 585  */
 586
 587 void mlx5_ipool_flush_cache(struct mlx5_indexed_pool *pool);
 588
 589 /**
 590  * This function gets the available entry from pos.
 591  *
 592  * @param pool
 593  *   Pointer to the index memory pool handler.
 594  * @param pos
 595  *   Pointer to the index position start from.
 596  *
 597  * @return
 598  *  - Pointer to the next available entry.
 599  *
 600  */
 601 void *mlx5_ipool_get_next(struct mlx5_indexed_pool *pool, uint32_t *pos);
 602
 603 /**
 604  * This function allocates new empty Three-level table.
 605  *
 606  * @param type
 607  *   The l3t can set as word, double word, quad word or pointer with index.
 608  *
 609  * @return
 610  *   - Pointer to the allocated l3t.
 611  *   - NULL on error. Not enough memory, or invalid arguments.
 612  */
 613 struct mlx5_l3t_tbl *mlx5_l3t_create(enum mlx5_l3t_type type);
 614
 615 /**
 616  * This function destroys Three-level table.
 617  *
 618  * @param tbl
 619  *   Pointer to the l3t.
 620  */
 621 void mlx5_l3t_destroy(struct mlx5_l3t_tbl *tbl);
 622
 623 /**
 624  * This function gets the index entry from Three-level table.
 625  *
 626  * @param tbl
 627  *   Pointer to the l3t.
 628  * @param idx
 629  *   Index to the entry.
 630  * @param data
 631  *   Pointer to the memory which saves the entry data.
 632  *   When function call returns 0, data contains the entry data get from
 633  *   l3t.
 634  *   When function call returns -1, data is not modified.
 635  *
 636  * @return
 637  *   0 if success, -1 on error.
 638  */
 639
 640 int32_t mlx5_l3t_get_entry(struct mlx5_l3t_tbl *tbl, uint32_t idx,
 641                             union mlx5_l3t_data *data);
 642
 643 /**
 644  * This function gets the index entry from Three-level table.
 645  *
 646  * If the index entry is not available, allocate new one by callback
 647  * function and fill in the entry.
 648  *
 649  * @param tbl
 650  *   Pointer to the l3t.
 651  * @param idx
 652  *   Index to the entry.
 653  * @param data
 654  *   Pointer to the memory which saves the entry data.
 655  *   When function call returns 0, data contains the entry data get from
 656  *   l3t.
 657  *   When function call returns -1, data is not modified.
 658  * @param cb
 659  *   Callback function to allocate new data.
 660  * @param ctx
 661  *   Context for callback function.
 662  *
 663  * @return
 664  *   0 if success, -1 on error.
 665  */
 666
 667 int32_t mlx5_l3t_prepare_entry(struct mlx5_l3t_tbl *tbl, uint32_t idx,
 668                                union mlx5_l3t_data *data,
 669                                mlx5_l3t_alloc_callback_fn cb, void *ctx);
 670
 671 /**
 672  * This function decreases and clear index entry if reference
 673  * counter is 0 from Three-level table.
 674  *
 675  * @param tbl
 676  *   Pointer to the l3t.
 677  * @param idx
 678  *   Index to the entry.
 679  *
 680  * @return
 681  *   The remaining reference count, 0 means entry be cleared, -1 on error.
 682  */
 683 int32_t mlx5_l3t_clear_entry(struct mlx5_l3t_tbl *tbl, uint32_t idx);
 684
 685 /**
 686  * This function sets the index entry to Three-level table.
 687  * If the entry is already set, the EEXIST errno will be given, and
 688  * the set data will be filled to the data.
 689  *
 690  * @param tbl[in]
 691  *   Pointer to the l3t.
 692  * @param idx[in]
 693  *   Index to the entry.
 694  * @param data[in/out]
 695  *   Pointer to the memory which contains the entry data save to l3t.
 696  *   If the entry is already set, the set data will be filled.
 697  *
 698  * @return
 699  *   0 if success, -1 on error.
 700  */
 701 int32_t mlx5_l3t_set_entry(struct mlx5_l3t_tbl *tbl, uint32_t idx,
 702                             union mlx5_l3t_data *data);
 703
 704 static inline void *
 705 mlx5_l3t_get_next(struct mlx5_l3t_tbl *tbl, uint32_t *pos)
 706 {
 707         struct mlx5_l3t_level_tbl *g_tbl, *m_tbl;
 708         uint32_t i, j, k, g_start, m_start, e_start;
 709         uint32_t idx = *pos;
 710         void *e_tbl;
 711         struct mlx5_l3t_entry_word *w_e_tbl;
 712         struct mlx5_l3t_entry_dword *dw_e_tbl;
 713         struct mlx5_l3t_entry_qword *qw_e_tbl;
 714         struct mlx5_l3t_entry_ptr *ptr_e_tbl;
 715
 716         if (!tbl)
 717                 return NULL;
 718         g_tbl = tbl->tbl;
 719         if (!g_tbl)
 720                 return NULL;
 721         g_start = (idx >> MLX5_L3T_GT_OFFSET) & MLX5_L3T_GT_MASK;
 722         m_start = (idx >> MLX5_L3T_MT_OFFSET) & MLX5_L3T_MT_MASK;
 723         e_start = idx & MLX5_L3T_ET_MASK;
 724         for (i = g_start; i < MLX5_L3T_GT_SIZE; i++) {
 725                 m_tbl = g_tbl->tbl[i];
 726                 if (!m_tbl) {
 727                         /* Jump to new table, reset the sub table start. */
 728                         m_start = 0;
 729                         e_start = 0;
 730                         continue;
 731                 }
 732                 for (j = m_start; j < MLX5_L3T_MT_SIZE; j++) {
 733                         if (!m_tbl->tbl[j]) {
 734                                 /*
 735                                  * Jump to new table, reset the sub table
 736                                  * start.
 737                                  */
 738                                 e_start = 0;
 739                                 continue;
 740                         }
 741                         e_tbl = m_tbl->tbl[j];
 742                         switch (tbl->type) {
 743                         case MLX5_L3T_TYPE_WORD:
 744                                 w_e_tbl = (struct mlx5_l3t_entry_word *)e_tbl;
 745                                 for (k = e_start; k < MLX5_L3T_ET_SIZE; k++) {
 746                                         if (!w_e_tbl->entry[k].data)
 747                                                 continue;
 748                                         *pos = (i << MLX5_L3T_GT_OFFSET) |
 749                                                (j << MLX5_L3T_MT_OFFSET) | k;
 750                                         return (void *)&w_e_tbl->entry[k].data;
 751                                 }
 752                                 break;
 753                         case MLX5_L3T_TYPE_DWORD:
 754                                 dw_e_tbl = (struct mlx5_l3t_entry_dword *)e_tbl;
 755                                 for (k = e_start; k < MLX5_L3T_ET_SIZE; k++) {
 756                                         if (!dw_e_tbl->entry[k].data)
 757                                                 continue;
 758                                         *pos = (i << MLX5_L3T_GT_OFFSET) |
 759                                                (j << MLX5_L3T_MT_OFFSET) | k;
 760                                         return (void *)&dw_e_tbl->entry[k].data;
 761                                 }
 762                                 break;
 763                         case MLX5_L3T_TYPE_QWORD:
 764                                 qw_e_tbl = (struct mlx5_l3t_entry_qword *)e_tbl;
 765                                 for (k = e_start; k < MLX5_L3T_ET_SIZE; k++) {
 766                                         if (!qw_e_tbl->entry[k].data)
 767                                                 continue;
 768                                         *pos = (i << MLX5_L3T_GT_OFFSET) |
 769                                                (j << MLX5_L3T_MT_OFFSET) | k;
 770                                         return (void *)&qw_e_tbl->entry[k].data;
 771                                 }
 772                                 break;
 773                         default:
 774                                 ptr_e_tbl = (struct mlx5_l3t_entry_ptr *)e_tbl;
 775                                 for (k = e_start; k < MLX5_L3T_ET_SIZE; k++) {
 776                                         if (!ptr_e_tbl->entry[k].data)
 777                                                 continue;
 778                                         *pos = (i << MLX5_L3T_GT_OFFSET) |
 779                                                (j << MLX5_L3T_MT_OFFSET) | k;
 780                                         return ptr_e_tbl->entry[k].data;
 781                                 }
 782                                 break;
 783                         }
 784                 }
 785         }
 786         return NULL;
 787 }
 788
 789 /*
 790  * Macros for linked list based on indexed memory.
 791  * Example data structure:
 792  * struct Foo {
 793  *      ILIST_ENTRY(uint16_t) next;
 794  *      ...
 795  * }
 796  *
 797  */
 798 #define ILIST_ENTRY(type)                                               \
 799 struct {                                                                \
 800         type prev; /* Index of previous element. */                     \
 801         type next; /* Index of next element. */                         \
 802 }
 803
 804 #define ILIST_INSERT(pool, head, idx, elem, field)                      \
 805         do {                                                            \
 806                 typeof(elem) peer;                                      \
 807                 MLX5_ASSERT((elem) && (idx));                           \
 808                 (elem)->field.next = *(head);                           \
 809                 (elem)->field.prev = 0;                                 \
 810                 if (*(head)) {                                          \
 811                         (peer) = mlx5_ipool_get(pool, *(head));         \
 812                         if (peer)                                       \
 813                                 (peer)->field.prev = (idx);             \
 814                 }                                                       \
 815                 *(head) = (idx);                                        \
 816         } while (0)
 817
 818 #define ILIST_REMOVE(pool, head, idx, elem, field)                      \
 819         do {                                                            \
 820                 typeof(elem) peer;                                      \
 821                 MLX5_ASSERT(elem);                                      \
 822                 MLX5_ASSERT(head);                                      \
 823                 if ((elem)->field.prev) {                               \
 824                         (peer) = mlx5_ipool_get                         \
 825                                  (pool, (elem)->field.prev);            \
 826                         if (peer)                                       \
 827                                 (peer)->field.next = (elem)->field.next;\
 828                 }                                                       \
 829                 if ((elem)->field.next) {                               \
 830                         (peer) = mlx5_ipool_get                         \
 831                                  (pool, (elem)->field.next);            \
 832                         if (peer)                                       \
 833                                 (peer)->field.prev = (elem)->field.prev;\
 834                 }                                                       \
 835                 if (*(head) == (idx))                                   \
 836                         *(head) = (elem)->field.next;                   \
 837         } while (0)
 838
 839 #define ILIST_FOREACH(pool, head, idx, elem, field)                     \
 840         for ((idx) = (head), (elem) =                                   \
 841              (idx) ? mlx5_ipool_get(pool, (idx)) : NULL; (elem);        \
 842              idx = (elem)->field.next, (elem) =                         \
 843              (idx) ? mlx5_ipool_get(pool, idx) : NULL)
 844
 845 /* Single index list. */
 846 #define SILIST_ENTRY(type)                                              \
 847 struct {                                                                \
 848         type next; /* Index of next element. */                         \
 849 }
 850
 851 #define SILIST_INSERT(head, idx, elem, field)                           \
 852         do {                                                            \
 853                 MLX5_ASSERT((elem) && (idx));                           \
 854                 (elem)->field.next = *(head);                           \
 855                 *(head) = (idx);                                        \
 856         } while (0)
 857
 858 #define SILIST_FOREACH(pool, head, idx, elem, field)                    \
 859         for ((idx) = (head), (elem) =                                   \
 860              (idx) ? mlx5_ipool_get(pool, (idx)) : NULL; (elem);        \
 861              idx = (elem)->field.next, (elem) =                         \
 862              (idx) ? mlx5_ipool_get(pool, idx) : NULL)
 863
 864 #define MLX5_L3T_FOREACH(tbl, idx, entry)                               \
 865         for (idx = 0, (entry) = mlx5_l3t_get_next((tbl), &idx);         \
 866              (entry);                                                   \
 867              idx++, (entry) = mlx5_l3t_get_next((tbl), &idx))
 868
 869 #define MLX5_IPOOL_FOREACH(ipool, idx, entry)                           \
 870         for ((idx) = 0, mlx5_ipool_flush_cache((ipool)),                \
 871             (entry) = mlx5_ipool_get_next((ipool), &idx);               \
 872             (entry); idx++, (entry) = mlx5_ipool_get_next((ipool), &idx))
 873
 874 #endif /* RTE_PMD_MLX5_UTILS_H_ */