From patchwork Fri Dec 11 23:34:16 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Monjalon X-Patchwork-Id: 9508 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id 69EE08E7E; Sat, 12 Dec 2015 00:35:39 +0100 (CET) Received: from mail-wm0-f48.google.com (mail-wm0-f48.google.com [74.125.82.48]) by dpdk.org (Postfix) with ESMTP id AB0498E7E for ; Sat, 12 Dec 2015 00:35:37 +0100 (CET) Received: by wmnn186 with SMTP id n186so52042654wmn.0 for ; Fri, 11 Dec 2015 15:35:37 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind-com.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=dQPKjkGxWkUxFgP5WlXoyQeiSmo6AZdXpNRUVY6WBMY=; b=Z5IPzpUZUHghH94v/iqYfnPLvNFNWckHH+AFgJVa0Ld+QYEn/uIFJFFHOANuUl4OuF 4jaiK4AmFwfup6rzR9t0hYd6+Krrq2o07VoGP+sKCklUF/UG/7+RLKl5mu8k7zJie76w sod469wvc3goAv0UqlffmMxxVGKEeFG+HZElyCrCqVTNWjrsG9MUW7QHTdW5kVMSfrPe Jdi1XvZ1DTqklSvG0BjXdYVmfjVA4m6GGdZ1IIHMgfXCQM23FJnE2gt37VHWXA1fJY6f 54LEqarU8Kq7qnptqdLJs5NEZ2N/kF3GAAZfDedL47tlPEBR6gNcvwPpqwIR1KotNnkG 9sVg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=dQPKjkGxWkUxFgP5WlXoyQeiSmo6AZdXpNRUVY6WBMY=; b=UVGLPzt1f6EHYvGoocE1wyZAV4ArlvtMQjxk8YP2Aq9qpxwtOBZtukiKwsY8FgKPa2 gHp0cjeVf/JtVj8K5UrwTVRS7hv9HNzupZeUCa8jcBloakMGaflfQhEyMyXRvr23LlnM ShzeGs1mvj0xujamoLNrjI7v/AoOfrLow9SrdFACyCF4NGYGedkbX3CYjU1Ae6366HrH F6TMhkgn9qxIJ2cz0eRsGqcnLJrcYyo0Qy2mLGuP5wGqNUDTYuAvlN2rHR5/aRiJC/02 qNAqfVVyIBWegUOzBywzs86Wo8cd8IhaIkACz09ET+Hr4P8DRqEsFDRBrwEnSwSE8XCw Il6A== X-Gm-Message-State: ALoCoQkGyo01fpsfuzxDoPKB3NQYR3RI5K8+VGHbVZq+9HAMkwYXOsGuEg9f1vgMi1n78w2zXTTkLeDnQ2wm8P7STMODDe+BQA== X-Received: by 10.194.175.194 with SMTP id cc2mr23087377wjc.121.1449876937434; Fri, 11 Dec 2015 15:35:37 -0800 (PST) Received: from localhost.localdomain (136-92-190-109.dsl.ovh.fr. [109.190.92.136]) by smtp.gmail.com with ESMTPSA id n7sm5343787wmf.21.2015.12.11.15.35.36 (version=TLSv1/SSLv3 cipher=OTHER); Fri, 11 Dec 2015 15:35:36 -0800 (PST) From: Thomas Monjalon To: declan.doherty@intel.com Date: Sat, 12 Dec 2015 00:34:16 +0100 Message-Id: <1449876856-18741-1-git-send-email-thomas.monjalon@6wind.com> X-Mailer: git-send-email 2.5.2 In-Reply-To: <345C63BAECC1AD42A2EC8C63AFFC3ADC2809A787@irsmsx105.ger.corp.intel.com> References: <345C63BAECC1AD42A2EC8C63AFFC3ADC2809A787@irsmsx105.ger.corp.intel.com> Cc: dev@dpdk.org Subject: [dpdk-dev] [PATCH] mbuf_offload: mark experimental state X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 --- 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 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 @@ -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