From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-13.0 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 7AC2CC433E8 for ; Mon, 13 Jul 2020 15:51:34 +0000 (UTC) Received: from dpdk.org (dpdk.org [92.243.14.124]) by mail.kernel.org (Postfix) with ESMTP id 1B05020663 for ; Mon, 13 Jul 2020 15:51:33 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 1B05020663 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=intel.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=dev-bounces@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 62C7D1D8FC; Mon, 13 Jul 2020 17:51:33 +0200 (CEST) Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by dpdk.org (Postfix) with ESMTP id B94111D8D8 for ; Mon, 13 Jul 2020 17:51:30 +0200 (CEST) IronPort-SDR: S8h9IGibwCv52RXhvepDuyc9ZE+P0LzSSVAib1pUiCV5xbwp/HMAH3D8mdOdKIujjekr/TzQ9q 7xERRD41CxBg== X-IronPort-AV: E=McAfee;i="6000,8403,9681"; a="150095493" X-IronPort-AV: E=Sophos;i="5.75,347,1589266800"; d="scan'208";a="150095493" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga005.jf.intel.com ([10.7.209.41]) by orsmga102.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 13 Jul 2020 08:51:29 -0700 IronPort-SDR: n4f6l0w06Ku7Os9DjeYZuQ11LHapMF4tr8FzjqmQkGX2go210DS8Qi754lfnILb9JLCRmZFQdx UKg7Svnwp0Sg== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.75,347,1589266800"; d="scan'208";a="459340476" Received: from sivswdev08.ir.intel.com ([10.237.217.47]) by orsmga005.jf.intel.com with ESMTP; 13 Jul 2020 08:51:27 -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: Mon, 13 Jul 2020 16:50:49 +0100 Message-Id: <20200713155050.27743-2-konstantin.ananyev@intel.com> X-Mailer: git-send-email 2.18.0 In-Reply-To: <20200713155050.27743-1-konstantin.ananyev@intel.com> References: <20200710162119.27653-1-konstantin.ananyev@intel.com> <20200713155050.27743-1-konstantin.ananyev@intel.com> Subject: [dpdk-dev] [PATCH v4 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