From: Thomas Monjalon <thomas.monjalon@6wind.com>
To: declan.doherty@intel.com
Cc: dev@dpdk.org
Subject: [dpdk-dev] [PATCH] mbuf_offload: mark experimental state
Date: Sat, 12 Dec 2015 00:34:16 +0100 [thread overview]
Message-ID: <1449876856-18741-1-git-send-email-thomas.monjalon@6wind.com> (raw)
In-Reply-To: <345C63BAECC1AD42A2EC8C63AFFC3ADC2809A787@irsmsx105.ger.corp.intel.com>
Cryptodev was marked experimental and mbuf_offload depends on it.
The mbuf_offload library is one of the crypto area which requires
some discussions before having a stable API.
The experimental mark is also added to rte_cryptodev_configure()
to be sure one cannot miss it.
Fixes: 66874e55f550 ("cryptodev: mark experimental state")
Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
---
MAINTAINERS | 2 +-
config/common_bsdapp | 1 +
config/common_linuxapp | 1 +
lib/librte_cryptodev/rte_cryptodev.h | 2 ++
lib/librte_mbuf_offload/rte_mbuf_offload.h | 5 +++++
5 files changed, 10 insertions(+), 1 deletion(-)
diff --git a/MAINTAINERS b/MAINTAINERS
index a3ff3f2..3292e84 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -217,7 +217,7 @@ F: lib/librte_mbuf/
F: doc/guides/prog_guide/mbuf_lib.rst
F: app/test/test_mbuf.c
-Packet buffer offload
+Packet buffer offload - EXPERIMENTAL
M: Declan Doherty <declan.doherty@intel.com>
F: lib/librte_mbuf_offload/
diff --git a/config/common_bsdapp b/config/common_bsdapp
index 07328d9..8a4d448 100644
--- a/config/common_bsdapp
+++ b/config/common_bsdapp
@@ -362,6 +362,7 @@ CONFIG_RTE_PKTMBUF_HEADROOM=128
#
# Compile librte_mbuf_offload
+# EXPERIMENTAL: API may change without prior notice
#
CONFIG_RTE_LIBRTE_MBUF_OFFLOAD=y
CONFIG_RTE_LIBRTE_MBUF_OFFLOAD_DEBUG=n
diff --git a/config/common_linuxapp b/config/common_linuxapp
index ba9e55d..dda309c 100644
--- a/config/common_linuxapp
+++ b/config/common_linuxapp
@@ -379,6 +379,7 @@ CONFIG_RTE_PKTMBUF_HEADROOM=128
#
# Compile librte_mbuf_offload
+# EXPERIMENTAL: API may change without prior notice
#
CONFIG_RTE_LIBRTE_MBUF_OFFLOAD=y
CONFIG_RTE_LIBRTE_MBUF_OFFLOAD_DEBUG=n
diff --git a/lib/librte_cryptodev/rte_cryptodev.h b/lib/librte_cryptodev/rte_cryptodev.h
index aa9f785..892375d 100644
--- a/lib/librte_cryptodev/rte_cryptodev.h
+++ b/lib/librte_cryptodev/rte_cryptodev.h
@@ -243,6 +243,8 @@ struct rte_cryptodev_config {
/**
* Configure a device.
*
+ * EXPERIMENTAL: this API file may change without prior notice
+ *
* This function must be invoked first before any other function in the
* API. This function can also be re-invoked when a device is in the
* stopped state.
diff --git a/lib/librte_mbuf_offload/rte_mbuf_offload.h b/lib/librte_mbuf_offload/rte_mbuf_offload.h
index f52f163..4345f06 100644
--- a/lib/librte_mbuf_offload/rte_mbuf_offload.h
+++ b/lib/librte_mbuf_offload/rte_mbuf_offload.h
@@ -51,6 +51,9 @@
* operations, with supporting allocate and free functions. It also provides
* APIs for attaching an offload to a mbuf, as well as an API to retrieve a
* specified offload type from an mbuf offload chain.
+ *
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice
*/
#include <rte_mbuf.h>
@@ -92,6 +95,8 @@ struct rte_pktmbuf_offload_pool_private {
/**
* Creates a mempool of rte_mbuf_offload objects
*
+ * EXPERIMENTAL: this API file may change without prior notice
+ *
* @param name mempool name
* @param size number of objects in mempool
* @param cache_size cache size of objects for each core
--
2.5.2
next prev parent reply other threads:[~2015-12-11 23:35 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-11-25 17:38 [dpdk-dev] [PATCH] cryptodev: " Thomas Monjalon
2015-11-25 20:59 ` Thomas Monjalon
2015-11-26 7:39 ` Panu Matilainen
2015-11-26 8:00 ` Panu Matilainen
2015-11-26 10:08 ` Thomas Monjalon
2015-11-26 13:51 ` Doherty, Declan
2015-11-27 13:09 ` Panu Matilainen
2015-11-27 13:30 ` Thomas Monjalon
2015-12-11 23:34 ` Thomas Monjalon [this message]
2015-12-11 23:44 ` [dpdk-dev] [PATCH] mbuf_offload: " Thomas Monjalon
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=1449876856-18741-1-git-send-email-thomas.monjalon@6wind.com \
--to=thomas.monjalon@6wind.com \
--cc=declan.doherty@intel.com \
--cc=dev@dpdk.org \
/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).