From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by dpdk.org (Postfix) with ESMTP id 5F3FC1B1EC for ; Thu, 22 Nov 2018 03:57:29 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga102.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 21 Nov 2018 18:57:28 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.56,263,1539673200"; d="scan'208";a="283163121" Received: from btwcube1.sh.intel.com ([10.67.104.173]) by fmsmga006.fm.intel.com with ESMTP; 21 Nov 2018 18:57:27 -0800 From: Tiwei Bie To: dev@dpdk.org Cc: reshma.pattan@intel.com Date: Thu, 22 Nov 2018 10:55:41 +0800 Message-Id: <20181122025541.2120-1-tiwei.bie@intel.com> X-Mailer: git-send-email 2.14.5 Subject: [dpdk-dev] [RFC] pdump: remove deprecated APIs 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: , X-List-Received-Date: Thu, 22 Nov 2018 02:57:30 -0000 We already changed to use generic IPC in pdump since below commit: commit 660098d61f57 ("pdump: use generic multi-process channel") The `rte_pdump_set_socket_dir()`, the `path` parameter of `rte_pdump_init()` and the `enum rte_pdump_socktype` have been deprecated since then. This commit removes these deprecated APIs and also bumps the pdump ABI. Signed-off-by: Tiwei Bie --- This patch is marked as RFC because the API and ABI changes should also be documented by this patch in the `release_19_02.rst` which doesn't exist currently. I will send a new version once we have it. app/test-pmd/testpmd.c | 2 +- doc/guides/prog_guide/pdump_lib.rst | 14 ++------------ doc/guides/rel_notes/deprecation.rst | 7 ------- lib/librte_pdump/Makefile | 2 +- lib/librte_pdump/meson.build | 2 +- lib/librte_pdump/rte_pdump.c | 9 +-------- lib/librte_pdump/rte_pdump.h | 34 +--------------------------------- lib/librte_pdump/rte_pdump_version.map | 1 - 8 files changed, 7 insertions(+), 64 deletions(-) diff --git a/app/test-pmd/testpmd.c b/app/test-pmd/testpmd.c index 4c75587d0..a10bc40bb 100644 --- a/app/test-pmd/testpmd.c +++ b/app/test-pmd/testpmd.c @@ -3104,7 +3104,7 @@ main(int argc, char** argv) #ifdef RTE_LIBRTE_PDUMP /* initialize packet capture framework */ - rte_pdump_init(NULL); + rte_pdump_init(); #endif count = 0; diff --git a/doc/guides/prog_guide/pdump_lib.rst b/doc/guides/prog_guide/pdump_lib.rst index ed3c15e58..afb5b3411 100644 --- a/doc/guides/prog_guide/pdump_lib.rst +++ b/doc/guides/prog_guide/pdump_lib.rst @@ -34,10 +34,6 @@ or disable the packet capture, and to uninitialize it: * ``rte_pdump_uninit()``: This API uninitializes the packet capture framework. -* ``rte_pdump_set_socket_dir()``: - This API sets the server and client socket paths. - Note: This API is not thread-safe. - Operation --------- @@ -60,8 +56,8 @@ enabling or disabling the packet capture. Implementation Details ---------------------- -The library API ``rte_pdump_init()``, initializes the packet capture framework by creating the pthread and the server -socket. The server socket in the pthread context will be listening to the client requests to enable or disable the +The library API ``rte_pdump_init()``, initializes the packet capture framework by creating the pdump server by calling +``rte_mp_action_register()`` function. The server will listen to the client requests to enable or disable the packet capture. The library APIs ``rte_pdump_enable()`` and ``rte_pdump_enable_by_deviceid()`` enables the packet capture. @@ -82,12 +78,6 @@ received from the server, the client socket is closed. The library API ``rte_pdump_uninit()``, uninitializes the packet capture framework by closing the pthread and the server socket. -The library API ``rte_pdump_set_socket_dir()``, sets the given path as either server socket path -or client socket path based on the ``type`` argument of the API. -If the given path is ``NULL``, default path will be selected, i.e. either ``/var/run/.dpdk`` for root user or ``~/.dpdk`` -for non root user. Clients also need to call this API to set their server socket path if the server socket -path is different from default path. - Use Case: Packet Capturing -------------------------- diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 34b28234c..586bf98c5 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -48,10 +48,3 @@ Deprecation Notices PMDs that implement the latter. Target release for removal of the legacy API will be defined once most PMDs have switched to rte_flow. - -* pdump: As we changed to use generic IPC, some changes in APIs and structure - are expected in subsequent release. - - - ``rte_pdump_set_socket_dir`` will be removed; - - The parameter, ``path``, of ``rte_pdump_init`` will be removed; - - The enum ``rte_pdump_socktype`` will be removed. diff --git a/lib/librte_pdump/Makefile b/lib/librte_pdump/Makefile index b241151dc..89593689a 100644 --- a/lib/librte_pdump/Makefile +++ b/lib/librte_pdump/Makefile @@ -12,7 +12,7 @@ LDLIBS += -lrte_eal -lrte_mempool -lrte_mbuf -lrte_ethdev EXPORT_MAP := rte_pdump_version.map -LIBABIVER := 2 +LIBABIVER := 3 # all source are stored in SRCS-y SRCS-$(CONFIG_RTE_LIBRTE_PDUMP) := rte_pdump.c diff --git a/lib/librte_pdump/meson.build b/lib/librte_pdump/meson.build index be80904b9..b4b4f26c5 100644 --- a/lib/librte_pdump/meson.build +++ b/lib/librte_pdump/meson.build @@ -1,7 +1,7 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2017 Intel Corporation -version = 2 +version = 3 sources = files('rte_pdump.c') headers = files('rte_pdump.h') allow_experimental_apis = true diff --git a/lib/librte_pdump/rte_pdump.c b/lib/librte_pdump/rte_pdump.c index 6c3a88581..4f38ac58b 100644 --- a/lib/librte_pdump/rte_pdump.c +++ b/lib/librte_pdump/rte_pdump.c @@ -406,7 +406,7 @@ pdump_server(const struct rte_mp_msg *mp_msg, const void *peer) } int -rte_pdump_init(const char *path __rte_unused) +rte_pdump_init(void) { return rte_mp_action_register(PDUMP_MP, pdump_server); } @@ -616,10 +616,3 @@ rte_pdump_disable_by_deviceid(char *device_id, uint16_t queue, return ret; } - -int -rte_pdump_set_socket_dir(const char *path __rte_unused, - enum rte_pdump_socktype type __rte_unused) -{ - return 0; -} diff --git a/lib/librte_pdump/rte_pdump.h b/lib/librte_pdump/rte_pdump.h index 673a2b070..6b00fc17a 100644 --- a/lib/librte_pdump/rte_pdump.h +++ b/lib/librte_pdump/rte_pdump.h @@ -29,25 +29,16 @@ enum { RTE_PDUMP_FLAG_RXTX = (RTE_PDUMP_FLAG_RX|RTE_PDUMP_FLAG_TX) }; -enum rte_pdump_socktype { - RTE_PDUMP_SOCKET_SERVER = 1, - RTE_PDUMP_SOCKET_CLIENT = 2 -}; - /** * Initialize packet capturing handling * * Register the IPC action for communication with target (primary) process. * - * @param path - * This parameter is going to be deprecated; it was used for specifying the - * directory path for server socket. - * * @return * 0 on success, -1 on error */ int -rte_pdump_init(const char *path); +rte_pdump_init(void); /** * Un initialize packet capturing handling @@ -162,29 +153,6 @@ int rte_pdump_disable_by_deviceid(char *device_id, uint16_t queue, uint32_t flags); -/** - * @deprecated - * Allows applications to set server and client socket paths. - * If specified path is null default path will be selected, i.e. - *"/var/run/" for root user and "$HOME" for non root user. - * Clients also need to call this API to set their server path if the - * server path is different from default path. - * This API is not thread-safe. - * - * @param path - * directory path for server or client socket. - * @param type - * specifies RTE_PDUMP_SOCKET_SERVER if socket path is for server. - * (or) - * specifies RTE_PDUMP_SOCKET_CLIENT if socket path is for client. - * - * @return - * 0 on success, -EINVAL on error - * - */ -__rte_deprecated int -rte_pdump_set_socket_dir(const char *path, enum rte_pdump_socktype type); - #ifdef __cplusplus } #endif diff --git a/lib/librte_pdump/rte_pdump_version.map b/lib/librte_pdump/rte_pdump_version.map index edec99a41..3e744f301 100644 --- a/lib/librte_pdump/rte_pdump_version.map +++ b/lib/librte_pdump/rte_pdump_version.map @@ -6,7 +6,6 @@ DPDK_16.07 { rte_pdump_enable; rte_pdump_enable_by_deviceid; rte_pdump_init; - rte_pdump_set_socket_dir; rte_pdump_uninit; local: *; -- 2.14.5