#ifndef RTE_PMD_MLX5_COMMON_UTILS_H_
#define RTE_PMD_MLX5_COMMON_UTILS_H_
+#include <rte_rwlock.h>
+
#include "mlx5_common.h"
/************************ mlx5 list *****************************/
/** Maximum size of string for naming. */
#define MLX5_NAME_SIZE 32
+/** Maximum size of list. */
+#define MLX5_LIST_MAX (RTE_MAX_LCORE + 2)
+/** Global list index. */
+#define MLX5_LIST_GLOBAL ((MLX5_LIST_MAX) - 1)
+/** None rte core list index. */
+#define MLX5_LIST_NLCORE ((MLX5_LIST_MAX) - 2)
struct mlx5_list;
*/
struct mlx5_list_entry {
LIST_ENTRY(mlx5_list_entry) next; /* Entry pointers in the list. */
- uint32_t ref_cnt; /* 0 means, entry is invalid. */
+ uint32_t ref_cnt __rte_aligned(8); /* 0 means, entry is invalid. */
uint32_t lcore_idx;
- struct mlx5_list_entry *gentry;
-};
+ union {
+ struct mlx5_list_entry *gentry;
+ uint32_t bucket_idx;
+ };
+} __rte_packed;
struct mlx5_list_cache {
LIST_HEAD(mlx5_list_head, mlx5_list_entry) h;
/**
* Type of callback function for entry removal.
*
- * @param list
- * The mlx5 list.
+ * @param tool_ctx
+ * The tool instance user context.
* @param entry
* The entry in the list.
*/
-typedef void (*mlx5_list_remove_cb)(struct mlx5_list *list,
- struct mlx5_list_entry *entry);
+typedef void (*mlx5_list_remove_cb)(void *tool_ctx,
+ struct mlx5_list_entry *entry);
/**
* Type of function for user defined matching.
*
- * @param list
- * The mlx5 list.
+ * @param tool_ctx
+ * The tool instance context.
* @param entry
* The entry in the list.
* @param ctx
* @return
* 0 if matching, non-zero number otherwise.
*/
-typedef int (*mlx5_list_match_cb)(struct mlx5_list *list,
+typedef int (*mlx5_list_match_cb)(void *tool_ctx,
struct mlx5_list_entry *entry, void *ctx);
-typedef struct mlx5_list_entry *(*mlx5_list_clone_cb)
- (struct mlx5_list *list,
- struct mlx5_list_entry *entry, void *ctx);
+typedef struct mlx5_list_entry *(*mlx5_list_clone_cb)(void *tool_ctx,
+ struct mlx5_list_entry *entry, void *ctx);
-typedef void (*mlx5_list_clone_free_cb)(struct mlx5_list *list,
- struct mlx5_list_entry *entry);
+typedef void (*mlx5_list_clone_free_cb)(void *tool_ctx,
+ struct mlx5_list_entry *entry);
/**
* Type of function for user defined mlx5 list entry creation.
*
- * @param list
- * The mlx5 list.
- * @param entry
- * The new allocated entry, NULL if list entry size unspecified,
- * New entry has to be allocated in callback and return.
+ * @param tool_ctx
+ * The mlx5 tool instance context.
* @param ctx
* The pointer to new entry context.
*
* @return
* Pointer of entry on success, NULL otherwise.
*/
-typedef struct mlx5_list_entry *(*mlx5_list_create_cb)
- (struct mlx5_list *list,
- struct mlx5_list_entry *entry,
- void *ctx);
+typedef struct mlx5_list_entry *(*mlx5_list_create_cb)(void *tool_ctx,
+ void *ctx);
+
+/**
+ * Linked mlx5 list constant object.
+ */
+struct mlx5_list_const {
+ char name[MLX5_NAME_SIZE]; /**< Name of the mlx5 list. */
+ void *ctx; /* user objects target to callback. */
+ bool lcores_share; /* Whether to share objects between the lcores. */
+ rte_spinlock_t lcore_lock; /* Lock for non-lcore list. */
+ mlx5_list_create_cb cb_create; /**< entry create callback. */
+ mlx5_list_match_cb cb_match; /**< entry match callback. */
+ mlx5_list_remove_cb cb_remove; /**< entry remove callback. */
+ mlx5_list_clone_cb cb_clone; /**< entry clone callback. */
+ mlx5_list_clone_free_cb cb_clone_free;
+ /**< entry clone free callback. */
+};
+
+/**
+ * Linked mlx5 list inconstant data.
+ */
+struct mlx5_list_inconst {
+ rte_rwlock_t lock; /* read/write lock. */
+ volatile uint32_t gen_cnt; /* List modification may update it. */
+ volatile uint32_t count; /* number of entries in list. */
+ struct mlx5_list_cache *cache[MLX5_LIST_MAX];
+ /* Lcore cache, last index is the global cache. */
+};
/**
* Linked mlx5 list structure.
*
*/
struct mlx5_list {
- char name[MLX5_NAME_SIZE]; /**< Name of the mlx5 list. */
- void *ctx; /* user objects target to callback. */
- bool lcores_share; /* Whether to share objects between the lcores. */
- mlx5_list_create_cb cb_create; /**< entry create callback. */
- mlx5_list_match_cb cb_match; /**< entry match callback. */
- mlx5_list_remove_cb cb_remove; /**< entry remove callback. */
- mlx5_list_clone_cb cb_clone; /**< entry clone callback. */
- mlx5_list_clone_free_cb cb_clone_free;
- struct mlx5_list_cache cache[RTE_MAX_LCORE + 1];
- /* Lcore cache, last index is the global cache. */
- volatile uint32_t gen_cnt; /* List modification may update it. */
- volatile uint32_t count; /* number of entries in list. */
- rte_rwlock_t lock; /* read/write lock. */
+ struct mlx5_list_const l_const;
+ struct mlx5_list_inconst l_inconst;
};
/**
uint32_t
mlx5_list_get_entry_num(struct mlx5_list *list);
-/************************ Hash list *****************************/
-
-#define MLX5_HLIST_DIRECT_KEY 0x0001 /* Use the key directly as hash index. */
-#define MLX5_HLIST_WRITE_MOST 0x0002 /* List mostly used for append new. */
-
-/** Maximum size of string for naming the hlist table. */
-#define MLX5_HLIST_NAMESIZE 32
-
-struct mlx5_hlist;
-
-/**
- * Structure of the entry in the hash list, user should define its own struct
- * that contains this in order to store the data. The 'key' is 64-bits right
- * now and its user's responsibility to guarantee there is no collision.
- */
-struct mlx5_hlist_entry {
- LIST_ENTRY(mlx5_hlist_entry) next; /* entry pointers in the list. */
- uint32_t idx; /* Bucket index the entry belongs to. */
- uint32_t ref_cnt; /* Reference count. */
-};
-
-/** Structure for hash head. */
-LIST_HEAD(mlx5_hlist_head, mlx5_hlist_entry);
-
-/**
- * Type of callback function for entry removal.
- *
- * @param list
- * The hash list.
- * @param entry
- * The entry in the list.
- */
-typedef void (*mlx5_hlist_remove_cb)(struct mlx5_hlist *list,
- struct mlx5_hlist_entry *entry);
+/********************* Hash List **********************/
-/**
- * Type of function for user defined matching.
- *
- * @param list
- * The hash list.
- * @param entry
- * The entry in the list.
- * @param key
- * The new entry key.
- * @param ctx
- * The pointer to new entry context.
- *
- * @return
- * 0 if matching, non-zero number otherwise.
- */
-typedef int (*mlx5_hlist_match_cb)(struct mlx5_hlist *list,
- struct mlx5_hlist_entry *entry,
- uint64_t key, void *ctx);
-
-/**
- * Type of function for user defined hash list entry creation.
- *
- * @param list
- * The hash list.
- * @param key
- * The key of the new entry.
- * @param ctx
- * The pointer to new entry context.
- *
- * @return
- * Pointer to allocated entry on success, NULL otherwise.
- */
-typedef struct mlx5_hlist_entry *(*mlx5_hlist_create_cb)
- (struct mlx5_hlist *list,
- uint64_t key, void *ctx);
-
-/* Hash list bucket head. */
+/* Hash list bucket. */
struct mlx5_hlist_bucket {
- struct mlx5_hlist_head head; /* List head. */
- rte_rwlock_t lock; /* Bucket lock. */
- uint32_t gen_cnt; /* List modification will update generation count. */
+ struct mlx5_list_inconst l;
} __rte_cache_aligned;
/**
* Hash list table structure
*
- * Entry in hash list could be reused if entry already exists, reference
- * count will increase and the existing entry returns.
- *
- * When destroy an entry from list, decrease reference count and only
- * destroy when no further reference.
+ * The hash list bucket using the mlx5_list object for managing.
*/
struct mlx5_hlist {
- char name[MLX5_HLIST_NAMESIZE]; /**< Name of the hash list. */
- /**< number of heads, need to be power of 2. */
- uint32_t table_sz;
- uint32_t entry_sz; /**< Size of entry, used to allocate entry. */
- /**< mask to get the index of the list heads. */
- uint32_t mask;
- bool direct_key; /* Use the new entry key directly as hash index. */
- bool write_most; /* List mostly used for append new or destroy. */
- void *ctx;
- mlx5_hlist_create_cb cb_create; /**< entry create callback. */
- mlx5_hlist_match_cb cb_match; /**< entry match callback. */
- mlx5_hlist_remove_cb cb_remove; /**< entry remove callback. */
+ uint32_t mask; /* A mask for the bucket index range. */
+ uint8_t flags;
+ bool direct_key; /* Whether to use the key directly as hash index. */
+ struct mlx5_list_const l_const; /* List constant data. */
struct mlx5_hlist_bucket buckets[] __rte_cache_aligned;
- /**< list bucket arrays. */
};
/**
* Heads array size of the hash list.
* @param entry_size
* Entry size to allocate if cb_create not specified.
- * @param flags
- * The hash list attribute flags.
+ * @param direct key
+ * Whether to use the key directly as hash index.
+ * @param lcores_share
+ * Whether to share objects between the lcores.
+ * @param ctx
+ * The hlist instance context.
* @param cb_create
* Callback function for entry create.
* @param cb_match
* Callback function for entry match.
- * @param cb_destroy
- * Callback function for entry destroy.
+ * @param cb_remove
+ * Callback function for entry remove.
+ * @param cb_clone
+ * Callback function for entry clone.
+ * @param cb_clone_free
+ * Callback function for entry clone free.
* @return
* Pointer of the hash list table created, NULL on failure.
*/
__rte_internal
struct mlx5_hlist *mlx5_hlist_create(const char *name, uint32_t size,
- uint32_t entry_size, uint32_t flags,
- mlx5_hlist_create_cb cb_create,
- mlx5_hlist_match_cb cb_match,
- mlx5_hlist_remove_cb cb_destroy);
+ bool direct_key, bool lcores_share,
+ void *ctx, mlx5_list_create_cb cb_create,
+ mlx5_list_match_cb cb_match,
+ mlx5_list_remove_cb cb_remove,
+ mlx5_list_clone_cb cb_clone,
+ mlx5_list_clone_free_cb cb_clone_free);
/**
* Search an entry matching the key.
* Pointer of the hlist entry if found, NULL otherwise.
*/
__rte_internal
-struct mlx5_hlist_entry *mlx5_hlist_lookup(struct mlx5_hlist *h, uint64_t key,
+struct mlx5_list_entry *mlx5_hlist_lookup(struct mlx5_hlist *h, uint64_t key,
void *ctx);
/**
* registered entry on success, NULL otherwise
*/
__rte_internal
-struct mlx5_hlist_entry *mlx5_hlist_register(struct mlx5_hlist *h, uint64_t key,
+struct mlx5_list_entry *mlx5_hlist_register(struct mlx5_hlist *h, uint64_t key,
void *ctx);
/**
* 0 on entry removed, 1 on entry still referenced.
*/
__rte_internal
-int mlx5_hlist_unregister(struct mlx5_hlist *h, struct mlx5_hlist_entry *entry);
+int mlx5_hlist_unregister(struct mlx5_hlist *h, struct mlx5_list_entry *entry);
/**
* Destroy the hash list table, all the entries already inserted into the lists
git.droids-corp.org / dpdk.git / blobdiff