DPDK patches and discussions
 help / color / mirror / Atom feed
From: Chengwen Feng <fengchengwen@huawei.com>
To: <thomas@monjalon.net>, <david.marchand@redhat.com>
Cc: <dev@dpdk.org>, <mb@smartsharesystems.com>,
	<anatoly.burakov@intel.com>, <dmitry.kozliuk@gmail.com>,
	<jerinjacobk@gmail.com>, <hofors@lysator.liu.se>,
	 <stephen@networkplumber.org>
Subject: [PATCH v17 1/6] memarea: introduce memarea library
Date: Tue, 18 Jul 2023 02:40:01 +0000	[thread overview]
Message-ID: <20230718024006.2154-2-fengchengwen@huawei.com> (raw)
In-Reply-To: <20230718024006.2154-1-fengchengwen@huawei.com>

The memarea library is an allocator of variable-size object which based
on a memory region.

This patch provides rte_memarea_create() and rte_memarea_destroy() API.

Signed-off-by: Chengwen Feng <fengchengwen@huawei.com>
Reviewed-by: Dongdong Liu <liudongdong3@huawei.com>
Acked-by: Morten Brørup <mb@smartsharesystems.com>
Acked-by: Anatoly Burakov <anatoly.burakov@intel.com>
---
 MAINTAINERS                            |   5 +
 doc/api/doxy-api-index.md              |   3 +-
 doc/api/doxy-api.conf.in               |   1 +
 doc/guides/prog_guide/index.rst        |   1 +
 doc/guides/prog_guide/memarea_lib.rst  |  48 ++++++
 doc/guides/rel_notes/release_23_07.rst |   6 +
 lib/memarea/memarea_private.h          | 116 ++++++++++++++
 lib/memarea/meson.build                |  12 ++
 lib/memarea/rte_memarea.c              | 208 +++++++++++++++++++++++++
 lib/memarea/rte_memarea.h              | 141 +++++++++++++++++
 lib/memarea/version.map                |  12 ++
 lib/meson.build                        |   1 +
 12 files changed, 553 insertions(+), 1 deletion(-)
 create mode 100644 doc/guides/prog_guide/memarea_lib.rst
 create mode 100644 lib/memarea/memarea_private.h
 create mode 100644 lib/memarea/meson.build
 create mode 100644 lib/memarea/rte_memarea.c
 create mode 100644 lib/memarea/rte_memarea.h
 create mode 100644 lib/memarea/version.map

diff --git a/MAINTAINERS b/MAINTAINERS
index 5bb8090ebe..9ca665219b 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1613,6 +1613,11 @@ F: app/test/test_lpm*
 F: app/test/test_func_reentrancy.c
 F: app/test/test_xmmt_ops.h
 
+Memarea - EXPERIMENTAL
+M: Chengwen Feng <fengchengwen@huawei.com>
+F: lib/memarea
+F: doc/guides/prog_guide/memarea_lib.rst
+
 Membership - EXPERIMENTAL
 M: Yipeng Wang <yipeng1.wang@intel.com>
 M: Sameh Gobriel <sameh.gobriel@intel.com>
diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index 3bc8778981..5c32913f92 100644
--- a/doc/api/doxy-api-index.md
+++ b/doc/api/doxy-api-index.md
@@ -65,7 +65,8 @@ The public API headers are grouped by topics:
   [memzone](@ref rte_memzone.h),
   [mempool](@ref rte_mempool.h),
   [malloc](@ref rte_malloc.h),
-  [memcpy](@ref rte_memcpy.h)
+  [memcpy](@ref rte_memcpy.h),
+  [memarea](@ref rte_memarea.h)
 
 - **timers**:
   [cycles](@ref rte_cycles.h),
diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in
index 1a4210b948..1f35d8483e 100644
--- a/doc/api/doxy-api.conf.in
+++ b/doc/api/doxy-api.conf.in
@@ -54,6 +54,7 @@ INPUT                   = @TOPDIR@/doc/api/doxy-api-index.md \
                           @TOPDIR@/lib/latencystats \
                           @TOPDIR@/lib/lpm \
                           @TOPDIR@/lib/mbuf \
+                          @TOPDIR@/lib/memarea \
                           @TOPDIR@/lib/member \
                           @TOPDIR@/lib/mempool \
                           @TOPDIR@/lib/meter \
diff --git a/doc/guides/prog_guide/index.rst b/doc/guides/prog_guide/index.rst
index d89cd3edb6..aa8eebe256 100644
--- a/doc/guides/prog_guide/index.rst
+++ b/doc/guides/prog_guide/index.rst
@@ -38,6 +38,7 @@ Programmer's Guide
     hash_lib
     toeplitz_hash_lib
     efd_lib
+    memarea_lib
     member_lib
     lpm_lib
     lpm6_lib
diff --git a/doc/guides/prog_guide/memarea_lib.rst b/doc/guides/prog_guide/memarea_lib.rst
new file mode 100644
index 0000000000..bf19090294
--- /dev/null
+++ b/doc/guides/prog_guide/memarea_lib.rst
@@ -0,0 +1,48 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2023 HiSilicon Limited
+
+Memarea Library
+===============
+
+Introduction
+------------
+
+The memarea library provides an allocator of variable-size objects, it is
+oriented towards the application layer, providing 'region-based memory
+management' function [1].
+
+The main features are as follows:
+
+* The memory region can be initialized from the following memory sources:
+
+  - HEAP: e.g. invoke ``rte_malloc_socket``.
+
+  - LIBC: e.g. invoke posix_memalign.
+
+  - Another memarea: it can be allocated from another memarea.
+
+* It supports MT-safe as long as it's specified at creation time.
+
+* The address returned by the allocator is align to 8B.
+
+Library API Overview
+--------------------
+
+The ``rte_memarea_create()`` function is used to create a memarea, the function
+returns the pointer to the created memarea or ``NULL`` if the creation failed.
+
+The ``rte_memarea_destroy()`` function is used to destroy a memarea.
+
+Debug Mode
+----------
+
+In debug mode, cookies are added at the beginning and end of objects, it will
+help debugging buffer overflows.
+
+Debug mode is disabled by default, but can be enabled by setting
+``RTE_LIBRTE_MEMAREA_DEBUG`` in ``config/rte_config.h``.
+
+Reference
+---------
+
+[1] https://en.wikipedia.org/wiki/Region-based_memory_management
diff --git a/doc/guides/rel_notes/release_23_07.rst b/doc/guides/rel_notes/release_23_07.rst
index d4af85b3ff..4034a9e9c0 100644
--- a/doc/guides/rel_notes/release_23_07.rst
+++ b/doc/guides/rel_notes/release_23_07.rst
@@ -222,6 +222,12 @@ New Features
 
   See the :doc:`../tools/dmaperf` for more details.
 
+* **Added memarea library.**
+
+  The memarea library is an allocator of variable-size objects, it is oriented
+  towards the application layer, providing 'region-based memory management'
+  function.
+
 
 Removed Items
 -------------
diff --git a/lib/memarea/memarea_private.h b/lib/memarea/memarea_private.h
new file mode 100644
index 0000000000..fd485bb7e7
--- /dev/null
+++ b/lib/memarea/memarea_private.h
@@ -0,0 +1,116 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2023 HiSilicon Limited
+ */
+
+#ifndef MEMAREA_PRIVATE_H
+#define MEMAREA_PRIVATE_H
+
+#include <rte_memarea.h>
+
+#define MEMAREA_MINIMUM_TOTAL_SIZE	1024
+
+#define MEMAREA_OBJECT_SIZE_ALIGN	8
+
+#define MEMAREA_OBJECT_HEADER_AVAILABLE_COOKIE	0xbeef1234beef1234ULL
+#define MEMAREA_OBJECT_HEADER_ALLOCATED_COOKIE	0x12345678abcdef12ULL
+#define MEMAREA_OBJECT_TRAILER_COOKIE		0xabcd1234abcd5678ULL
+
+/** Object cookie target status. */
+enum {
+	/** Object is set to be available, but don't set trailer cookie. */
+	COOKIE_TARGET_STATUS_AVAILABLE,
+	/** Object is set to be allocated, but don't set trailer cookie. */
+	COOKIE_TARGET_STATUS_ALLOCATED,
+	/** object is new split, the header cookie will set to be available,
+	 * the trailer cookie of the previous object will be set.
+	 */
+	COOKIE_TARGET_STATUS_NEW_AVAILABLE,
+	/** object is new split, the header cookie will set to be allocated,
+	 * the trailer cookie of the previous object will be set.
+	 */
+	COOKIE_TARGET_STATUS_NEW_ALLOCATED,
+	/** Object is to be merged, it will no longer exist. the header cookie
+	 * is cleared and the trailer cookie of the previous object is cleared.
+	 */
+	COOKIE_TARGET_STATUS_CLEARED,
+};
+
+/** Object cookie expect status. */
+enum {
+	/** Object is supposed to be available. */
+	COOKIE_EXPECT_STATUS_AVAILABLE,
+	/** Object is supposed to be allocated. */
+	COOKIE_EXPECT_STATUS_ALLOCATED,
+	/** Object is supposed to be valid (available or allocated). */
+	COOKIE_EXPECT_STATUS_VALID,
+};
+
+#define MEMAREA_OBJECT_IS_ALLOCATED(hdr)	(TAILQ_NEXT((hdr), avail_next) == (void *)-1)
+#define MEMAREA_OBJECT_MARK_ALLOCATED(hdr)	(TAILQ_NEXT((hdr), avail_next) = (void *)-1)
+
+#ifdef RTE_LIBRTE_MEMAREA_DEBUG
+#define MEMAREA_OBJECT_GET_SIZE(hdr) \
+		((uintptr_t)TAILQ_NEXT((hdr), obj_next) - (uintptr_t)(hdr) - \
+		 sizeof(struct memarea_objhdr) - sizeof(struct memarea_objtlr))
+#else
+#define MEMAREA_OBJECT_GET_SIZE(hdr) \
+		((uintptr_t)TAILQ_NEXT((hdr), obj_next) - (uintptr_t)(hdr) - \
+		 sizeof(struct memarea_objhdr))
+#endif
+
+struct memarea_objhdr {
+	/** The obj_next will form obj_list. */
+	TAILQ_ENTRY(memarea_objhdr) obj_next;
+	/** If the object is available, the avail_next will link in avail_list.
+	 * If the object has been allocated, the avail_next.tqe_next is -1.
+	 */
+	TAILQ_ENTRY(memarea_objhdr) avail_next;
+#ifdef RTE_LIBRTE_MEMAREA_DEBUG
+	uint64_t                    cookie; /**< Debug cookie */
+#endif
+};
+
+#ifdef RTE_LIBRTE_MEMAREA_DEBUG
+struct memarea_objtlr {
+	uint64_t cookie; /**< Debug cookie */
+};
+#endif
+
+TAILQ_HEAD(memarea_objhdr_list, memarea_objhdr);
+
+struct rte_memarea {
+	struct rte_memarea_param   init;
+	rte_spinlock_t             lock;
+	void                      *area_base;
+	struct memarea_objhdr     *guard_hdr;
+	/** The obj_list is an address ascending ordered linked list:
+	 *             ----------------------               --------------
+	 *             |      object-1      |               |  object-1  |
+	 * obj_list -> |~~~~~~~~~~~~~~~~~~~~|  data-region  |~~~~~~~~~~~~|
+	 *        ---> | tailq | hdr-cookie |               | tlr-cookie |
+	 *        |    ----------------------               --------------
+	 *        |
+	 *        |    ----------------------               --------------
+	 *        |    |      object-2      |               |  object-2  |
+	 *        ---> |~~~~~~~~~~~~~~~~~~~~|  data-region  |~~~~~~~~~~~~|
+	 *        ---> | tailq | hdr-cookie |               | tlr-cookie |
+	 *        |     ----------------------               --------------
+	 *        ...
+	 *        ...  more objects.
+	 *        ...
+	 *        |    ----------------------
+	 *        |    |    object-guard    |
+	 *        ---> |~~~~~~~~~~~~~~~~~~~~|
+	 *             | tailq | hdr-cookie |
+	 *             ----------------------
+	 * Note: the last object is the guard object, which has no data-region
+	 *       and no trailer cookie.
+	 **/
+	struct memarea_objhdr_list obj_list;
+	/** The avail_list is an unordered linked list. This list will hold the
+	 * objects which are available(means can be used to allocate).
+	 */
+	struct memarea_objhdr_list avail_list;
+} __rte_cache_aligned;
+
+#endif /* MEMAREA_PRIVATE_H */
diff --git a/lib/memarea/meson.build b/lib/memarea/meson.build
new file mode 100644
index 0000000000..48499626fd
--- /dev/null
+++ b/lib/memarea/meson.build
@@ -0,0 +1,12 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright(c) 2023 HiSilicon Limited
+
+sources = files(
+        'rte_memarea.c',
+)
+headers = files(
+        'rte_memarea.h',
+)
+deps += []
+
+annotate_locks = false
diff --git a/lib/memarea/rte_memarea.c b/lib/memarea/rte_memarea.c
new file mode 100644
index 0000000000..ea9067fb35
--- /dev/null
+++ b/lib/memarea/rte_memarea.c
@@ -0,0 +1,208 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2023 HiSilicon Limited
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+
+#include <rte_common.h>
+#include <rte_errno.h>
+#include <rte_log.h>
+#include <rte_malloc.h>
+#include <rte_spinlock.h>
+
+#include "rte_memarea.h"
+#include "memarea_private.h"
+
+RTE_LOG_REGISTER_DEFAULT(rte_memarea_logtype, INFO);
+#define RTE_MEMAREA_LOG(level, fmt, args...) \
+	rte_log(RTE_LOG_ ## level, rte_memarea_logtype, \
+		"MEMAREA: %s(): " fmt "\n", __func__, ## args)
+
+static int
+memarea_check_param(const struct rte_memarea_param *init)
+{
+	size_t len;
+
+	if (init == NULL) {
+		RTE_MEMAREA_LOG(ERR, "init param is NULL!");
+		return -EINVAL;
+	}
+
+	len = strnlen(init->name, RTE_MEMAREA_NAMESIZE);
+	if (len == 0 || len >= RTE_MEMAREA_NAMESIZE) {
+		RTE_MEMAREA_LOG(ERR, "name size: %zu invalid!", len);
+		return -EINVAL;
+	}
+
+	if (init->source != RTE_MEMAREA_SOURCE_HEAP &&
+	    init->source != RTE_MEMAREA_SOURCE_LIBC &&
+	    init->source != RTE_MEMAREA_SOURCE_MEMAREA) {
+		RTE_MEMAREA_LOG(ERR, "%s source: %d not supported!",
+			init->name, init->source);
+		return -EINVAL;
+	}
+
+	if (init->total_sz < MEMAREA_MINIMUM_TOTAL_SIZE) {
+		RTE_MEMAREA_LOG(ERR, "%s total-size: %zu too small!",
+			init->name, init->total_sz);
+		return -EINVAL;
+	}
+
+	if (init->source == RTE_MEMAREA_SOURCE_MEMAREA && init->ma.src == NULL) {
+		RTE_MEMAREA_LOG(ERR, "%s source memarea is NULL!", init->name);
+		return -EINVAL;
+	}
+
+	if (init->alg != RTE_MEMAREA_ALGORITHM_NEXTFIT) {
+		RTE_MEMAREA_LOG(ERR, "%s algorithm: %d not supported!",
+			init->name, init->alg);
+		return -EINVAL;
+	}
+
+	if (init->reserved_bits != 0 || init->reserved_64s[0] != 0 ||
+	    init->reserved_64s[1] != 0) {
+		RTE_MEMAREA_LOG(ERR, "%s reserved field not zero!", init->name);
+		return -EINVAL;
+	}
+
+	return 0;
+}
+
+static void *
+memarea_alloc_from_libc(size_t size)
+{
+#ifdef RTE_EXEC_ENV_WINDOWS
+	return _aligned_malloc(size, RTE_CACHE_LINE_SIZE);
+#else
+	void *ptr = NULL;
+	int ret;
+	ret = posix_memalign(&ptr, RTE_CACHE_LINE_SIZE, size);
+	if (ret != 0)
+		return NULL;
+	return ptr;
+ #endif
+}
+
+static void *
+memarea_alloc_area(const struct rte_memarea_param *init)
+{
+	void *ptr = NULL;
+
+	if (init->source == RTE_MEMAREA_SOURCE_HEAP)
+		ptr = rte_malloc_socket(NULL, init->total_sz, RTE_CACHE_LINE_SIZE,
+					init->heap.socket_id);
+	else if (init->source == RTE_MEMAREA_SOURCE_LIBC)
+		ptr = memarea_alloc_from_libc(init->total_sz);
+
+	return ptr;
+}
+
+static void
+memarea_free_area(const struct rte_memarea_param *init, void *ptr)
+{
+	if (init->source == RTE_MEMAREA_SOURCE_HEAP)
+		rte_free(ptr);
+	else if (init->source == RTE_MEMAREA_SOURCE_LIBC)
+		free(ptr);
+}
+
+static inline void
+memarea_set_cookie(struct memarea_objhdr *hdr, int status)
+{
+#ifdef RTE_LIBRTE_MEMAREA_DEBUG
+	struct memarea_objtlr *tlr;
+
+	if (status == 0) {
+		hdr->cookie = MEMAREA_OBJECT_HEADER_AVAILABLE_COOKIE;
+	} else if (status == 1) {
+		hdr->cookie = MEMAREA_OBJECT_HEADER_ALLOCATED_COOKIE;
+	} else if (status == 2) {
+		hdr->cookie = MEMAREA_OBJECT_HEADER_AVAILABLE_COOKIE;
+		tlr = RTE_PTR_SUB(hdr, sizeof(struct memarea_objtlr));
+		tlr->cookie = MEMAREA_OBJECT_TRAILER_COOKIE;
+	} else if (status == 3) {
+		hdr->cookie = MEMAREA_OBJECT_HEADER_ALLOCATED_COOKIE;
+		tlr = RTE_PTR_SUB(hdr, sizeof(struct memarea_objtlr));
+		tlr->cookie = MEMAREA_OBJECT_TRAILER_COOKIE;
+	} else if (status == 4) {
+		hdr->cookie = 0;
+		tlr = RTE_PTR_SUB(hdr, sizeof(struct memarea_objtlr));
+		tlr->cookie = 0;
+	}
+#else
+	RTE_SET_USED(hdr);
+	RTE_SET_USED(status);
+#endif
+}
+
+struct rte_memarea *
+rte_memarea_create(const struct rte_memarea_param *init)
+{
+	struct memarea_objhdr *hdr, *guard_hdr;
+	struct rte_memarea *ma;
+	size_t align_sz;
+	void *ptr;
+	int ret;
+
+	/** 1st: check parameter valid. */
+	ret = memarea_check_param(init);
+	if (ret != 0) {
+		rte_errno = -ret;
+		return NULL;
+	}
+
+	/** 2nd: alloc the memarea data region. */
+	ptr = memarea_alloc_area(init);
+	if (ptr == NULL) {
+		RTE_MEMAREA_LOG(ERR, "%s alloc memory area fail!", init->name);
+		rte_errno = ENOMEM;
+		return NULL;
+	}
+
+	/** 3rd: alloc the memare management struct. */
+	ma = rte_zmalloc(NULL, sizeof(struct rte_memarea), RTE_CACHE_LINE_SIZE);
+	if (ma == NULL) {
+		memarea_free_area(init, ptr);
+		RTE_MEMAREA_LOG(ERR, "%s alloc management object fail!", init->name);
+		rte_errno = ENOMEM;
+		return NULL;
+	}
+
+	/** 4th: backup init parameter, initialize the lock and list. */
+	ma->init = *init;
+	rte_spinlock_init(&ma->lock);
+	TAILQ_INIT(&ma->obj_list);
+	TAILQ_INIT(&ma->avail_list);
+
+	/** 5th: initialize the first object and last guard object. */
+	hdr = ptr;
+	align_sz = RTE_ALIGN_FLOOR(init->total_sz, MEMAREA_OBJECT_SIZE_ALIGN);
+	guard_hdr = RTE_PTR_ADD(ptr, align_sz - sizeof(struct memarea_objhdr));
+	ma->area_base = ptr;
+	ma->guard_hdr = guard_hdr;
+
+	/** 5.1: hook the first object to both obj_list and avail_list. */
+	TAILQ_INSERT_TAIL(&ma->obj_list, hdr, obj_next);
+	TAILQ_INSERT_TAIL(&ma->avail_list, hdr, avail_next);
+	memarea_set_cookie(hdr, COOKIE_TARGET_STATUS_AVAILABLE);
+
+	/** 5.2: hook the guard object to only obj_list. */
+	memset(guard_hdr, 0, sizeof(struct memarea_objhdr));
+	TAILQ_INSERT_AFTER(&ma->obj_list, hdr, guard_hdr, obj_next);
+	MEMAREA_OBJECT_MARK_ALLOCATED(guard_hdr);
+	memarea_set_cookie(guard_hdr, COOKIE_TARGET_STATUS_NEW_ALLOCATED);
+
+	return ma;
+}
+
+void
+rte_memarea_destroy(struct rte_memarea *ma)
+{
+	if (ma == NULL) {
+		rte_errno = EINVAL;
+		return;
+	}
+	memarea_free_area(&ma->init, ma->area_base);
+	rte_free(ma);
+}
diff --git a/lib/memarea/rte_memarea.h b/lib/memarea/rte_memarea.h
new file mode 100644
index 0000000000..1d4381efd7
--- /dev/null
+++ b/lib/memarea/rte_memarea.h
@@ -0,0 +1,141 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2023 HiSilicon Limited
+ */
+
+#ifndef RTE_MEMAREA_H
+#define RTE_MEMAREA_H
+
+/**
+ * @file
+ * RTE Memarea.
+ *
+ * The memarea is an allocator of variable-size object which based on a memory
+ * region. It has the following features:
+ *
+ * - The memory region can be initialized from the following memory sources:
+ *   1. HEAP: e.g. invoke rte_malloc_xxx family.
+ *   2. LIBC: e.g. invoke posix_memalign.
+ *   3. Another memarea: it can be allocated from another memarea.
+ *
+ * - It supports MT-safe as long as it's specified at creation time. If not
+ *   specified, all the functions of the memarea API are lock-free, and assume
+ *   to not be invoked in parallel on different logical cores to work on the
+ *   same memarea.
+ *
+ * - The address returned by the allocator is align to 8B.
+ *
+ * @note The current implementation is a minimum set and does not support
+ * multiple-process.
+ */
+
+#include <stdbool.h>
+#include <stdint.h>
+#include <stdio.h>
+
+#include <rte_compat.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#define RTE_MEMAREA_NAMESIZE	64
+
+/**
+ * Memarea memory source.
+ */
+enum rte_memarea_source {
+	/** Memory source comes from rte_malloc_xxx memory. */
+	RTE_MEMAREA_SOURCE_HEAP,
+	/** Memory source comes from libc. */
+	RTE_MEMAREA_SOURCE_LIBC,
+	/** Memory source comes from another memarea. */
+	RTE_MEMAREA_SOURCE_MEMAREA,
+};
+
+/**
+ * Memarea memory management algorithm.
+ */
+enum rte_memarea_algorithm {
+	/** The default management algorithm is a variant of the next fit
+	 * algorithm. It uses a free-list to apply for memory and uses an
+	 * object-list in ascending order of address to support merging
+	 * upon free.
+	 */
+	RTE_MEMAREA_ALGORITHM_NEXTFIT,
+};
+
+struct rte_memarea;
+
+/**
+ * Memarea creation parameters.
+ */
+struct rte_memarea_param {
+	char name[RTE_MEMAREA_NAMESIZE]; /**< Name of memarea. */
+	enum rte_memarea_source source;  /**< Memory source of memarea. */
+	enum rte_memarea_algorithm alg;  /**< Memory management algorithm. */
+	/** Total size (bytes) of memarea, it should not be less be 1024. */
+	size_t total_sz;
+	/** Indicates whether the memarea API should be MT-safe. */
+	uint32_t mt_safe : 1;
+	/** Reserved for future field, should be initialized to zero. */
+	uint32_t reserved_bits : 31;
+	union {
+		/** The initialization parameters if the source is set to be
+		 * RTE_MEMAREA_SOURCE_HEAP.
+		 */
+		struct {
+			/** Socket from which to apply for memarea's memory. */
+			int socket_id;
+		} heap;
+		/** The initialization parameters if the source is set to be
+		 * RTE_MEMAREA_SOURCE_MEMAREA.
+		 */
+		struct {
+			/** Source memarea which to apply for this memarea's
+			 * memory from.
+			 */
+			struct rte_memarea *src;
+		} ma;
+	};
+	/** Reserved for future fields, should be initialized to zero. */
+	uint64_t reserved_64s[2];
+};
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice.
+ *
+ * Create memarea.
+ *
+ * Create one new memarea.
+ *
+ * @param init
+ *   The init parameter of memarea.
+ *
+ * @return
+ *   Non-NULL on success. Otherwise NULL is returned (the rte_errno is set).
+ */
+__rte_experimental
+struct rte_memarea *rte_memarea_create(const struct rte_memarea_param *init);
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice.
+ *
+ * Destroy memarea.
+ *
+ * Destroy the memarea.
+ *
+ * @param ma
+ *   The pointer of memarea.
+ *
+ * @note The rte_errno is set if destroy failed.
+ */
+__rte_experimental
+void rte_memarea_destroy(struct rte_memarea *ma);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* RTE_MEMAREA_H */
diff --git a/lib/memarea/version.map b/lib/memarea/version.map
new file mode 100644
index 0000000000..f36a04d7cf
--- /dev/null
+++ b/lib/memarea/version.map
@@ -0,0 +1,12 @@
+EXPERIMENTAL {
+	global:
+
+	rte_memarea_create;
+	rte_memarea_destroy;
+
+	local: *;
+};
+
+INTERNAL {
+	local: *;
+};
diff --git a/lib/meson.build b/lib/meson.build
index fac2f52cad..36821e7007 100644
--- a/lib/meson.build
+++ b/lib/meson.build
@@ -42,6 +42,7 @@ libraries = [
         'kni',
         'latencystats',
         'lpm',
+        'memarea',
         'member',
         'pcapng',
         'power',
-- 
2.17.1


  reply	other threads:[~2023-07-18  2:48 UTC|newest]

Thread overview: 222+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-21  4:46 [RFC] memarea: introduce memory area library Chengwen Feng
2022-07-21 15:22 ` Stephen Hemminger
2022-08-04  6:36 ` Jerin Jacob
2022-08-30 12:41 ` Dmitry Kozlyuk
2022-09-20  3:46 ` [PATCH 0/8] introduce memarea library Chengwen Feng
2022-09-20  3:46   ` [PATCH 1/8] memarea: introduce memory area library Chengwen Feng
2022-09-20 11:30     ` Dmitry Kozlyuk
2022-09-20 11:31       ` Dmitry Kozlyuk
2022-09-20 12:06       ` fengchengwen
2022-09-20  3:46   ` [PATCH 2/8] test/memarea: support memarea test Chengwen Feng
2022-09-20  3:46   ` [PATCH 3/8] memarea: support alloc/free/update-refcnt API Chengwen Feng
2022-09-20  3:46   ` [PATCH 4/8] test/memarea: support alloc/free/update-refcnt test Chengwen Feng
2022-09-20  3:46   ` [PATCH 5/8] memarea: support dump API Chengwen Feng
2022-09-20  3:46   ` [PATCH 6/8] test/memarea: support dump test Chengwen Feng
2022-09-20  3:46   ` [PATCH 7/8] memarea: support backup memory mechanism Chengwen Feng
2022-09-20  3:46   ` [PATCH 8/8] test/memarea: support backup memory test Chengwen Feng
2022-09-21  3:12 ` [PATCH v2 0/9] introduce memarea library Chengwen Feng
2022-09-21  3:12   ` [PATCH v2 1/9] memarea: introduce memory area library Chengwen Feng
2022-09-21  3:12   ` [PATCH v2 2/9] test/memarea: support memarea test Chengwen Feng
2022-09-21  3:12   ` [PATCH v2 3/9] memarea: support alloc/free/update-refcnt API Chengwen Feng
2022-09-21  3:12   ` [PATCH v2 4/9] test/memarea: support alloc/free/update-refcnt test Chengwen Feng
2022-09-21  3:12   ` [PATCH v2 5/9] memarea: support dump API Chengwen Feng
2022-09-21  3:12   ` [PATCH v2 6/9] test/memarea: support dump test Chengwen Feng
2022-09-21  3:12   ` [PATCH v2 7/9] memarea: support backup memory mechanism Chengwen Feng
2022-09-21  3:12   ` [PATCH v2 8/9] test/memarea: support backup memory test Chengwen Feng
2022-09-21  3:12   ` [PATCH v2 9/9] test/memarea: support no MT-safe test Chengwen Feng
2022-09-24  7:49 ` [PATCH v3 00/10] introduce memarea library Chengwen Feng
2022-09-24  7:49   ` [PATCH v3 01/10] memarea: " Chengwen Feng
2022-09-24  7:49   ` [PATCH v3 02/10] test/memarea: support memarea test Chengwen Feng
2022-09-24  7:49   ` [PATCH v3 03/10] memarea: support alloc/free/update-refcnt API Chengwen Feng
2022-09-24  7:49   ` [PATCH v3 04/10] test/memarea: support alloc/free/update-refcnt test Chengwen Feng
2022-09-24  7:49   ` [PATCH v3 05/10] memarea: support dump API Chengwen Feng
2022-09-24  7:49   ` [PATCH v3 06/10] test/memarea: support dump test Chengwen Feng
2022-09-24  7:49   ` [PATCH v3 07/10] memarea: support backup memory mechanism Chengwen Feng
2022-09-24  7:49   ` [PATCH v3 08/10] test/memarea: support backup memory test Chengwen Feng
2022-09-24  7:49   ` [PATCH v3 09/10] memarea: detect memory corruption based on magic Chengwen Feng
2022-09-24  7:49   ` [PATCH v3 10/10] test/memarea: support no MT-safe test Chengwen Feng
2022-10-03  7:42   ` [PATCH v3 00/10] introduce memarea library David Marchand
2022-10-05  4:19     ` datshan
2022-10-05  3:38 ` [PATCH v4 " datshan
     [not found] ` <20221005033848.2241-1-datshan@qq.com>
2022-10-05  3:38   ` [PATCH v4 01/10] memarea: " datshan
2022-10-05  3:38   ` [PATCH v4 02/10] test/memarea: support memarea test datshan
2022-10-05  3:38   ` [PATCH v4 03/10] memarea: support alloc/free/update-refcnt API datshan
2022-10-05  3:38   ` [PATCH v4 04/10] test/memarea: support alloc/free/update-refcnt test datshan
2022-10-05  3:38   ` [PATCH v4 05/10] memarea: support dump API datshan
2022-10-05  3:38   ` [PATCH v4 06/10] test/memarea: support dump test datshan
2022-10-05  3:38   ` [PATCH v4 07/10] memarea: support backup memory mechanism datshan
2022-10-05  3:38   ` [PATCH v4 08/10] test/memarea: support backup memory test datshan
2022-10-05  3:38   ` [PATCH v4 09/10] memarea: detect memory corruption based on magic datshan
2022-10-05  3:38   ` [PATCH v4 10/10] test/memarea: support no MT-safe test datshan
2022-10-05  4:09 ` [PATCH v5 00/10] introduce memarea library datshan
     [not found] ` <20221005040952.8166-1-datshan@qq.com>
2022-10-05  4:09   ` [PATCH v5 01/10] memarea: " datshan
2022-10-06 20:15     ` Mattias Rönnblom
2022-10-08  7:53       ` fengchengwen
2022-10-10 16:53         ` Mattias Rönnblom
2022-10-10 23:33           ` fengchengwen
2022-10-11 15:35             ` Mattias Rönnblom
2022-10-05  4:09   ` [PATCH v5 02/10] test/memarea: support memarea test datshan
2022-10-05  4:09   ` [PATCH v5 03/10] memarea: support alloc/free/update-refcnt API datshan
2022-10-06 19:43     ` Mattias Rönnblom
2022-10-08  8:02       ` fengchengwen
2022-10-05  4:09   ` [PATCH v5 04/10] test/memarea: support alloc/free/update-refcnt test datshan
2022-10-05  4:09   ` [PATCH v5 05/10] memarea: support dump API datshan
2022-10-05  4:09   ` [PATCH v5 06/10] test/memarea: support dump test datshan
2022-10-05  4:09   ` [PATCH v5 07/10] memarea: support backup memory mechanism datshan
2022-10-06 19:53     ` Mattias Rönnblom
2022-10-08  7:56       ` fengchengwen
2022-10-05  4:09   ` [PATCH v5 08/10] test/memarea: support backup memory test datshan
2022-10-05  4:09   ` [PATCH v5 09/10] memarea: detect memory corruption based on magic datshan
2022-10-05  4:09   ` [PATCH v5 10/10] test/memarea: support no MT-safe test datshan
2022-10-08 11:33 ` [PATCH v6 00/10] introduce memarea library Chengwen Feng
2022-10-08 11:33   ` [PATCH v6 01/10] memarea: " Chengwen Feng
2022-10-08 11:33   ` [PATCH v6 02/10] test/memarea: support memarea test Chengwen Feng
2022-10-08 11:33   ` [PATCH v6 03/10] memarea: support alloc/free/update-refcnt API Chengwen Feng
2022-10-08 11:33   ` [PATCH v6 04/10] test/memarea: support alloc/free/update-refcnt test Chengwen Feng
2022-10-08 11:33   ` [PATCH v6 05/10] memarea: support dump API Chengwen Feng
2022-10-08 11:33   ` [PATCH v6 06/10] test/memarea: support dump test Chengwen Feng
2022-10-08 11:33   ` [PATCH v6 07/10] memarea: support backup memory mechanism Chengwen Feng
2022-10-08 11:33   ` [PATCH v6 08/10] test/memarea: support backup memory test Chengwen Feng
2022-10-08 11:33   ` [PATCH v6 09/10] memarea: detect memory corruption based on magic Chengwen Feng
2022-10-08 11:33   ` [PATCH v6 10/10] test/memarea: support no MT-safe test Chengwen Feng
2022-10-08 11:58 ` [PATCH v7 00/10] introduce memarea library Chengwen Feng
2022-10-08 11:58   ` [PATCH v7 01/10] memarea: " Chengwen Feng
2022-10-08 11:58   ` [PATCH v7 02/10] test/memarea: support memarea test Chengwen Feng
2022-10-08 11:58   ` [PATCH v7 03/10] memarea: support alloc/free/update-refcnt API Chengwen Feng
2022-10-08 11:58   ` [PATCH v7 04/10] test/memarea: support alloc/free/update-refcnt test Chengwen Feng
2022-10-08 11:58   ` [PATCH v7 05/10] memarea: support dump API Chengwen Feng
2022-10-08 11:58   ` [PATCH v7 06/10] test/memarea: support dump test Chengwen Feng
2022-10-08 11:58   ` [PATCH v7 07/10] memarea: support backup memory mechanism Chengwen Feng
2022-10-08 11:58   ` [PATCH v7 08/10] test/memarea: support backup memory test Chengwen Feng
2022-10-08 11:58   ` [PATCH v7 09/10] memarea: detect memory corruption based on magic Chengwen Feng
2022-10-08 11:58   ` [PATCH v7 10/10] test/memarea: support no MT-safe test Chengwen Feng
2022-10-08 12:14   ` [PATCH v7 00/10] introduce memarea library fengchengwen
2022-10-11 12:17 ` [PATCH v8 0/9] " Chengwen Feng
2022-10-11 12:17   ` [PATCH v8 1/9] memarea: " Chengwen Feng
2022-10-11 15:58     ` Dmitry Kozlyuk
2022-10-12  4:06       ` fengchengwen
2022-10-13 10:45         ` fengchengwen
2022-10-11 12:17   ` [PATCH v8 2/9] test/memarea: support memarea test Chengwen Feng
2022-10-11 12:17   ` [PATCH v8 3/9] memarea: support alloc/free/update-refcnt API Chengwen Feng
2022-10-11 15:58     ` Dmitry Kozlyuk
2022-10-12  7:28       ` fengchengwen
2022-10-11 12:17   ` [PATCH v8 4/9] test/memarea: support alloc/free/update-refcnt test Chengwen Feng
2022-10-11 12:17   ` [PATCH v8 5/9] memarea: support dump API Chengwen Feng
2022-10-11 12:17   ` [PATCH v8 6/9] test/memarea: support dump test Chengwen Feng
2022-10-11 12:17   ` [PATCH v8 7/9] memarea: support backup memory mechanism Chengwen Feng
2022-10-11 15:58     ` Dmitry Kozlyuk
2022-10-11 20:26       ` Mattias Rönnblom
2022-10-12  8:23         ` fengchengwen
2022-10-12  7:57       ` fengchengwen
2022-10-11 12:17   ` [PATCH v8 8/9] test/memarea: support backup memory test Chengwen Feng
2022-10-11 12:17   ` [PATCH v8 9/9] app/test: add memarea to malloc-perf-autotest Chengwen Feng
2022-10-11 15:58     ` Dmitry Kozlyuk
2022-10-12  8:03       ` fengchengwen
2022-10-12 10:47 ` [PATCH v9 0/7] introduce memarea library Chengwen Feng
2022-10-12 10:47   ` [PATCH v9 1/7] memarea: " Chengwen Feng
2022-10-12 10:48   ` [PATCH v9 2/7] test/memarea: support memarea test Chengwen Feng
2022-10-12 10:48   ` [PATCH v9 3/7] memarea: support alloc/free/refcnt-update API Chengwen Feng
2022-10-12 10:48   ` [PATCH v9 4/7] test/memarea: support alloc/free/refcnt-update test Chengwen Feng
2022-10-12 10:48   ` [PATCH v9 5/7] memarea: support dump API Chengwen Feng
2022-10-12 10:48   ` [PATCH v9 6/7] test/memarea: support dump test Chengwen Feng
2022-10-12 10:48   ` [PATCH v9 7/7] app/test: add memarea to malloc-perf-autotest Chengwen Feng
2022-10-17  3:40 ` [PATCH v10 0/7] introduce memarea library Chengwen Feng
2022-10-17  3:40   ` [PATCH v10 1/7] memarea: " Chengwen Feng
2022-10-17  3:40   ` [PATCH v10 2/7] test/memarea: support memarea test Chengwen Feng
2022-10-17  3:40   ` [PATCH v10 3/7] memarea: support alloc/free/refcnt-update API Chengwen Feng
2022-10-17  3:40   ` [PATCH v10 4/7] test/memarea: support alloc/free/refcnt-update test Chengwen Feng
2022-10-17  3:40   ` [PATCH v10 5/7] memarea: support dump API Chengwen Feng
2022-10-17  3:40   ` [PATCH v10 6/7] test/memarea: support dump test Chengwen Feng
2022-10-17  3:40   ` [PATCH v10 7/7] app/test: add memarea to malloc-perf-autotest Chengwen Feng
2022-12-13  9:13 ` [PATCH v11 0/6] introduce memarea library Chengwen Feng
2022-12-13  9:13   ` [PATCH v11 1/6] memarea: " Chengwen Feng
2022-12-13  9:13   ` [PATCH v11 2/6] test/memarea: support memarea test Chengwen Feng
2022-12-13  9:13   ` [PATCH v11 3/6] memarea: support alloc/free/refcnt-update API Chengwen Feng
2023-01-10  2:16     ` Dongdong Liu
2022-12-13  9:13   ` [PATCH v11 4/6] test/memarea: support alloc/free/refcnt-update test Chengwen Feng
2022-12-13  9:13   ` [PATCH v11 5/6] memarea: support dump API Chengwen Feng
2022-12-13  9:13   ` [PATCH v11 6/6] test/memarea: support dump test Chengwen Feng
2023-01-10  2:21   ` [PATCH v11 0/6] introduce memarea library Dongdong Liu
2023-01-14 11:49 ` [PATCH v12 " Chengwen Feng
2023-01-14 11:49   ` [PATCH v12 1/6] memarea: " Chengwen Feng
2023-01-15  7:58     ` Morten Brørup
2023-01-20  8:20       ` fengchengwen
2023-01-20  9:05         ` Morten Brørup
2023-01-14 11:49   ` [PATCH v12 2/6] test/memarea: support memarea test Chengwen Feng
2023-01-14 11:49   ` [PATCH v12 3/6] memarea: support alloc and free API Chengwen Feng
2023-01-14 11:49   ` [PATCH v12 4/6] test/memarea: support alloc and free API test Chengwen Feng
2023-01-14 11:49   ` [PATCH v12 5/6] memarea: support dump API Chengwen Feng
2023-01-14 11:49   ` [PATCH v12 6/6] test/memarea: support dump API test Chengwen Feng
2023-02-08  8:24 ` [PATCH v13 0/6] introduce memarea library Chengwen Feng
2023-02-08  8:24   ` [PATCH v13 1/6] memarea: " Chengwen Feng
2023-02-09  0:04     ` Stephen Hemminger
2023-02-09  6:48       ` fengchengwen
2023-02-08  8:24   ` [PATCH v13 2/6] test/memarea: support memarea test Chengwen Feng
2023-02-08  8:24   ` [PATCH v13 3/6] memarea: support alloc and free API Chengwen Feng
2023-02-08  8:24   ` [PATCH v13 4/6] test/memarea: support alloc and free API test Chengwen Feng
2023-02-08  8:24   ` [PATCH v13 5/6] memarea: support dump API Chengwen Feng
2023-02-08  8:24   ` [PATCH v13 6/6] test/memarea: support dump API test Chengwen Feng
2023-02-08  8:43   ` [PATCH v13 0/6] introduce memarea library Morten Brørup
2023-02-09  6:36 ` [PATCH v14 " Chengwen Feng
2023-02-09  6:36   ` [PATCH v14 1/6] memarea: " Chengwen Feng
2023-06-21 10:52     ` Burakov, Anatoly
2023-06-21 12:05     ` Burakov, Anatoly
2023-02-09  6:36   ` [PATCH v14 2/6] test/memarea: support memarea test Chengwen Feng
2023-06-21 11:00     ` Burakov, Anatoly
2023-02-09  6:36   ` [PATCH v14 3/6] memarea: support alloc and free API Chengwen Feng
2023-06-22 15:29     ` Burakov, Anatoly
2023-02-09  6:36   ` [PATCH v14 4/6] test/memarea: support alloc and free API test Chengwen Feng
2023-02-09  6:36   ` [PATCH v14 5/6] memarea: support dump API Chengwen Feng
2023-06-22 15:55     ` Burakov, Anatoly
2023-06-28  1:25       ` fengchengwen
2023-06-28  1:39         ` Thomas Monjalon
2023-06-28  1:48           ` fengchengwen
2023-07-03 10:29           ` Burakov, Anatoly
2023-02-09  6:36   ` [PATCH v14 6/6] test/memarea: support dump API test Chengwen Feng
2023-06-12 13:53   ` [PATCH v14 0/6] introduce memarea library Ferruh Yigit
2023-06-13  9:50     ` fengchengwen
2023-06-13 11:04       ` Burakov, Anatoly
2023-06-13 12:46         ` fengchengwen
2023-07-09 13:00 ` [PATCH v15 " Chengwen Feng
2023-07-09 13:00   ` [PATCH v15 1/6] memarea: " Chengwen Feng
2023-07-09 19:46     ` Stephen Hemminger
2023-07-09 13:00   ` [PATCH v15 2/6] test/memarea: support memarea test Chengwen Feng
2023-07-09 13:00   ` [PATCH v15 3/6] memarea: support alloc and free API Chengwen Feng
2023-07-09 13:00   ` [PATCH v15 4/6] test/memarea: support alloc and free API test Chengwen Feng
2023-07-09 13:00   ` [PATCH v15 5/6] memarea: support dump API Chengwen Feng
2023-07-09 13:00   ` [PATCH v15 6/6] test/memarea: support dump API test Chengwen Feng
2023-07-10  6:49 ` [PATCH v16 0/6] introduce memarea library Chengwen Feng
2023-07-10  6:49   ` [PATCH v16 1/6] memarea: " Chengwen Feng
2023-07-17 13:19     ` Burakov, Anatoly
2023-07-10  6:49   ` [PATCH v16 2/6] test/memarea: support memarea test Chengwen Feng
2023-07-17 13:22     ` Burakov, Anatoly
2023-07-10  6:49   ` [PATCH v16 3/6] memarea: support alloc and free API Chengwen Feng
2023-07-17 13:33     ` Burakov, Anatoly
2023-07-10  6:49   ` [PATCH v16 4/6] test/memarea: support alloc and free API test Chengwen Feng
2023-07-17 13:57     ` Burakov, Anatoly
2023-07-18  2:49       ` fengchengwen
2023-07-10  6:49   ` [PATCH v16 5/6] memarea: support dump API Chengwen Feng
2023-07-10  6:49   ` [PATCH v16 6/6] test/memarea: support dump API test Chengwen Feng
2023-07-19 12:09     ` Burakov, Anatoly
2023-07-20  9:35       ` fengchengwen
2023-07-18  2:40 ` [PATCH v17 0/6] introduce memarea library Chengwen Feng
2023-07-18  2:40   ` Chengwen Feng [this message]
2023-07-18  2:40   ` [PATCH v17 2/6] test/memarea: support memarea test Chengwen Feng
2023-07-18  2:40   ` [PATCH v17 3/6] memarea: support alloc and free API Chengwen Feng
2023-07-18  2:40   ` [PATCH v17 4/6] test/memarea: support alloc and free API test Chengwen Feng
2023-07-18  2:40   ` [PATCH v17 5/6] memarea: support dump API Chengwen Feng
2023-07-18  2:40   ` [PATCH v17 6/6] test/memarea: support dump API test Chengwen Feng
2023-07-18 13:46 ` [PATCH v18 0/6] introduce memarea library Chengwen Feng
2023-07-18 13:46   ` [PATCH v18 1/6] memarea: " Chengwen Feng
2023-07-18 13:46   ` [PATCH v18 2/6] test/memarea: support memarea test Chengwen Feng
2023-07-18 13:46   ` [PATCH v18 3/6] memarea: support alloc and free API Chengwen Feng
2023-07-18 13:46   ` [PATCH v18 4/6] test/memarea: support alloc and free API test Chengwen Feng
2023-07-18 13:46   ` [PATCH v18 5/6] memarea: support dump API Chengwen Feng
2023-07-18 13:46   ` [PATCH v18 6/6] test/memarea: support dump API test Chengwen Feng
2023-07-20  9:22 ` [PATCH v19 0/6] introduce memarea library Chengwen Feng
2023-07-20  9:22   ` [PATCH v19 1/6] memarea: " Chengwen Feng
2023-07-20  9:22   ` [PATCH v19 2/6] test/memarea: support memarea test Chengwen Feng
2023-07-20  9:22   ` [PATCH v19 3/6] memarea: support alloc and free API Chengwen Feng
2023-07-20  9:22   ` [PATCH v19 4/6] test/memarea: support alloc and free API test Chengwen Feng
2023-07-20  9:22   ` [PATCH v19 5/6] memarea: support dump API Chengwen Feng
2023-07-20  9:22   ` [PATCH v19 6/6] test/memarea: support dump API test Chengwen Feng

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=20230718024006.2154-2-fengchengwen@huawei.com \
    --to=fengchengwen@huawei.com \
    --cc=anatoly.burakov@intel.com \
    --cc=david.marchand@redhat.com \
    --cc=dev@dpdk.org \
    --cc=dmitry.kozliuk@gmail.com \
    --cc=hofors@lysator.liu.se \
    --cc=jerinjacobk@gmail.com \
    --cc=mb@smartsharesystems.com \
    --cc=stephen@networkplumber.org \
    --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).