From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wi0-f175.google.com (mail-wi0-f175.google.com [209.85.212.175]) by dpdk.org (Postfix) with ESMTP id 49C3AADA2 for ; Mon, 1 Jun 2015 11:15:57 +0200 (CEST) Received: by wibdq8 with SMTP id dq8so22698848wib.1 for ; Mon, 01 Jun 2015 02:15:57 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references; bh=EPA1kNlZdbzsyKZu1Dmp1rQbjXhpjSKU/0+ZfJ6eahE=; b=Gnv6UIyTVNCapg5WW1yU5v+JIthk7qoOut9ndDaOFD8e4daev7frrfo5cmOFBKLtEJ hQCi87WX/x+yq4iyWoYQ6ChflrNsCYs3G5kYrI1RH88EbgAMBxijJcGl4VoWOZ+6thiQ yv2LbgkBOqgRcJTWrBLtJOJvrsBek882BqPQHscDXrHtzD7f3IpNmr2ayM5tlPPOi0E/ W7YW6CXH+0jIBaLUrhmn/dO1ISGJw9m26b7bXqNAwHDTV1q9iO0I2CJsYicInwJmB/8B vPVQmEOg1cmauCr0T3J5rzNIBq2hph1UDC2/bA0SvSwTS1f7Ic70cM5PwpD0brVwBx+5 Olsw== X-Gm-Message-State: ALoCoQkX7Th/5csVfboPjMzW07KPL8NbKfzVLw2JH9v1cMY3UzPbPnAivyDmArqJgTYI/5fgP1dk X-Received: by 10.194.238.193 with SMTP id vm1mr39410635wjc.57.1433150157125; Mon, 01 Jun 2015 02:15:57 -0700 (PDT) Received: from glumotte.dev.6wind.com (guy78-3-82-239-227-177.fbx.proxad.net. [82.239.227.177]) by mx.google.com with ESMTPSA id k2sm15690031wix.4.2015.06.01.02.15.56 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 01 Jun 2015 02:15:56 -0700 (PDT) From: Olivier Matz To: dev@dpdk.org Date: Mon, 1 Jun 2015 11:15:43 +0200 Message-Id: <1433150143-5842-4-git-send-email-olivier.matz@6wind.com> X-Mailer: git-send-email 2.1.4 In-Reply-To: <1433150143-5842-1-git-send-email-olivier.matz@6wind.com> References: <1433150143-5842-1-git-send-email-olivier.matz@6wind.com> Subject: [dpdk-dev] [PATCH 3/3] mempool: fix typos, indentation, and doxygen style X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 01 Jun 2015 09:15:57 -0000 Do some cosmetic clean-up. Signed-off-by: Olivier Matz --- lib/librte_mempool/rte_dom0_mempool.c | 36 ++++++++-------- lib/librte_mempool/rte_mempool.c | 10 ++--- lib/librte_mempool/rte_mempool.h | 80 ++++++++++++++++++++++------------- 3 files changed, 73 insertions(+), 53 deletions(-) diff --git a/lib/librte_mempool/rte_dom0_mempool.c b/lib/librte_mempool/rte_dom0_mempool.c index 8900171..a313b3f 100644 --- a/lib/librte_mempool/rte_dom0_mempool.c +++ b/lib/librte_mempool/rte_dom0_mempool.c @@ -61,30 +61,30 @@ static void get_phys_map(void *va, phys_addr_t pa[], uint32_t pg_num, - uint32_t pg_sz, uint32_t memseg_id) + uint32_t pg_sz, uint32_t memseg_id) { - uint32_t i; - uint64_t virt_addr, mfn_id; - struct rte_mem_config *mcfg; - uint32_t page_size = getpagesize(); - - /* get pointer to global configuration */ - mcfg = rte_eal_get_configuration()->mem_config; - virt_addr =(uintptr_t) mcfg->memseg[memseg_id].addr; - - for (i = 0; i != pg_num; i++) { - mfn_id = ((uintptr_t)va + i * pg_sz - virt_addr) / RTE_PGSIZE_2M; - pa[i] = mcfg->memseg[memseg_id].mfn[mfn_id] * page_size; - } + uint32_t i; + uint64_t virt_addr, mfn_id; + struct rte_mem_config *mcfg; + uint32_t page_size = getpagesize(); + + /* get pointer to global configuration */ + mcfg = rte_eal_get_configuration()->mem_config; + virt_addr =(uintptr_t) mcfg->memseg[memseg_id].addr; + + for (i = 0; i != pg_num; i++) { + mfn_id = ((uintptr_t)va + i * pg_sz - virt_addr) / RTE_PGSIZE_2M; + pa[i] = mcfg->memseg[memseg_id].mfn[mfn_id] * page_size; + } } /* create the mempool for supporting Dom0 */ struct rte_mempool * rte_dom0_mempool_create(const char *name, unsigned elt_num, unsigned elt_size, - unsigned cache_size, unsigned private_data_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) + unsigned cache_size, unsigned private_data_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) { struct rte_mempool *mp = NULL; phys_addr_t *pa; diff --git a/lib/librte_mempool/rte_mempool.c b/lib/librte_mempool/rte_mempool.c index 60369cf..f592dc7 100644 --- a/lib/librte_mempool/rte_mempool.c +++ b/lib/librte_mempool/rte_mempool.c @@ -347,9 +347,9 @@ rte_mempool_xmem_size(uint32_t elt_num, size_t elt_sz, uint32_t pg_shift) */ static void mempool_lelem_iter(void *arg, __rte_unused void *start, void *end, - __rte_unused uint32_t idx) + __rte_unused uint32_t idx) { - *(uintptr_t *)arg = (uintptr_t)end; + *(uintptr_t *)arg = (uintptr_t)end; } ssize_t @@ -521,8 +521,8 @@ rte_mempool_xmem_create(const char *name, unsigned n, unsigned elt_size, /* * If user provided an external memory buffer, then use it to - * store mempool objects. Otherwise reserve memzone big enough to - * hold mempool header and metadata plus mempool objects. + * store mempool objects. Otherwise reserve a memzone that is large + * enough to hold mempool header and metadata plus mempool objects. */ mempool_size = MEMPOOL_HEADER_SIZE(mp, pg_num) + private_data_size; if (vaddr == NULL) @@ -543,7 +543,7 @@ rte_mempool_xmem_create(const char *name, unsigned n, unsigned elt_size, /* * no more memory: in this case we loose previously reserved - * space for the as we cannot free it + * space for the ring as we cannot free it */ if (mz == NULL) { rte_free(te); diff --git a/lib/librte_mempool/rte_mempool.h b/lib/librte_mempool/rte_mempool.h index cdb8f67..649c27d 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). */ @@ -206,7 +209,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 +220,7 @@ struct rte_mempool { /** * @internal When debug is enabled, store some statistics. + * * @param mp * Pointer to the memory pool. * @param name @@ -237,18 +241,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 && \ @@ -376,21 +381,25 @@ 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. + * + * For each object, calls the provided callback (if any). This function + * is 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. + * * @param vaddr * Virtual address of the memory buffer. * @param elt_num @@ -398,7 +407,7 @@ typedef void (*rte_mempool_obj_iter_t)(void * /*obj_iter_arg*/, * @param elt_sz * Size 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,7 +416,7 @@ 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. @@ -437,7 +446,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 +534,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 +610,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. @@ -627,12 +636,12 @@ rte_mempool_xmem_create(const char *name, unsigned n, unsigned elt_size, #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. @@ -1305,8 +1314,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 @@ -1320,11 +1332,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 @@ -1338,8 +1355,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. @@ -1348,17 +1368,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); -- 2.1.4