From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id D5C82A04B5; Wed, 30 Sep 2020 23:38:03 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 5C7CA1D583; Wed, 30 Sep 2020 23:38:02 +0200 (CEST) Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id E4A171D580 for ; Wed, 30 Sep 2020 23:37:59 +0200 (CEST) IronPort-SDR: rBgpN+f2BzALeckSVb1bEohf7s/df/vopUKb/zgFDdAkJvHQQiyyu5aSqDAWqykhSn1yE5kd0C XA3BVEXTQEWw== X-IronPort-AV: E=McAfee;i="6000,8403,9760"; a="150204901" X-IronPort-AV: E=Sophos;i="5.77,322,1596524400"; d="scan'208";a="150204901" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 30 Sep 2020 14:37:52 -0700 IronPort-SDR: YgNga/efU3UlCHMpSQhgWjyoCxmLTFiqAbRpYi0WJ8F9ab1WwEkS366jye2LmK8IvglM9n0Uk8 LuDpyguKPu6g== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,322,1596524400"; d="scan'208";a="515226746" Received: from txasoft-yocto.an.intel.com ([10.123.72.192]) by fmsmga005.fm.intel.com with ESMTP; 30 Sep 2020 14:37:50 -0700 From: Gage Eads To: dev@dpdk.org Cc: thomas@monjalon.net, david.marchand@redhat.com, mdr@ashroe.eu, nhorman@tuxdriver.com, phil.yang@arm.com, honnappa.nagarahalli@arm.com Date: Wed, 30 Sep 2020 16:39:54 -0500 Message-Id: <20200930213954.15810-1-gage.eads@intel.com> X-Mailer: git-send-email 2.13.6 In-Reply-To: <20200528010423.5941-1-gage.eads@intel.com> References: <20200528010423.5941-1-gage.eads@intel.com> Subject: [dpdk-dev] [PATCH] stack: remove experimental tag from API 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" The stack library was first released in 19.05, and its interfaces have been stable since their initial introduction. This commit promotes the full interface to stable, starting with the 20.11 major version. Signed-off-by: Gage Eads Acked-by: David Marchand --- doc/guides/rel_notes/release_20_11.rst | 3 +++ lib/librte_stack/rte_stack.h | 32 -------------------------------- lib/librte_stack/rte_stack_lf.h | 2 -- lib/librte_stack/rte_stack_std.h | 3 --- lib/librte_stack/rte_stack_version.map | 2 +- 5 files changed, 4 insertions(+), 38 deletions(-) v3: - Rebase on top of main. - Move release notes comment to the API changes section. v2: - Added 20.11 tag, will set patch status to 'Deferred' so it is skipped for the 20.08 development period. - Added release notes announcement. release_20_11.rst doesn't exist yet, so I made the change to release_20_08.rst then edited the filename directly in the patch. This will not apply cleanly. - Changed rte_stack_version.map version to DPDK_21. diff --git a/doc/guides/rel_notes/release_20_11.rst b/doc/guides/rel_notes/release_20_11.rst index 4eb3224a7..0b8cdd920 100644 --- a/doc/guides/rel_notes/release_20_11.rst +++ b/doc/guides/rel_notes/release_20_11.rst @@ -170,6 +170,9 @@ API Changes and the function ``rte_rawdev_queue_conf_get()`` from ``void`` to ``int`` allowing the return of error codes from drivers. +* stack: the experimental tag has been dropped from the stack library, and its + interfaces are considered stable as of DPDK 20.11. + * bpf: ``RTE_BPF_XTYPE_NUM`` has been dropped from ``rte_bpf_xtype``. diff --git a/lib/librte_stack/rte_stack.h b/lib/librte_stack/rte_stack.h index abf642076..395b9ef83 100644 --- a/lib/librte_stack/rte_stack.h +++ b/lib/librte_stack/rte_stack.h @@ -7,10 +7,6 @@ * * RTE Stack. * - * @warning - * @b EXPERIMENTAL: - * All functions in this file may be changed or removed without prior notice. - * * librte_stack provides an API for configuration and use of a bounded stack of * pointers. Push and pop operations are MT-safe, allowing concurrent access, * and the interface supports pushing and popping multiple pointers at a time. @@ -101,9 +97,6 @@ struct rte_stack { #include "rte_stack_lf.h" /** - * @warning - * @b EXPERIMENTAL: this API may change without prior notice - * * Push several objects on the stack (MT-safe). * * @param s @@ -115,7 +108,6 @@ struct rte_stack { * @return * Actual number of objects pushed (either 0 or *n*). */ -__rte_experimental static __rte_always_inline unsigned int rte_stack_push(struct rte_stack *s, void * const *obj_table, unsigned int n) { @@ -129,9 +121,6 @@ rte_stack_push(struct rte_stack *s, void * const *obj_table, unsigned int n) } /** - * @warning - * @b EXPERIMENTAL: this API may change without prior notice - * * Pop several objects from the stack (MT-safe). * * @param s @@ -143,7 +132,6 @@ rte_stack_push(struct rte_stack *s, void * const *obj_table, unsigned int n) * @return * Actual number of objects popped (either 0 or *n*). */ -__rte_experimental static __rte_always_inline unsigned int rte_stack_pop(struct rte_stack *s, void **obj_table, unsigned int n) { @@ -157,9 +145,6 @@ rte_stack_pop(struct rte_stack *s, void **obj_table, unsigned int n) } /** - * @warning - * @b EXPERIMENTAL: this API may change without prior notice - * * Return the number of used entries in a stack. * * @param s @@ -167,7 +152,6 @@ rte_stack_pop(struct rte_stack *s, void **obj_table, unsigned int n) * @return * The number of used entries in the stack. */ -__rte_experimental static __rte_always_inline unsigned int rte_stack_count(struct rte_stack *s) { @@ -180,9 +164,6 @@ rte_stack_count(struct rte_stack *s) } /** - * @warning - * @b EXPERIMENTAL: this API may change without prior notice - * * Return the number of free entries in a stack. * * @param s @@ -190,7 +171,6 @@ rte_stack_count(struct rte_stack *s) * @return * The number of free entries in the stack. */ -__rte_experimental static __rte_always_inline unsigned int rte_stack_free_count(struct rte_stack *s) { @@ -200,9 +180,6 @@ rte_stack_free_count(struct rte_stack *s) } /** - * @warning - * @b EXPERIMENTAL: this API may change without prior notice - * * Create a new stack named *name* in memory. * * This function uses ``memzone_reserve()`` to allocate memory for a stack of @@ -229,28 +206,20 @@ rte_stack_free_count(struct rte_stack *s) * - ENOMEM - insufficient memory to create the stack * - ENAMETOOLONG - name size exceeds RTE_STACK_NAMESIZE */ -__rte_experimental struct rte_stack * rte_stack_create(const char *name, unsigned int count, int socket_id, uint32_t flags); /** - * @warning - * @b EXPERIMENTAL: this API may change without prior notice - * * Free all memory used by the stack. * * @param s * Stack to free */ -__rte_experimental void rte_stack_free(struct rte_stack *s); /** - * @warning - * @b EXPERIMENTAL: this API may change without prior notice - * * Lookup a stack by its name. * * @param name @@ -261,7 +230,6 @@ rte_stack_free(struct rte_stack *s); * - ENOENT - Stack with name *name* not found. * - EINVAL - *name* pointer is NULL. */ -__rte_experimental struct rte_stack * rte_stack_lookup(const char *name); diff --git a/lib/librte_stack/rte_stack_lf.h b/lib/librte_stack/rte_stack_lf.h index e67630c27..eb106e64e 100644 --- a/lib/librte_stack/rte_stack_lf.h +++ b/lib/librte_stack/rte_stack_lf.h @@ -27,7 +27,6 @@ * @return * Actual number of objects enqueued. */ -__rte_experimental static __rte_always_inline unsigned int __rte_stack_lf_push(struct rte_stack *s, void * const *obj_table, @@ -66,7 +65,6 @@ __rte_stack_lf_push(struct rte_stack *s, * @return * - Actual number of objects popped. */ -__rte_experimental static __rte_always_inline unsigned int __rte_stack_lf_pop(struct rte_stack *s, void **obj_table, unsigned int n) { diff --git a/lib/librte_stack/rte_stack_std.h b/lib/librte_stack/rte_stack_std.h index 7142cbf8e..ae28add5c 100644 --- a/lib/librte_stack/rte_stack_std.h +++ b/lib/librte_stack/rte_stack_std.h @@ -19,7 +19,6 @@ * @return * Actual number of objects pushed (either 0 or *n*). */ -__rte_experimental static __rte_always_inline unsigned int __rte_stack_std_push(struct rte_stack *s, void * const *obj_table, unsigned int n) @@ -59,7 +58,6 @@ __rte_stack_std_push(struct rte_stack *s, void * const *obj_table, * @return * Actual number of objects popped (either 0 or *n*). */ -__rte_experimental static __rte_always_inline unsigned int __rte_stack_std_pop(struct rte_stack *s, void **obj_table, unsigned int n) { @@ -94,7 +92,6 @@ __rte_stack_std_pop(struct rte_stack *s, void **obj_table, unsigned int n) * @return * The number of used entries in the stack. */ -__rte_experimental static __rte_always_inline unsigned int __rte_stack_std_count(struct rte_stack *s) { diff --git a/lib/librte_stack/rte_stack_version.map b/lib/librte_stack/rte_stack_version.map index 6662679c3..8c4ca0245 100644 --- a/lib/librte_stack/rte_stack_version.map +++ b/lib/librte_stack/rte_stack_version.map @@ -1,4 +1,4 @@ -EXPERIMENTAL { +DPDK_21 { global: rte_stack_create; -- 2.13.6