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