a22ca80672adebc20cba583410eba0a219d32ddd
[dpdk.git] / doc / guides / mempool / ring.rst
1 ..  SPDX-License-Identifier: BSD-3-Clause
2     Copyright(c) 2020 Intel Corporation.
3
4 Ring Mempool Driver
5 ===================
6
7 **rte_mempool_ring** is a pure software mempool driver based on the
8 ``rte_ring`` DPDK library. This is a default mempool driver.
9 The following modes of operation are available for the ring mempool driver
10 and can be selected via mempool ops API:
11
12 - ``ring_mp_mc``
13
14   The underlying **rte_ring** operates in multi-thread producer,
15   multi-thread consumer sync mode.
16
17 - ``ring_sp_sc``
18
19   The underlying **rte_ring** operates in single-thread producer,
20   single-thread consumer sync mode.
21
22 - ``ring_sp_mc``
23
24   The underlying **rte_ring** operates in single-thread producer,
25   multi-thread consumer sync mode.
26
27 - ``ring_mp_sc``
28
29   The underlying **rte_ring** operates in multi-thread producer,
30   single-thread consumer sync mode.
31
32
33 For more information about ``rte_ring`` structure, behaviour and available
34 synchronisation modes please refer to: :doc:`../prog_guide/ring_lib`.