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 95B1E45A9D for ; Wed, 2 Oct 2024 17:57:42 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 846CE4064C; Wed, 2 Oct 2024 17:57:42 +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 41BF14060A for ; Wed, 2 Oct 2024 17:57:41 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1727884660; 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: in-reply-to:in-reply-to:references:references; bh=+tj4h5dys3R9x4L0BIv8WT7a6YZnXYh91NCESDnz0ZI=; b=aL9gozLIvW9y6BnZjYr8ehBz9Uq2flVQTSqIoDnzJqGA6aekh9h8ZzqI5floJp37e8RsaR 9MzTmNZDYsu4zp+VuYN2irSgkoRThU8l5iQy2Ija12SPDRiAD+noZ6UpPrqmlKBN+cM9jg BNDcQ+xoeuowy2ITnX+wEGUNqe/rMS0= Received: from mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-108-2cqZgilrNPGVNfUcu3t9AA-1; Wed, 02 Oct 2024 11:57:39 -0400 X-MC-Unique: 2cqZgilrNPGVNfUcu3t9AA-1 Received: from mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.15]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 9E7441977034; Wed, 2 Oct 2024 15:57:37 +0000 (UTC) Received: from dmarchan.redhat.com (unknown [10.45.224.68]) by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 1B4731956088; Wed, 2 Oct 2024 15:57:33 +0000 (UTC) From: David Marchand To: dev@dpdk.org Cc: bruce.richardson@intel.com, rjarry@redhat.com, ktraynor@redhat.com, stable@dpdk.org, Thomas Monjalon , Ferruh Yigit , Andrew Rybchenko , Keith Wiles , Ciara Power Subject: [PATCH 2/2] ethdev: fix race on ports for telemetry commands Date: Wed, 2 Oct 2024 17:57:08 +0200 Message-ID: <20241002155709.2522273-3-david.marchand@redhat.com> In-Reply-To: <20241002155709.2522273-1-david.marchand@redhat.com> References: <20241002155709.2522273-1-david.marchand@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.15 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: stable@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: stable-bounces@dpdk.org While invoking telemetry commands (which may happen at any time, out of control of the application), an application thread may concurrently add/remove ports. The telemetry callbacks may then access partially initialised/uninitialised ethdev data. Reuse the ethdev lock that protects port allocation/destruction. Fixes: c190daedb9b1 ("ethdev: add telemetry callbacks") Cc: stable@dpdk.org Signed-off-by: David Marchand --- lib/ethdev/rte_ethdev_telemetry.c | 93 +++++++++++++++++++------------ 1 file changed, 56 insertions(+), 37 deletions(-) diff --git a/lib/ethdev/rte_ethdev_telemetry.c b/lib/ethdev/rte_ethdev_telemetry.c index 8031a58595..7f9c924209 100644 --- a/lib/ethdev/rte_ethdev_telemetry.c +++ b/lib/ethdev/rte_ethdev_telemetry.c @@ -6,6 +6,7 @@ #include #include +#include #include #include "rte_ethdev.h" @@ -1403,43 +1404,61 @@ eth_dev_handle_port_tm_node_caps(const char *cmd __rte_unused, return ret; } +#define ETHDEV_TELEMETRY_HANDLERS \ + ETHDEV_TELEMETRY_HANDLER("/ethdev/list", eth_dev_handle_port_list, \ + "Returns list of available ethdev ports. Takes no parameters") \ + ETHDEV_TELEMETRY_HANDLER("/ethdev/stats", eth_dev_handle_port_stats, \ + "Returns the common stats for a port. Parameters: int port_id") \ + ETHDEV_TELEMETRY_HANDLER("/ethdev/xstats", eth_dev_handle_port_xstats, \ + "Returns the extended stats for a port. Parameters: int port_id,hide_zero=true|false(Optional for indicates hide zero xstats)") \ + ETHDEV_TELEMETRY_HANDLER("/ethdev/dump_priv", eth_dev_handle_port_dump_priv, \ + "Returns dump private information for a port. Parameters: int port_id") \ + ETHDEV_TELEMETRY_HANDLER("/ethdev/link_status", eth_dev_handle_port_link_status, \ + "Returns the link status for a port. Parameters: int port_id") \ + ETHDEV_TELEMETRY_HANDLER("/ethdev/info", eth_dev_handle_port_info, \ + "Returns the device info for a port. Parameters: int port_id") \ + ETHDEV_TELEMETRY_HANDLER("/ethdev/module_eeprom", eth_dev_handle_port_module_eeprom, \ + "Returns module EEPROM info with SFF specs. Parameters: int port_id") \ + ETHDEV_TELEMETRY_HANDLER("/ethdev/macs", eth_dev_handle_port_macs, \ + "Returns the MAC addresses for a port. Parameters: int port_id") \ + ETHDEV_TELEMETRY_HANDLER("/ethdev/flow_ctrl", eth_dev_handle_port_flow_ctrl, \ + "Returns flow ctrl info for a port. Parameters: int port_id") \ + ETHDEV_TELEMETRY_HANDLER("/ethdev/rx_queue", eth_dev_handle_port_rxq, \ + "Returns Rx queue info for a port. Parameters: int port_id, int queue_id (Optional if only one queue)") \ + ETHDEV_TELEMETRY_HANDLER("/ethdev/tx_queue", eth_dev_handle_port_txq, \ + "Returns Tx queue info for a port. Parameters: int port_id, int queue_id (Optional if only one queue)") \ + ETHDEV_TELEMETRY_HANDLER("/ethdev/dcb", eth_dev_handle_port_dcb, \ + "Returns DCB info for a port. Parameters: int port_id") \ + ETHDEV_TELEMETRY_HANDLER("/ethdev/rss_info", eth_dev_handle_port_rss_info, \ + "Returns RSS info for a port. Parameters: int port_id") \ + ETHDEV_TELEMETRY_HANDLER("/ethdev/fec", eth_dev_handle_port_fec, \ + "Returns FEC info for a port. Parameters: int port_id") \ + ETHDEV_TELEMETRY_HANDLER("/ethdev/vlan", eth_dev_handle_port_vlan, \ + "Returns VLAN info for a port. Parameters: int port_id") \ + ETHDEV_TELEMETRY_HANDLER("/ethdev/tm_capability", eth_dev_handle_port_tm_caps, \ + "Returns TM Capabilities info for a port. Parameters: int port_id") \ + ETHDEV_TELEMETRY_HANDLER("/ethdev/tm_level_capability", eth_dev_handle_port_tm_level_caps, \ + "Returns TM Level Capabilities info for a port. Parameters: int port_id, int level_id (see tm_capability for the max)") \ + ETHDEV_TELEMETRY_HANDLER("/ethdev/tm_node_capability", eth_dev_handle_port_tm_node_caps, \ + "Returns TM Node Capabilities info for a port. Parameters: int port_id, int node_id (see tm_capability for the max)") + +#define ETHDEV_TELEMETRY_HANDLER(command, func, usage) \ +static int func ## _locked(const char *cmd __rte_unused, const char *params, \ + struct rte_tel_data *d) \ +{ \ + int ret; \ + rte_spinlock_lock(rte_mcfg_ethdev_get_lock()); \ + ret = func(cmd, params, d); \ + rte_spinlock_unlock(rte_mcfg_ethdev_get_lock()); \ + return ret; \ +} +ETHDEV_TELEMETRY_HANDLERS +#undef ETHDEV_TELEMETRY_HANDLER + RTE_INIT(ethdev_init_telemetry) { - rte_telemetry_register_cmd("/ethdev/list", eth_dev_handle_port_list, - "Returns list of available ethdev ports. Takes no parameters"); - rte_telemetry_register_cmd("/ethdev/stats", eth_dev_handle_port_stats, - "Returns the common stats for a port. Parameters: int port_id"); - rte_telemetry_register_cmd("/ethdev/xstats", eth_dev_handle_port_xstats, - "Returns the extended stats for a port. Parameters: int port_id,hide_zero=true|false(Optional for indicates hide zero xstats)"); - rte_telemetry_register_cmd("/ethdev/dump_priv", eth_dev_handle_port_dump_priv, - "Returns dump private information for a port. Parameters: int port_id"); - rte_telemetry_register_cmd("/ethdev/link_status", - eth_dev_handle_port_link_status, - "Returns the link status for a port. Parameters: int port_id"); - rte_telemetry_register_cmd("/ethdev/info", eth_dev_handle_port_info, - "Returns the device info for a port. Parameters: int port_id"); - rte_telemetry_register_cmd("/ethdev/module_eeprom", eth_dev_handle_port_module_eeprom, - "Returns module EEPROM info with SFF specs. Parameters: int port_id"); - rte_telemetry_register_cmd("/ethdev/macs", eth_dev_handle_port_macs, - "Returns the MAC addresses for a port. Parameters: int port_id"); - rte_telemetry_register_cmd("/ethdev/flow_ctrl", eth_dev_handle_port_flow_ctrl, - "Returns flow ctrl info for a port. Parameters: int port_id"); - rte_telemetry_register_cmd("/ethdev/rx_queue", eth_dev_handle_port_rxq, - "Returns Rx queue info for a port. Parameters: int port_id, int queue_id (Optional if only one queue)"); - rte_telemetry_register_cmd("/ethdev/tx_queue", eth_dev_handle_port_txq, - "Returns Tx queue info for a port. Parameters: int port_id, int queue_id (Optional if only one queue)"); - rte_telemetry_register_cmd("/ethdev/dcb", eth_dev_handle_port_dcb, - "Returns DCB info for a port. Parameters: int port_id"); - rte_telemetry_register_cmd("/ethdev/rss_info", eth_dev_handle_port_rss_info, - "Returns RSS info for a port. Parameters: int port_id"); - rte_telemetry_register_cmd("/ethdev/fec", eth_dev_handle_port_fec, - "Returns FEC info for a port. Parameters: int port_id"); - rte_telemetry_register_cmd("/ethdev/vlan", eth_dev_handle_port_vlan, - "Returns VLAN info for a port. Parameters: int port_id"); - rte_telemetry_register_cmd("/ethdev/tm_capability", eth_dev_handle_port_tm_caps, - "Returns TM Capabilities info for a port. Parameters: int port_id"); - rte_telemetry_register_cmd("/ethdev/tm_level_capability", eth_dev_handle_port_tm_level_caps, - "Returns TM Level Capabilities info for a port. Parameters: int port_id, int level_id (see tm_capability for the max)"); - rte_telemetry_register_cmd("/ethdev/tm_node_capability", eth_dev_handle_port_tm_node_caps, - "Returns TM Node Capabilities info for a port. Parameters: int port_id, int node_id (see tm_capability for the max)"); +#define ETHDEV_TELEMETRY_HANDLER(command, func, usage) \ + rte_telemetry_register_cmd(command, func ## _locked, usage); + ETHDEV_TELEMETRY_HANDLERS +#undef ETHDEV_TELEMETRY_HANDLER } -- 2.46.2