From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id DBE10A00C5; Thu, 27 Oct 2022 11:47:19 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id CFEA842B85; Thu, 27 Oct 2022 11:47:19 +0200 (CEST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mails.dpdk.org (Postfix) with ESMTP id 724D9427F6 for ; Thu, 27 Oct 2022 11:47:18 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1666864038; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=fsgM99/kz6DYFcsAnmzE6UfHLhrwVTYSz18Tjb6Gtew=; b=aPTeiyWeugsqZVu79X0ROTwnayPqHN5p6aKhymScXebw00XmIMulRmA7uaa2NKftjCzIZj YARU3R/DT2z0uRgTnAojcXEMJsHAIDHvYC5KzIHa4Wves8qMm4qaiAqAaXGXbImdWYTGUA Qtc55CFhHHbb4wHYXb6h9q0NoES3sHo= Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-414-ruREiQ-0Nx2P1XCk6taE_w-1; Thu, 27 Oct 2022 05:47:13 -0400 X-MC-Unique: ruREiQ-0Nx2P1XCk6taE_w-1 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.rdu2.redhat.com [10.11.54.1]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id B11D287A9F0; Thu, 27 Oct 2022 09:47:12 +0000 (UTC) Received: from localhost.localdomain (ovpn-192-75.brq.redhat.com [10.40.192.75]) by smtp.corp.redhat.com (Postfix) with ESMTP id 1E5D640C83F2; Thu, 27 Oct 2022 09:47:08 +0000 (UTC) From: David Marchand To: dev@dpdk.org Cc: ferruh.yigit@amd.com, konstantin.v.ananyev@yandex.ru, john.mcnamara@intel.com, bruce.richardson@intel.com, thomas@monjalon.net, stephen@networkplumber.org Subject: [PATCH] flow_classify: mark library as deprecated Date: Thu, 27 Oct 2022 11:46:55 +0200 Message-Id: <20221027094655.1007047-1-david.marchand@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.1 on 10.11.54.1 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset="US-ASCII"; x-default=true X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org This library has no maintainer and, for now, nobody expressed interest in taking over. Mark this experimental library as deprecated and announce plan for removal in v23.11. Signed-off-by: David Marchand --- MAINTAINERS | 3 +-- doc/guides/prog_guide/flow_classify_lib.rst | 9 +++++++++ doc/guides/rel_notes/deprecation.rst | 6 ++++++ lib/flow_classify/rte_flow_classify.c | 3 +++ lib/meson.build | 5 ++++- meson_options.txt | 2 +- 6 files changed, 24 insertions(+), 4 deletions(-) diff --git a/MAINTAINERS b/MAINTAINERS index 2bd4a55f1b..89768d15ee 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1448,8 +1448,7 @@ F: doc/guides/prog_guide/ipsec_lib.rst M: Vladimir Medvedkin F: app/test-sad/ -Flow Classify - EXPERIMENTAL -M: Bernard Iremonger +Flow Classify - EXPERIMENTAL - UNMAINTAINED F: lib/flow_classify/ F: app/test/test_flow_classify* F: doc/guides/prog_guide/flow_classify_lib.rst diff --git a/doc/guides/prog_guide/flow_classify_lib.rst b/doc/guides/prog_guide/flow_classify_lib.rst index 7dae0bc8c6..ad2e10ec26 100644 --- a/doc/guides/prog_guide/flow_classify_lib.rst +++ b/doc/guides/prog_guide/flow_classify_lib.rst @@ -4,6 +4,15 @@ Flow Classification Library =========================== +.. note:: + + The Flow Classification library is deprecated and will be removed in future. + See :doc:`../rel_notes/deprecation`. + + It is disabled by default in the DPDK build. + To re-enable the library, remove 'flow_classify' from the "disable_libs" + meson option when configuring a build. + DPDK provides a Flow Classification library that provides the ability to classify an input packet by matching it against a set of Flow rules. diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 05cacb3ea8..e2efa2f8b0 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -96,3 +96,9 @@ Deprecation Notices to have another parameter ``qp_id`` to return the queue pair ID which got error interrupt to the application, so that application can reset that particular queue pair. + +* flow_classify: The flow_classify library and example have no maintainer. + The library is experimental and, as such, it could be removed from DPDK. + Its removal has been postponed to let potential users report interest + in maintaining it. + In the absence of such interest, this library will be removed in DPDK 23.11. diff --git a/lib/flow_classify/rte_flow_classify.c b/lib/flow_classify/rte_flow_classify.c index e3667306e5..60ca319f24 100644 --- a/lib/flow_classify/rte_flow_classify.c +++ b/lib/flow_classify/rte_flow_classify.c @@ -259,6 +259,9 @@ rte_flow_classifier_create(struct rte_flow_classifier_params *params) struct rte_flow_classifier *cls; int ret; + RTE_FLOW_CLASSIFY_LOG(WARNING, + "WARNING: flow_classify is deprecated and will be removed in DPDK 23.11\n"); + /* Check input parameters */ ret = rte_flow_classifier_check_params(params); if (ret != 0) { diff --git a/lib/meson.build b/lib/meson.build index c51cdc24fa..1f802bc456 100644 --- a/lib/meson.build +++ b/lib/meson.build @@ -85,7 +85,10 @@ optional_libs = [ 'vhost', ] -dpdk_libs_deprecated += ['kni'] +dpdk_libs_deprecated += [ + 'flow_classify', + 'kni', +] disabled_libs = [] opt_disabled_libs = run_command(list_dir_globs, get_option('disable_libs'), diff --git a/meson_options.txt b/meson_options.txt index 5de1b3ed23..ce26a8a2ec 100644 --- a/meson_options.txt +++ b/meson_options.txt @@ -8,7 +8,7 @@ option('developer_mode', type: 'feature', description: 'turn on additional build checks relevant for DPDK developers') option('disable_drivers', type: 'string', value: '', description: 'Comma-separated list of drivers to explicitly disable.') -option('disable_libs', type: 'string', value: 'kni', description: +option('disable_libs', type: 'string', value: 'flow_classify,kni', description: 'Comma-separated list of libraries to explicitly disable. [NOTE: not all libs can be disabled]') option('drivers_install_subdir', type: 'string', value: 'dpdk/pmds-', description: 'Subdirectory of libdir where to install PMDs. Defaults to using a versioned subdirectory.') -- 2.37.3