diff mbox

[dpdk-dev,v4] mempool: update non-EAL thread note in the header

Message ID 1490914920-26347-1-git-send-email-gage.eads@intel.com (mailing list archive)
State Accepted, archived
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Eads, Gage March 30, 2017, 11:02 p.m. UTC 
  Commit 30e6399892276 ("mempool: support non-EAL thread") added the
capability for non-EAL threads to use the mempool library. This commit
removes the note indicating that the mempool library cannot be used safely
by non-EAL threads, and replaces it with a more up-to-date note.

Signed-off-by: Gage Eads <gage.eads@intel.com>
---
v2: Changed commit message to referenced commit 30e63998 instead of 4b5062755
v3: Fix checkpatch error
v4: Rework note to highlight non-EAL thread differences

 lib/librte_mempool/rte_mempool.h | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

Comments

Olivier Matz March 31, 2017, 1:51 p.m. UTC | #1 
On Thu, 30 Mar 2017 18:02:00 -0500, Gage Eads <gage.eads@intel.com> wrote:
> Commit 30e6399892276 ("mempool: support non-EAL thread") added the
> capability for non-EAL threads to use the mempool library. This commit
> removes the note indicating that the mempool library cannot be used safely
> by non-EAL threads, and replaces it with a more up-to-date note.
> 
> Signed-off-by: Gage Eads <gage.eads@intel.com>

Acked-by: Olivier Matz <olivier.matz@6wind.com>
Thomas Monjalon April 3, 2017, 4:32 p.m. UTC | #2 
2017-03-31 15:51, Olivier Matz:
> On Thu, 30 Mar 2017 18:02:00 -0500, Gage Eads <gage.eads@intel.com> wrote:
> > Commit 30e6399892276 ("mempool: support non-EAL thread") added the
> > capability for non-EAL threads to use the mempool library. This commit
> > removes the note indicating that the mempool library cannot be used safely
> > by non-EAL threads, and replaces it with a more up-to-date note.
> > 
> > Signed-off-by: Gage Eads <gage.eads@intel.com>
> 
> Acked-by: Olivier Matz <olivier.matz@6wind.com>

Applied, thanks
diff mbox

Patch

diff --git a/lib/librte_mempool/rte_mempool.h b/lib/librte_mempool/rte_mempool.h
index 991feaa..931faf3 100644
--- a/lib/librte_mempool/rte_mempool.h
+++ b/lib/librte_mempool/rte_mempool.h
@@ -51,13 +51,15 @@ 
  * meta-data in the object data and retrieve them when allocating a
  * new object.
  *
- * Note: the mempool implementation is not preemptable. A lcore must
- * not be interrupted by another task that uses the same mempool
- * (because it uses a ring which is not preemptable). Also, mempool
- * functions must not be used outside the DPDK environment: for
- * example, in linuxapp environment, a thread that is not created by
- * the EAL must not use mempools. This is due to the per-lcore cache
- * that won't work as rte_lcore_id() will not return a correct value.
+ * Note: the mempool implementation is not preemptible. An lcore must not be
+ * interrupted by another task that uses the same mempool (because it uses a
+ * ring which is not preemptible). Also, usual mempool functions like
+ * rte_mempool_get() or rte_mempool_put() are designed to be called from an EAL
+ * thread due to the internal per-lcore cache. Due to the lack of caching,
+ * rte_mempool_get() or rte_mempool_put() performance will suffer when called
+ * by non-EAL threads. Instead, non-EAL threads should call
+ * rte_mempool_generic_get() or rte_mempool_generic_put() with a user cache
+ * created with rte_mempool_cache_create().
  */
 
 #include <stdio.h>