From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 1745CA0547; Wed, 15 Jul 2020 16:58:38 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id E2B341BEA1; Wed, 15 Jul 2020 16:58:37 +0200 (CEST) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by dpdk.org (Postfix) with ESMTP id 95E452B9A for ; Wed, 15 Jul 2020 16:58:36 +0200 (CEST) IronPort-SDR: 2dXrRNt8lemUm8eCfVlmqRrGxvw2Usqyk1zDmzm7/Pg5QJDmiRnk/MLhi3EyjgEANyA32mAtgS dI5Be6qw2bHw== X-IronPort-AV: E=McAfee;i="6000,8403,9683"; a="146669937" X-IronPort-AV: E=Sophos;i="5.75,355,1589266800"; d="scan'208";a="146669937" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 15 Jul 2020 07:58:35 -0700 IronPort-SDR: pbWdEqcOBFx4rTj0tz+iB1y3UmeK3qxO06gbrchSMd0LKnD95O6kbUYTJgYmxlOD0YtZ+ORf2Q RpCwK9xqwZCg== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.75,355,1589266800"; d="scan'208";a="270291162" Received: from sivswdev08.ir.intel.com ([10.237.217.47]) by fmsmga008.fm.intel.com with ESMTP; 15 Jul 2020 07:58:33 -0700 From: Konstantin Ananyev 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 Date: Wed, 15 Jul 2020 15:58:14 +0100 Message-Id: <20200715145815.27132-2-konstantin.ananyev@intel.com> X-Mailer: git-send-email 2.18.0 In-Reply-To: <20200715145815.27132-1-konstantin.ananyev@intel.com> References: <20200713155050.27743-1-konstantin.ananyev@intel.com> <20200715145815.27132-1-konstantin.ananyev@intel.com> Subject: [dpdk-dev] [PATCH v5 1/2] doc: add ring based mempool guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Add documentation for rte_ring mempool driver. Signed-off-by: Konstantin Ananyev --- 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