DPDK patches and discussions
 help / color / mirror / Atom feed
From: Konstantin Ananyev <konstantin.ananyev@intel.com>
To: dev@dpdk.org
Cc: olivier.matz@6wind.com, arybchenko@solarflare.com,
	jielong.zjl@antfin.com, gage.eads@intel.com, thomas@monjalon.net,
	Konstantin Ananyev <konstantin.ananyev@intel.com>
Subject: [dpdk-dev] [PATCH v5 1/2] doc: add ring based mempool guide
Date: Wed, 15 Jul 2020 15:58:14 +0100	[thread overview]
Message-ID: <20200715145815.27132-2-konstantin.ananyev@intel.com> (raw)
In-Reply-To: <20200715145815.27132-1-konstantin.ananyev@intel.com>

Add documentation for rte_ring mempool driver.

Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
---
 doc/guides/mempool/index.rst |  1 +
 doc/guides/mempool/ring.rst  | 34 ++++++++++++++++++++++++++++++++++
 2 files changed, 35 insertions(+)
 create mode 100644 doc/guides/mempool/ring.rst

diff --git a/doc/guides/mempool/index.rst b/doc/guides/mempool/index.rst
index 756610264..bbd02fd81 100644
--- a/doc/guides/mempool/index.rst
+++ b/doc/guides/mempool/index.rst
@@ -13,3 +13,4 @@ application through the mempool API.
 
     octeontx
     octeontx2
+    ring
diff --git a/doc/guides/mempool/ring.rst b/doc/guides/mempool/ring.rst
new file mode 100644
index 000000000..b8659c03f
--- /dev/null
+++ b/doc/guides/mempool/ring.rst
@@ -0,0 +1,34 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2020 Intel Corporation.
+
+Ring Mempool Driver
+==============================
+
+**rte_mempool_ring** is a pure SW mempool driver based on ``rte_ring``
+DPDK library. This is a default mempool driver.
+Following modes of operation are available for ``ring`` mempool driver
+and can be selected via mempool ops API:
+
+- ``ring_mp_mc``
+
+  Underlying **rte_ring** operates in multi-thread producer,
+  multi-thread consumer sync mode.
+
+- ``ring_sp_sc``
+
+  Underlying **rte_ring** operates in single-thread producer,
+  single-thread consumer sync mode.
+
+- ``ring_sp_mc``
+
+  Underlying **rte_ring** operates in single-thread producer,
+  multi-thread consumer sync mode.
+
+- ``ring_mp_sc``
+
+  Underlying **rte_ring** operates in multi-thread producer,
+  single-thread consumer sync mode.
+
+
+For more information about ``rte_ring`` structure, behaviour and available
+synchronisation modes please refer to: :doc:`../prog_guide/ring_lib`.
-- 
2.17.1


  reply	other threads:[~2020-07-15 14:58 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-05-21 13:20 [dpdk-dev] [PATCH 20.08] mempool/ring: add support for new ring sync modes Konstantin Ananyev
2020-06-29 16:10 ` [dpdk-dev] [PATCH v2] " Konstantin Ananyev
2020-07-09 16:18   ` Olivier Matz
2020-07-09 17:55     ` Ananyev, Konstantin
2020-07-10 12:52       ` Olivier Matz
2020-07-10 15:15         ` Ananyev, Konstantin
2020-07-10 15:20           ` Ananyev, Konstantin
2020-07-13 13:30             ` Olivier Matz
2020-07-13 14:46               ` Ananyev, Konstantin
2020-07-13 15:00                 ` Olivier Matz
2020-07-13 16:29                   ` Ananyev, Konstantin
2020-07-10 16:21   ` [dpdk-dev] [PATCH v3] " Konstantin Ananyev
2020-07-10 22:44     ` Thomas Monjalon
2020-07-13 12:58       ` Ananyev, Konstantin
2020-07-13 13:57         ` Thomas Monjalon
2020-07-13 15:50     ` [dpdk-dev] [PATCH v4 0/2] " Konstantin Ananyev
2020-07-13 15:50       ` [dpdk-dev] [PATCH v4 1/2] doc: add ring based mempool guide Konstantin Ananyev
2020-07-13 15:50       ` [dpdk-dev] [PATCH v4 2/2] mempool/ring: add support for new ring sync modes Konstantin Ananyev
2020-07-13 17:37         ` Thomas Monjalon
2020-07-14  9:16           ` Ananyev, Konstantin
2020-07-15  9:59             ` Thomas Monjalon
2020-07-15 14:58       ` [dpdk-dev] [PATCH v5 0/2] " Konstantin Ananyev
2020-07-15 14:58         ` Konstantin Ananyev [this message]
2020-07-15 14:58         ` [dpdk-dev] [PATCH v5 2/2] " Konstantin Ananyev
2020-07-21 17:25           ` David Marchand

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200715145815.27132-2-konstantin.ananyev@intel.com \
    --to=konstantin.ananyev@intel.com \
    --cc=arybchenko@solarflare.com \
    --cc=dev@dpdk.org \
    --cc=gage.eads@intel.com \
    --cc=jielong.zjl@antfin.com \
    --cc=olivier.matz@6wind.com \
    --cc=thomas@monjalon.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).