#include "mlx5_defs.h"
-#define mlx5_hlist_remove(h, e) \
- mlx5_hlist_unregister(h, e)
-
-#define mlx5_hlist_insert(h, e) \
- mlx5_hlist_register(h, 0, e)
-
/* Convert a bit number to the corresponding 64-bit mask */
#define MLX5_BITSHIFT(v) (UINT64_C(1) << (v))
*/
struct mlx5_hlist_entry {
LIST_ENTRY(mlx5_hlist_entry) next; /* entry pointers in the list. */
- uint64_t key; /* user defined 'key', could be the hash signature. */
+ 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 function that is used to handle the data before freeing. */
-typedef void (*mlx5_hlist_destroy_callback_fn)(void *p, void *ctx);
-
-/**
- * Type of function for user defined matching.
- *
- * @param entry
- * The entry in the list.
- * @param ctx
- * The pointer to new entry context.
- *
- * @return
- * 0 if matching, -1 otherwise.
- */
-typedef int (*mlx5_hlist_match_callback_fn)(struct mlx5_hlist_entry *entry,
- void *ctx);
-
/**
* Type of callback function for entry removal.
*
(struct mlx5_hlist *list,
uint64_t key, void *ctx);
+/* Hash list bucket head. */
+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. */
+} __rte_cache_aligned;
+
/**
* Hash list table structure
*
uint32_t entry_sz; /**< Size of entry, used to allocate entry. */
/**< mask to get the index of the list heads. */
uint32_t mask;
- rte_rwlock_t lock;
- uint32_t gen_cnt; /* List modification will update generation count. */
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. */
- struct mlx5_hlist_head heads[]; /**< list head arrays. */
+ struct mlx5_hlist_bucket buckets[] __rte_cache_aligned;
+ /**< list bucket arrays. */
};
/**
void *ctx);
/**
- * Extended routine to search an entry matching the context with
- * user defined match function.
+ * Insert an entry to the hash list table, the entry is only part of whole data
+ * element and a 64B key is used for matching. User should construct the key or
+ * give a calculated hash signature and guarantee there is no collision.
*
* @param h
* Pointer to the hast list table.
- * @param key
- * Key for the searching entry.
- * @param cb
- * Callback function to match the node with context.
+ * @param entry
+ * Entry to be inserted into the hash list table.
* @param ctx
* Common context parameter used by callback function.
*
* @return
- * Pointer of the hlist entry if found, NULL otherwise.
+ * registered entry on success, NULL otherwise
*/
-struct mlx5_hlist_entry *mlx5_hlist_lookup_ex(struct mlx5_hlist *h,
- uint64_t key,
- mlx5_hlist_match_callback_fn cb,
- void *ctx);
+struct mlx5_hlist_entry *mlx5_hlist_register(struct mlx5_hlist *h, uint64_t key,
+ void *ctx);
/**
- * Extended routine to insert an entry to the list with key collisions.
+ * Remove an entry from the hash list table. User should guarantee the validity
+ * of the entry.
*
- * For the list have key collision, the extra user defined match function
- * allows node with same key will be inserted.
+ * @param h
+ * Pointer to the hast list table. (not used)
+ * @param entry
+ * Entry to be removed from the hash list table.
+ * @return
+ * 0 on entry removed, 1 on entry still referenced.
+ */
+int mlx5_hlist_unregister(struct mlx5_hlist *h, struct mlx5_hlist_entry *entry);
+
+/**
+ * Destroy the hash list table, all the entries already inserted into the lists
+ * will be handled by the callback function provided by the user (including
+ * free if needed) before the table is freed.
*
* @param h
* Pointer to the hast list table.
+ */
+void mlx5_hlist_destroy(struct mlx5_hlist *h);
+
+/************************ cache list *****************************/
+
+/** Maximum size of string for naming. */
+#define MLX5_NAME_SIZE 32
+
+struct mlx5_cache_list;
+
+/**
+ * Structure of the entry in the cache list, user should define its own struct
+ * that contains this in order to store the data.
+ */
+struct mlx5_cache_entry {
+ LIST_ENTRY(mlx5_cache_entry) next; /* Entry pointers in the list. */
+ uint32_t ref_cnt; /* Reference count. */
+};
+
+/**
+ * Type of callback function for entry removal.
+ *
+ * @param list
+ * The cache list.
* @param entry
- * Entry to be inserted into the hash list table.
- * @param cb
- * Callback function to match the node with context.
+ * The entry in the list.
+ */
+typedef void (*mlx5_cache_remove_cb)(struct mlx5_cache_list *list,
+ struct mlx5_cache_entry *entry);
+
+/**
+ * Type of function for user defined matching.
+ *
+ * @param list
+ * The cache list.
+ * @param entry
+ * The entry in the list.
* @param ctx
- * Common context parameter used by callback function.
+ * The pointer to new entry context.
*
* @return
- * - zero for success.
- * - -EEXIST if the entry is already inserted.
+ * 0 if matching, non-zero number otherwise.
*/
-int mlx5_hlist_insert_ex(struct mlx5_hlist *h, struct mlx5_hlist_entry *entry,
- mlx5_hlist_match_callback_fn cb, void *ctx);
+typedef int (*mlx5_cache_match_cb)(struct mlx5_cache_list *list,
+ struct mlx5_cache_entry *entry, void *ctx);
/**
- * Insert an entry to the hash list table, the entry is only part of whole data
- * element and a 64B key is used for matching. User should construct the key or
- * give a calculated hash signature and guarantee there is no collision.
+ * Type of function for user defined cache list entry creation.
*
- * @param h
- * Pointer to the hast list table.
+ * @param list
+ * The cache list.
* @param entry
- * Entry to be inserted into the hash list table.
+ * The new allocated entry, NULL if list entry size unspecified,
+ * New entry has to be allocated in callback and return.
+ * @param ctx
+ * The pointer to new entry context.
+ *
+ * @return
+ * Pointer of entry on success, NULL otherwise.
+ */
+typedef struct mlx5_cache_entry *(*mlx5_cache_create_cb)
+ (struct mlx5_cache_list *list,
+ struct mlx5_cache_entry *entry,
+ void *ctx);
+
+/**
+ * Linked cache list structure.
+ *
+ * Entry in cache 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.
+ *
+ * Linked list cache is designed for limited number of entries cache,
+ * read mostly, less modification.
+ *
+ * For huge amount of entries cache, please consider hash list cache.
+ *
+ */
+struct mlx5_cache_list {
+ char name[MLX5_NAME_SIZE]; /**< Name of the cache list. */
+ uint32_t entry_sz; /**< Entry size, 0: use create callback. */
+ rte_rwlock_t lock; /* read/write lock. */
+ uint32_t gen_cnt; /* List modification will update generation count. */
+ uint32_t count; /* number of entries in list. */
+ void *ctx; /* user objects target to callback. */
+ mlx5_cache_create_cb cb_create; /**< entry create callback. */
+ mlx5_cache_match_cb cb_match; /**< entry match callback. */
+ mlx5_cache_remove_cb cb_remove; /**< entry remove callback. */
+ LIST_HEAD(mlx5_cache_head, mlx5_cache_entry) head;
+};
+
+/**
+ * Initialize a cache list.
+ *
+ * @param list
+ * Pointer to the hast list table.
+ * @param name
+ * Name of the cache list.
+ * @param entry_size
+ * Entry size to allocate, 0 to allocate by creation callback.
+ * @param ctx
+ * Pointer to the list context data.
+ * @param cb_create
+ * Callback function for entry create.
+ * @param cb_match
+ * Callback function for entry match.
+ * @param cb_remove
+ * Callback function for entry remove.
+ * @return
+ * 0 on success, otherwise failure.
+ */
+int mlx5_cache_list_init(struct mlx5_cache_list *list,
+ const char *name, uint32_t entry_size, void *ctx,
+ mlx5_cache_create_cb cb_create,
+ mlx5_cache_match_cb cb_match,
+ mlx5_cache_remove_cb cb_remove);
+
+/**
+ * Search an entry matching the key.
+ *
+ * Result returned might be destroyed by other thread, must use
+ * this function only in main thread.
+ *
+ * @param list
+ * Pointer to the cache list.
+ * @param ctx
+ * Common context parameter used by entry callback function.
+ *
+ * @return
+ * Pointer of the cache entry if found, NULL otherwise.
+ */
+struct mlx5_cache_entry *mlx5_cache_lookup(struct mlx5_cache_list *list,
+ void *ctx);
+
+/**
+ * Reuse or create an entry to the cache list.
+ *
+ * @param list
+ * Pointer to the hast list table.
* @param ctx
* Common context parameter used by callback function.
*
* @return
* registered entry on success, NULL otherwise
*/
-struct mlx5_hlist_entry *mlx5_hlist_register(struct mlx5_hlist *h, uint64_t key,
+struct mlx5_cache_entry *mlx5_cache_register(struct mlx5_cache_list *list,
void *ctx);
/**
- * Remove an entry from the hash list table. User should guarantee the validity
- * of the entry.
+ * Remove an entry from the cache list.
*
- * @param h
- * Pointer to the hast list table. (not used)
+ * User should guarantee the validity of the entry.
+ *
+ * @param list
+ * Pointer to the hast list.
* @param entry
- * Entry to be removed from the hash list table.
+ * Entry to be removed from the cache list table.
* @return
* 0 on entry removed, 1 on entry still referenced.
*/
-int mlx5_hlist_unregister(struct mlx5_hlist *h, struct mlx5_hlist_entry *entry);
+int mlx5_cache_unregister(struct mlx5_cache_list *list,
+ struct mlx5_cache_entry *entry);
/**
- * Destroy the hash list table, all the entries already inserted into the lists
- * will be handled by the callback function provided by the user (including
- * free if needed) before the table is freed.
+ * Destroy the cache list.
*
- * @param h
- * Pointer to the hast list table.
+ * @param list
+ * Pointer to the cache list.
*/
-void mlx5_hlist_destroy(struct mlx5_hlist *h);
+void mlx5_cache_list_destroy(struct mlx5_cache_list *list);
+
+/**
+ * Get entry number from the cache list.
+ *
+ * @param list
+ * Pointer to the hast list.
+ * @return
+ * Cache list entry number.
+ */
+uint32_t
+mlx5_cache_list_get_entry_num(struct mlx5_cache_list *list);
+
+/********************************* indexed pool *************************/
/**
* This function allocates non-initialized memory entry from pool.
git.droids-corp.org / dpdk.git / blobdiff