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