X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=lib%2Flibrte_mempool%2Frte_mempool.h;h=6e2390a1c8b5d9b12314172eb9cf112faea3a6bd;hb=87ea2524210120225c4e38456880bcdd951877f8;hp=ec1bb2e23c6472198b3d31f908d89f12bfacd621;hpb=97e7e685bfcd37dba04b84f07aaa5a815d32733c;p=dpdk.git diff --git a/lib/librte_mempool/rte_mempool.h b/lib/librte_mempool/rte_mempool.h index ec1bb2e23c..6e2390a1c8 100644 --- a/lib/librte_mempool/rte_mempool.h +++ b/lib/librte_mempool/rte_mempool.h @@ -109,6 +109,9 @@ struct rte_mempool_cache { } __rte_cache_aligned; #endif /* RTE_MEMPOOL_CACHE_MAX_SIZE > 0 */ +/** + * A structure that stores the size of mempool elements. + */ struct rte_mempool_objsz { uint32_t elt_size; /**< Size of an element. */ uint32_t header_size; /**< Size of header (before elt). */ @@ -139,6 +142,12 @@ struct rte_mempool_objsz { /** Mempool over one chunk of physically continuous memory */ #define MEMPOOL_PG_NUM_DEFAULT 1 +#ifndef RTE_MEMPOOL_ALIGN +#define RTE_MEMPOOL_ALIGN RTE_CACHE_LINE_SIZE +#endif + +#define RTE_MEMPOOL_ALIGN_MASK (RTE_MEMPOOL_ALIGN - 1) + /** * Mempool object header structure * @@ -206,7 +215,7 @@ struct rte_mempool { uintptr_t elt_va_end; /**< Virtual address of the mempool object. */ phys_addr_t elt_pa[MEMPOOL_PG_NUM_DEFAULT]; - /**< Array of physical pages addresses for the mempool objects buffer. */ + /**< Array of physical page addresses for the mempool objects buffer. */ } __rte_cache_aligned; @@ -217,6 +226,7 @@ struct rte_mempool { /** * @internal When debug is enabled, store some statistics. + * * @param mp * Pointer to the memory pool. * @param name @@ -237,18 +247,19 @@ struct rte_mempool { #endif /** - * Calculates size of the mempool header. + * Calculate the size of the mempool header. + * * @param mp * Pointer to the memory pool. * @param pgn - * Number of page used to store mempool objects. + * Number of pages used to store mempool objects. */ #define MEMPOOL_HEADER_SIZE(mp, pgn) (sizeof(*(mp)) + \ RTE_ALIGN_CEIL(((pgn) - RTE_DIM((mp)->elt_pa)) * \ sizeof ((mp)->elt_pa[0]), RTE_CACHE_LINE_SIZE)) /** - * Returns TRUE if whole mempool is allocated in one contiguous block of memory. + * Return true if the whole mempool is in contiguous memory. */ #define MEMPOOL_IS_CONTIG(mp) \ ((mp)->pg_num == MEMPOOL_PG_NUM_DEFAULT && \ @@ -257,15 +268,7 @@ struct rte_mempool { /* return the header of a mempool object (internal) */ static inline struct rte_mempool_objhdr *__mempool_get_header(void *obj) { - return (struct rte_mempool_objhdr *)((char *)obj - - sizeof(struct rte_mempool_objhdr)); -} - -/* return the trailer of a mempool object (internal) */ -static inline struct rte_mempool_objtlr *__mempool_get_trailer(void *obj) -{ - return (struct rte_mempool_objtlr *)((char *)obj - - sizeof(struct rte_mempool_objtlr)); + return (struct rte_mempool_objhdr *)RTE_PTR_SUB(obj, sizeof(struct rte_mempool_objhdr)); } /** @@ -283,6 +286,13 @@ static inline struct rte_mempool *rte_mempool_from_obj(void *obj) return hdr->mp; } +/* return the trailer of a mempool object (internal) */ +static inline struct rte_mempool_objtlr *__mempool_get_trailer(void *obj) +{ + struct rte_mempool *mp = rte_mempool_from_obj(obj); + return (struct rte_mempool_objtlr *)RTE_PTR_ADD(obj, mp->elt_size); +} + /** * @internal Check and update cookies or panic. * @@ -376,29 +386,35 @@ static inline void __mempool_check_cookies(const struct rte_mempool *mp, #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */ /** - * An mempool's object iterator callback function. + * A mempool object iterator callback function. */ typedef void (*rte_mempool_obj_iter_t)(void * /*obj_iter_arg*/, void * /*obj_start*/, void * /*obj_end*/, uint32_t /*obj_index */); -/* - * Iterates across objects of the given size and alignment in the +/** + * Call a function for each mempool object in a memory chunk + * + * Iterate across objects of the given size and alignment in the * provided chunk of memory. The given memory buffer can consist of - * disjoint physical pages. - * For each object calls the provided callback (if any). - * Used to populate mempool, walk through all elements of the mempool, - * estimate how many elements of the given size could be created in the given - * memory buffer. + * disjointed physical pages. + * + * For each object, call the provided callback (if any). This function + * is used to populate a mempool, or walk through all the elements of a + * mempool, or estimate how many elements of the given size could be + * created in the given memory buffer. + * * @param vaddr * Virtual address of the memory buffer. * @param elt_num * Maximum number of objects to iterate through. * @param elt_sz * Size of each object. + * @param align + * Alignment of each object. * @param paddr - * Array of phyiscall addresses of the pages that comprises given memory + * Array of physical addresses of the pages that comprises given memory * buffer. * @param pg_num * Number of elements in the paddr array. @@ -407,12 +423,11 @@ typedef void (*rte_mempool_obj_iter_t)(void * /*obj_iter_arg*/, * @param obj_iter * Object iterator callback function (could be NULL). * @param obj_iter_arg - * User defined Prameter for the object iterator callback function. + * User defined parameter for the object iterator callback function. * * @return * Number of objects iterated through. */ - uint32_t rte_mempool_obj_iter(void *vaddr, uint32_t elt_num, size_t elt_sz, size_t align, const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift, @@ -437,7 +452,7 @@ typedef void (rte_mempool_obj_ctor_t)(struct rte_mempool *, void *, typedef void (rte_mempool_ctor_t)(struct rte_mempool *, void *); /** - * Creates a new mempool named *name* in memory. + * Create a new mempool named *name* in memory. * * This function uses ``memzone_reserve()`` to allocate memory. The * pool contains n elements of elt_size. Its size is set to n. @@ -525,14 +540,14 @@ rte_mempool_create(const char *name, unsigned n, unsigned elt_size, int socket_id, unsigned flags); /** - * Creates a new mempool named *name* in memory. + * Create a new mempool named *name* in memory. * * This function uses ``memzone_reserve()`` to allocate memory. The * pool contains n elements of elt_size. Its size is set to n. * Depending on the input parameters, mempool elements can be either allocated * together with the mempool header, or an externally provided memory buffer * could be used to store mempool objects. In later case, that external - * memory buffer can consist of set of disjoint phyiscal pages. + * memory buffer can consist of set of disjoint physical pages. * * @param name * The name of the mempool. @@ -601,7 +616,7 @@ rte_mempool_create(const char *name, unsigned n, unsigned elt_size, * Virtual address of the externally allocated memory buffer. * Will be used to store mempool objects. * @param paddr - * Array of phyiscall addresses of the pages that comprises given memory + * Array of physical addresses of the pages that comprises given memory * buffer. * @param pg_num * Number of elements in the paddr array. @@ -625,14 +640,13 @@ rte_mempool_xmem_create(const char *name, unsigned n, unsigned elt_size, int socket_id, unsigned flags, void *vaddr, const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift); -#ifdef RTE_LIBRTE_XEN_DOM0 /** - * Creates a new mempool named *name* in memory on Xen Dom0. + * Create a new mempool named *name* in memory on Xen Dom0. * * This function uses ``rte_mempool_xmem_create()`` to allocate memory. The * pool contains n elements of elt_size. Its size is set to n. * All elements of the mempool are allocated together with the mempool header, - * and memory buffer can consist of set of disjoint phyiscal pages. + * and memory buffer can consist of set of disjoint physical pages. * * @param name * The name of the mempool. @@ -713,7 +727,7 @@ rte_dom0_mempool_create(const char *name, unsigned n, unsigned elt_size, rte_mempool_ctor_t *mp_init, void *mp_init_arg, rte_mempool_obj_ctor_t *obj_init, void *obj_init_arg, int socket_id, unsigned flags); -#endif + /** * Dump the status of the mempool to the console. @@ -1305,8 +1319,11 @@ void rte_mempool_list_dump(FILE *f); struct rte_mempool *rte_mempool_lookup(const char *name); /** + * Get the header, trailer and total size of a mempool element. + * * Given a desired size of the mempool element and mempool flags, - * caluclates header, trailer, body and total sizes of the mempool object. + * calculates header, trailer, body and total sizes of the mempool object. + * * @param elt_size * The size of each element. * @param flags @@ -1322,11 +1339,16 @@ uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags, struct rte_mempool_objsz *sz); /** - * Calculate maximum amount of memory required to store given number of objects. - * Assumes that the memory buffer will be aligned at page boundary. - * Note, that if object size is bigger then page size, then it assumes that - * we have a subsets of physically continuous pages big enough to store - * at least one object. + * Get the size of memory required to store mempool elements. + * + * Calculate the maximum amount of memory required to store given number + * of objects. Assume that the memory buffer will be aligned at page + * boundary. + * + * Note that if object size is bigger then page size, then it assumes + * that pages are grouped in subsets of physically continuous pages big + * enough to store at least one object. + * * @param elt_num * Number of elements. * @param elt_sz @@ -1340,8 +1362,11 @@ size_t rte_mempool_xmem_size(uint32_t elt_num, size_t elt_sz, uint32_t pg_shift); /** + * Get the size of memory required to store mempool elements. + * * Calculate how much memory would be actually required with the given * memory footprint to store required number of objects. + * * @param vaddr * Virtual address of the externally allocated memory buffer. * Will be used to store mempool objects. @@ -1350,17 +1375,17 @@ size_t rte_mempool_xmem_size(uint32_t elt_num, size_t elt_sz, * @param elt_sz * The size of each element. * @param paddr - * Array of phyiscall addresses of the pages that comprises given memory + * Array of physical addresses of the pages that comprises given memory * buffer. * @param pg_num * Number of elements in the paddr array. * @param pg_shift * LOG2 of the physical pages size. * @return - * Number of bytes needed to store given number of objects, - * aligned to the given page size. - * If provided memory buffer is not big enough: - * (-1) * actual number of elemnts that can be stored in that buffer. + * On success, the number of bytes needed to store given number of + * objects, aligned to the given page size. If the provided memory + * buffer is too small, return a negative value whose absolute value + * is the actual number of elements that can be stored in that buffer. */ ssize_t rte_mempool_xmem_usage(void *vaddr, uint32_t elt_num, size_t elt_sz, const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift);