X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=drivers%2Fnet%2Fmlx5%2Fmlx5_utils.h;h=b54517c6dfb1847124a0aafce53e865a46edc5d3;hb=05b405d581486651305551a9f7295f40388d95db;hp=0e016f87c33ac30a0cf4965235f797d9666589da;hpb=f5bf02df3145f95b1ee8ed9dee67f4222ac42c8c;p=dpdk.git diff --git a/drivers/net/mlx5/mlx5_utils.h b/drivers/net/mlx5/mlx5_utils.h index 0e016f87c3..b54517c6df 100644 --- a/drivers/net/mlx5/mlx5_utils.h +++ b/drivers/net/mlx5/mlx5_utils.h @@ -13,14 +13,15 @@ #include #include +#include #include #include #include +#include #include "mlx5_defs.h" - /* Convert a bit number to the corresponding 64-bit mask */ #define MLX5_BITSHIFT(v) (UINT64_C(1) << (v)) @@ -29,16 +30,14 @@ extern int mlx5_logtype; +#define MLX5_NET_LOG_PREFIX "mlx5_net" + /* Generic printf()-like logging macro with automatic line feed. */ #define DRV_LOG(level, ...) \ - PMD_DRV_LOG_(level, mlx5_logtype, MLX5_DRIVER_NAME, \ + PMD_DRV_LOG_(level, mlx5_logtype, MLX5_NET_LOG_PREFIX, \ __VA_ARGS__ PMD_DRV_LOG_STRIP PMD_DRV_LOG_OPAREN, \ PMD_DRV_LOG_CPAREN) -#define INFO(...) DRV_LOG(INFO, __VA_ARGS__) -#define WARN(...) DRV_LOG(WARNING, __VA_ARGS__) -#define ERROR(...) DRV_LOG(ERR, __VA_ARGS__) - /* Convenience macros for accessing mbuf fields. */ #define NEXT(m) ((m)->next) #define DATA_LEN(m) ((m)->data_len) @@ -54,6 +53,123 @@ extern int mlx5_logtype; (((val) & (from)) / ((from) / (to))) : \ (((val) & (from)) * ((to) / (from)))) +/* + * For the case which data is linked with sequence increased index, the + * array table will be more efficiect than hash table once need to serarch + * one data entry in large numbers of entries. Since the traditional hash + * tables has fixed table size, when huge numbers of data saved to the hash + * table, it also comes lots of hash conflict. + * + * But simple array table also has fixed size, allocates all the needed + * memory at once will waste lots of memory. For the case don't know the + * exactly number of entries will be impossible to allocate the array. + * + * Then the multiple level table helps to balance the two disadvantages. + * Allocate a global high level table with sub table entries at first, + * the global table contains the sub table entries, and the sub table will + * be allocated only once the corresponding index entry need to be saved. + * e.g. for up to 32-bits index, three level table with 10-10-12 splitting, + * with sequence increased index, the memory grows with every 4K entries. + * + * The currently implementation introduces 10-10-12 32-bits splitting + * Three-Level table to help the cases which have millions of enties to + * save. The index entries can be addressed directly by the index, no + * search will be needed.q + */ + +/* L3 table global table define. */ +#define MLX5_L3T_GT_OFFSET 22 +#define MLX5_L3T_GT_SIZE (1 << 10) +#define MLX5_L3T_GT_MASK (MLX5_L3T_GT_SIZE - 1) + +/* L3 table middle table define. */ +#define MLX5_L3T_MT_OFFSET 12 +#define MLX5_L3T_MT_SIZE (1 << 10) +#define MLX5_L3T_MT_MASK (MLX5_L3T_MT_SIZE - 1) + +/* L3 table entry table define. */ +#define MLX5_L3T_ET_OFFSET 0 +#define MLX5_L3T_ET_SIZE (1 << 12) +#define MLX5_L3T_ET_MASK (MLX5_L3T_ET_SIZE - 1) + +/* L3 table type. */ +enum mlx5_l3t_type { + MLX5_L3T_TYPE_WORD = 0, + MLX5_L3T_TYPE_DWORD, + MLX5_L3T_TYPE_QWORD, + MLX5_L3T_TYPE_PTR, + MLX5_L3T_TYPE_MAX, +}; + +struct mlx5_indexed_pool; + +/* Generic data struct. */ +union mlx5_l3t_data { + uint16_t word; + uint32_t dword; + uint64_t qword; + void *ptr; +}; + +/* L3 level table data structure. */ +struct mlx5_l3t_level_tbl { + uint64_t ref_cnt; /* Table ref_cnt. */ + void *tbl[]; /* Table array. */ +}; + +/* L3 word entry table data structure. */ +struct mlx5_l3t_entry_word { + uint32_t idx; /* Table index. */ + uint64_t ref_cnt; /* Table ref_cnt. */ + struct { + uint16_t data; + uint32_t ref_cnt; + } entry[MLX5_L3T_ET_SIZE]; /* Entry array */ +} __rte_packed; + +/* L3 double word entry table data structure. */ +struct mlx5_l3t_entry_dword { + uint32_t idx; /* Table index. */ + uint64_t ref_cnt; /* Table ref_cnt. */ + struct { + uint32_t data; + int32_t ref_cnt; + } entry[MLX5_L3T_ET_SIZE]; /* Entry array */ +} __rte_packed; + +/* L3 quad word entry table data structure. */ +struct mlx5_l3t_entry_qword { + uint32_t idx; /* Table index. */ + uint64_t ref_cnt; /* Table ref_cnt. */ + struct { + uint64_t data; + uint32_t ref_cnt; + } entry[MLX5_L3T_ET_SIZE]; /* Entry array */ +} __rte_packed; + +/* L3 pointer entry table data structure. */ +struct mlx5_l3t_entry_ptr { + uint32_t idx; /* Table index. */ + uint64_t ref_cnt; /* Table ref_cnt. */ + struct { + void *data; + uint32_t ref_cnt; + } entry[MLX5_L3T_ET_SIZE]; /* Entry array */ +} __rte_packed; + +/* L3 table data structure. */ +struct mlx5_l3t_tbl { + enum mlx5_l3t_type type; /* Table type. */ + struct mlx5_indexed_pool *eip; + /* Table index pool handles. */ + struct mlx5_l3t_level_tbl *tbl; /* Global table index. */ + rte_spinlock_t sl; /* The table lock. */ +}; + +/** Type of function that is used to handle the data before freeing. */ +typedef int32_t (*mlx5_l3t_alloc_callback_fn)(void *ctx, + union mlx5_l3t_data *data); + /* * The indexed memory entry index is made up of trunk index and offset of * the entry in the trunk. Since the entry index is 32 bits, in case user @@ -93,7 +209,7 @@ struct mlx5_indexed_pool_config { /* Lock is needed for multiple thread usage. */ uint32_t release_mem_en:1; /* Rlease trunk when it is free. */ const char *type; /* Memory allocate type name. */ - void *(*malloc)(const char *type, size_t size, unsigned int align, + void *(*malloc)(uint32_t flags, size_t size, unsigned int align, int socket); /* User defined memory allocator. */ void (*free)(void *addr); /* User defined memory release. */ @@ -105,7 +221,7 @@ struct mlx5_indexed_trunk { uint32_t next; /* Next free trunk in free list. */ uint32_t free; /* Free entries available */ struct rte_bitmap *bmp; - uint8_t data[] __rte_cache_min_aligned; /* Entry data start. */ + uint8_t data[] __rte_cache_aligned; /* Entry data start. */ }; struct mlx5_indexed_pool { @@ -146,108 +262,188 @@ log2above(unsigned int v) return l + r; } -/** Maximum size of string for naming the hlist table. */ -#define MLX5_HLIST_NAMESIZE 32 +/************************ cache list *****************************/ + +/** Maximum size of string for naming. */ +#define MLX5_NAME_SIZE 32 + +struct mlx5_cache_list; /** - * 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. + * 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_hlist_entry { - LIST_ENTRY(mlx5_hlist_entry) next; /* entry pointers in the list. */ - uint64_t key; /* user defined 'key', could be the hash signature. */ +struct mlx5_cache_entry { + LIST_ENTRY(mlx5_cache_entry) next; /* Entry pointers in the list. */ + 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 cache list. + * @param entry + * The entry in the list. + */ +typedef void (*mlx5_cache_remove_cb)(struct mlx5_cache_list *list, + struct mlx5_cache_entry *entry); -/** Type of function that is used to handle the data before freeing. */ -typedef void (*mlx5_hlist_destroy_callback_fn)(void *p, void *ctx); - -/** hash list table structure */ -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; - /**< mask to get the index of the list heads. */ - uint32_t mask; - struct mlx5_hlist_head heads[]; /**< list head arrays. */ +/** + * Type of function for user defined matching. + * + * @param list + * The cache list. + * @param entry + * The entry in the list. + * @param ctx + * The pointer to new entry context. + * + * @return + * 0 if matching, non-zero number otherwise. + */ +typedef int (*mlx5_cache_match_cb)(struct mlx5_cache_list *list, + struct mlx5_cache_entry *entry, void *ctx); + +/** + * Type of function for user defined cache list entry creation. + * + * @param list + * The cache list. + * @param entry + * 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; }; /** - * Create a hash list table, the user can specify the list heads array size - * of the table, now the size should be a power of 2 in order to get better - * distribution for the entries. Each entry is a part of the whole data element - * and the caller should be responsible for the data element's allocation and - * cleanup / free. Key of each entry will be calculated with CRC in order to - * generate a little fairer distribution. + * Initialize a cache list. * + * @param list + * Pointer to the hast list table. * @param name - * Name of the hash list(optional). - * @param size - * Heads array size of the hash list. - * + * 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 - * Pointer of the hash list table created, NULL on failure. + * 0 on success, otherwise failure. */ -struct mlx5_hlist *mlx5_hlist_create(const char *name, uint32_t size); +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. * - * @param h - * Pointer to the hast list table. - * @param key - * Key for the searching entry. + * 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 hlist entry if found, NULL otherwise. + * Pointer of the cache entry if found, NULL otherwise. */ -struct mlx5_hlist_entry *mlx5_hlist_lookup(struct mlx5_hlist *h, uint64_t key); +struct mlx5_cache_entry *mlx5_cache_lookup(struct mlx5_cache_list *list, + 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. + * Reuse or create an entry to the cache list. * - * @param h + * @param list * Pointer to the hast list table. - * @param entry - * Entry to be inserted into the hash list table. + * @param ctx + * Common context parameter used by callback function. * * @return - * - zero for success. - * - -EEXIST if the entry is already inserted. + * registered entry on success, NULL otherwise */ -int mlx5_hlist_insert(struct mlx5_hlist *h, struct mlx5_hlist_entry *entry); +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. */ -void mlx5_hlist_remove(struct mlx5_hlist *h __rte_unused, - 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 cb - * Callback function for each inserted entry when destroying the hash list. - * @param ctx - * Common context parameter used by callback function for each entry. + * @param list + * Pointer to the cache list. */ -void mlx5_hlist_destroy(struct mlx5_hlist *h, - mlx5_hlist_destroy_callback_fn cb, void *ctx); +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. @@ -345,6 +541,192 @@ int mlx5_ipool_destroy(struct mlx5_indexed_pool *pool); */ void mlx5_ipool_dump(struct mlx5_indexed_pool *pool); +/** + * This function allocates new empty Three-level table. + * + * @param type + * The l3t can set as word, double word, quad word or pointer with index. + * + * @return + * - Pointer to the allocated l3t. + * - NULL on error. Not enough memory, or invalid arguments. + */ +struct mlx5_l3t_tbl *mlx5_l3t_create(enum mlx5_l3t_type type); + +/** + * This function destroys Three-level table. + * + * @param tbl + * Pointer to the l3t. + */ +void mlx5_l3t_destroy(struct mlx5_l3t_tbl *tbl); + +/** + * This function gets the index entry from Three-level table. + * + * @param tbl + * Pointer to the l3t. + * @param idx + * Index to the entry. + * @param data + * Pointer to the memory which saves the entry data. + * When function call returns 0, data contains the entry data get from + * l3t. + * When function call returns -1, data is not modified. + * + * @return + * 0 if success, -1 on error. + */ + +int32_t mlx5_l3t_get_entry(struct mlx5_l3t_tbl *tbl, uint32_t idx, + union mlx5_l3t_data *data); + +/** + * This function gets the index entry from Three-level table. + * + * If the index entry is not available, allocate new one by callback + * function and fill in the entry. + * + * @param tbl + * Pointer to the l3t. + * @param idx + * Index to the entry. + * @param data + * Pointer to the memory which saves the entry data. + * When function call returns 0, data contains the entry data get from + * l3t. + * When function call returns -1, data is not modified. + * @param cb + * Callback function to allocate new data. + * @param ctx + * Context for callback function. + * + * @return + * 0 if success, -1 on error. + */ + +int32_t mlx5_l3t_prepare_entry(struct mlx5_l3t_tbl *tbl, uint32_t idx, + union mlx5_l3t_data *data, + mlx5_l3t_alloc_callback_fn cb, void *ctx); + +/** + * This function decreases and clear index entry if reference + * counter is 0 from Three-level table. + * + * @param tbl + * Pointer to the l3t. + * @param idx + * Index to the entry. + * + * @return + * The remaining reference count, 0 means entry be cleared, -1 on error. + */ +int32_t mlx5_l3t_clear_entry(struct mlx5_l3t_tbl *tbl, uint32_t idx); + +/** + * This function sets the index entry to Three-level table. + * If the entry is already set, the EEXIST errno will be given, and + * the set data will be filled to the data. + * + * @param tbl[in] + * Pointer to the l3t. + * @param idx[in] + * Index to the entry. + * @param data[in/out] + * Pointer to the memory which contains the entry data save to l3t. + * If the entry is already set, the set data will be filled. + * + * @return + * 0 if success, -1 on error. + */ +int32_t mlx5_l3t_set_entry(struct mlx5_l3t_tbl *tbl, uint32_t idx, + union mlx5_l3t_data *data); + +static inline void * +mlx5_l3t_get_next(struct mlx5_l3t_tbl *tbl, uint32_t *pos) +{ + struct mlx5_l3t_level_tbl *g_tbl, *m_tbl; + uint32_t i, j, k, g_start, m_start, e_start; + uint32_t idx = *pos; + void *e_tbl; + struct mlx5_l3t_entry_word *w_e_tbl; + struct mlx5_l3t_entry_dword *dw_e_tbl; + struct mlx5_l3t_entry_qword *qw_e_tbl; + struct mlx5_l3t_entry_ptr *ptr_e_tbl; + + if (!tbl) + return NULL; + g_tbl = tbl->tbl; + if (!g_tbl) + return NULL; + g_start = (idx >> MLX5_L3T_GT_OFFSET) & MLX5_L3T_GT_MASK; + m_start = (idx >> MLX5_L3T_MT_OFFSET) & MLX5_L3T_MT_MASK; + e_start = idx & MLX5_L3T_ET_MASK; + for (i = g_start; i < MLX5_L3T_GT_SIZE; i++) { + m_tbl = g_tbl->tbl[i]; + if (!m_tbl) { + /* Jump to new table, reset the sub table start. */ + m_start = 0; + e_start = 0; + continue; + } + for (j = m_start; j < MLX5_L3T_MT_SIZE; j++) { + if (!m_tbl->tbl[j]) { + /* + * Jump to new table, reset the sub table + * start. + */ + e_start = 0; + continue; + } + e_tbl = m_tbl->tbl[j]; + switch (tbl->type) { + case MLX5_L3T_TYPE_WORD: + w_e_tbl = (struct mlx5_l3t_entry_word *)e_tbl; + for (k = e_start; k < MLX5_L3T_ET_SIZE; k++) { + if (!w_e_tbl->entry[k].data) + continue; + *pos = (i << MLX5_L3T_GT_OFFSET) | + (j << MLX5_L3T_MT_OFFSET) | k; + return (void *)&w_e_tbl->entry[k].data; + } + break; + case MLX5_L3T_TYPE_DWORD: + dw_e_tbl = (struct mlx5_l3t_entry_dword *)e_tbl; + for (k = e_start; k < MLX5_L3T_ET_SIZE; k++) { + if (!dw_e_tbl->entry[k].data) + continue; + *pos = (i << MLX5_L3T_GT_OFFSET) | + (j << MLX5_L3T_MT_OFFSET) | k; + return (void *)&dw_e_tbl->entry[k].data; + } + break; + case MLX5_L3T_TYPE_QWORD: + qw_e_tbl = (struct mlx5_l3t_entry_qword *)e_tbl; + for (k = e_start; k < MLX5_L3T_ET_SIZE; k++) { + if (!qw_e_tbl->entry[k].data) + continue; + *pos = (i << MLX5_L3T_GT_OFFSET) | + (j << MLX5_L3T_MT_OFFSET) | k; + return (void *)&qw_e_tbl->entry[k].data; + } + break; + default: + ptr_e_tbl = (struct mlx5_l3t_entry_ptr *)e_tbl; + for (k = e_start; k < MLX5_L3T_ET_SIZE; k++) { + if (!ptr_e_tbl->entry[k].data) + continue; + *pos = (i << MLX5_L3T_GT_OFFSET) | + (j << MLX5_L3T_MT_OFFSET) | k; + return ptr_e_tbl->entry[k].data; + } + break; + } + } + } + return NULL; +} + /* * Macros for linked list based on indexed memory. * Example data structure: @@ -420,4 +802,9 @@ struct { \ idx = (elem)->field.next, (elem) = \ (idx) ? mlx5_ipool_get(pool, idx) : NULL) +#define MLX5_L3T_FOREACH(tbl, idx, entry) \ + for (idx = 0, (entry) = mlx5_l3t_get_next((tbl), &idx); \ + (entry); \ + idx++, (entry) = mlx5_l3t_get_next((tbl), &idx)) + #endif /* RTE_PMD_MLX5_UTILS_H_ */