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 545FEA0C41 for ; Tue, 30 Nov 2021 17:39:10 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 4C8D841186; Tue, 30 Nov 2021 17:39:10 +0100 (CET) Received: from smtp-relay-internal-1.canonical.com (smtp-relay-internal-1.canonical.com [185.125.188.123]) by mails.dpdk.org (Postfix) with ESMTP id 0239B41148 for ; Tue, 30 Nov 2021 17:39:09 +0100 (CET) Received: from mail-ed1-f72.google.com (mail-ed1-f72.google.com [209.85.208.72]) (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 smtp-relay-internal-1.canonical.com (Postfix) with ESMTPS id D41E94000A for ; Tue, 30 Nov 2021 16:39:08 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=canonical.com; s=20210705; t=1638290348; bh=pFNsf5Izqde2sdov7qsxhgOfOtcekomLk+mIoNwTA4c=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=QC6V7JVEKyby/BREbWstmmtxq6rA/E4geFRThNf3kZxsfzjqAdQtllrdS/i1p19Xm Naqpy6HSyxIN4vIONasP+gqpNGu4LNbUDTsxvbDXAb7SlJXzMgTQ1qBme7ZqK4sCpP f28SB3jzPAP6+VBJuRvkxNmA3mqYJYg605GyMKI2Cympgb1AOR7T1q1JAIX4HLHWAz LRYjBOQxXOI4dhhNFUlCIWCY7SdfNoknKADYuNdTXcrx7gwmrb7q3ChNvdh4wnHMOW /oDHbonQyXY0mk6uYOoa9FvA6uSLk27lktZzh03ePGkScLxrCRV3nc7IFfw2nQp6gL Xp7rBAalRjgDQ== Received: by mail-ed1-f72.google.com with SMTP id w4-20020aa7cb44000000b003e7c0f7cfffso17490280edt.2 for ; Tue, 30 Nov 2021 08:39:08 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=pFNsf5Izqde2sdov7qsxhgOfOtcekomLk+mIoNwTA4c=; b=SGIQbho/rMDc8BaZcLv+G8rAKKY9GUnm0qvvzaqSs9x428oEj4tZpUX6a2QD0AW78m 6lD955FbZL3Q3jZwrrKMZ7zjJu0STg8th4s2imNWC8W7eUcpp9y4YUSmtW94JjrDzahU EaT9d7EheXB2rI6wRK9VN8cqX+n1bqaQFUytezXGlm/kvLp+7xvkvPOqW+jlsbM/3ytH 4zkXfK0MMdK/vy77eFKnFnubmIku8tSna92CeTkcXNx8OwVSqELF+k9uWjckK1Np1fbE RPlLOwYEVo9jdMr1N4+QevavKrwVEpSbmhGjy9HxjLIgQI1DWGe+jpFafHr0qZ5cfq5V 4I8Q== X-Gm-Message-State: AOAM530ZmJI1dnWQYZNHQUhr0I+qi2mxlXhqkt772bUroq4stPeDd0KS g9tCdr1ZsApJbgs3iJzDcXhKyU6GtHwohn4damszrZlD57oebSA4YIJ97ZUJoL0DnO0D7r7yyG/ B/hdDF6vpgi6plRWn3yBsNEIQ X-Received: by 2002:a50:d492:: with SMTP id s18mr42137edi.145.1638290347223; Tue, 30 Nov 2021 08:39:07 -0800 (PST) X-Google-Smtp-Source: ABdhPJyw5XnTHcb7G1fktClUp8J3BC84Z4PaBtFrampA+1BBhsWxGUfurcGmc1feI0CyiW8EnmjJ6w== X-Received: by 2002:a50:d492:: with SMTP id s18mr42115edi.145.1638290347068; Tue, 30 Nov 2021 08:39:07 -0800 (PST) Received: from localhost.localdomain ([2001:67c:1560:8007::aac:c4ad]) by smtp.gmail.com with ESMTPSA id v13sm9034212ejo.36.2021.11.30.08.39.06 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 30 Nov 2021 08:39:06 -0800 (PST) From: christian.ehrhardt@canonical.com To: Ivan Ilchenko Cc: Andrew Rybchenko , Andy Moreton , Ferruh Yigit , dpdk stable Subject: patch 'ethdev: fix xstats by ID API documentation' has been queued to stable release 19.11.11 Date: Tue, 30 Nov 2021 17:34:21 +0100 Message-Id: <20211130163605.2460997-57-christian.ehrhardt@canonical.com> X-Mailer: git-send-email 2.34.0 In-Reply-To: <20211130163605.2460997-1-christian.ehrhardt@canonical.com> References: <20211130163605.2460997-1-christian.ehrhardt@canonical.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit 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 Hi, FYI, your patch has been queued to stable release 19.11.11 Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet. It will be pushed if I get no objections before December 10th 2021. So please shout if anyone has objections. Also note that after the patch there's a diff of the upstream commit vs the patch applied to the branch. This will indicate if there was any rebasing needed to apply to the stable branch. If there were code changes for rebasing (ie: not only metadata diffs), please double check that the rebase was correctly done. Queued patches are on a temporary branch at: https://github.com/cpaelzer/dpdk-stable-queue This queued commit can be viewed at: https://github.com/cpaelzer/dpdk-stable-queue/commit/e40ae0091cb7378988e62858eaeb014fd107a772 Thanks. Christian Ehrhardt --- >From e40ae0091cb7378988e62858eaeb014fd107a772 Mon Sep 17 00:00:00 2001 From: Ivan Ilchenko Date: Fri, 1 Oct 2021 12:07:19 +0300 Subject: [PATCH] ethdev: fix xstats by ID API documentation [ upstream commit bc5112ca599c1e565c0f2d3dc3de0f73381a8c05 ] Document valid combinations of input arguments in accordance with current implementation in ethdev. Fixes: 79c913a42f0e ("ethdev: retrieve xstats by ID") Signed-off-by: Ivan Ilchenko Signed-off-by: Andrew Rybchenko Reviewed-by: Andy Moreton Reviewed-by: Ferruh Yigit --- lib/librte_ethdev/rte_ethdev.h | 35 ++++++++++++++++++---------------- 1 file changed, 19 insertions(+), 16 deletions(-) diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h index d42226daa3..091a77bf21 100644 --- a/lib/librte_ethdev/rte_ethdev.h +++ b/lib/librte_ethdev/rte_ethdev.h @@ -2384,21 +2384,23 @@ int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats, * @param port_id * The port identifier of the Ethernet device. * @param xstats_names - * An rte_eth_xstat_name array of at least *size* elements to - * be filled. If set to NULL, the function returns the required number - * of elements. - * @param ids - * IDs array given by app to retrieve specific statistics + * Array to be filled in with names of requested device statistics. + * Must not be NULL if @p ids are specified (not NULL). * @param size - * The size of the xstats_names array (number of elements). + * Number of elements in @p xstats_names array (if not NULL) and in + * @p ids array (if not NULL). Must be 0 if both array pointers are NULL. + * @param ids + * IDs array given by app to retrieve specific statistics. May be NULL to + * retrieve names of all available statistics or, if @p xstats_names is + * NULL as well, just the number of available statistics. * @return * - A positive value lower or equal to size: success. The return value * is the number of entries filled in the stats table. - * - A positive value higher than size: error, the given statistics table + * - A positive value higher than size: success. The given statistics table * is too small. The return value corresponds to the size that should * be given to succeed. The entries in the table are not valid and * shall not be used by the caller. - * - A negative value on error (invalid port id). + * - A negative value on error. */ int rte_eth_xstats_get_names_by_id(uint16_t port_id, @@ -2411,22 +2413,23 @@ rte_eth_xstats_get_names_by_id(uint16_t port_id, * @param port_id * The port identifier of the Ethernet device. * @param ids - * A pointer to an ids array passed by application. This tells which - * statistics values function should retrieve. This parameter - * can be set to NULL if size is 0. In this case function will retrieve - * all available statistics. + * IDs array given by app to retrieve specific statistics. May be NULL to + * retrieve all available statistics or, if @p values is NULL as well, + * just the number of available statistics. * @param values - * A pointer to a table to be filled with device statistics values. + * Array to be filled in with requested device statistics. + * Must not be NULL if ids are specified (not NULL). * @param size - * The size of the ids array (number of elements). + * Number of elements in @p values array (if not NULL) and in @p ids + * array (if not NULL). Must be 0 if both array pointers are NULL. * @return * - A positive value lower or equal to size: success. The return value * is the number of entries filled in the stats table. - * - A positive value higher than size: error, the given statistics table + * - A positive value higher than size: success: The given statistics table * is too small. The return value corresponds to the size that should * be given to succeed. The entries in the table are not valid and * shall not be used by the caller. - * - A negative value on error (invalid port id). + * - A negative value on error. */ int rte_eth_xstats_get_by_id(uint16_t port_id, const uint64_t *ids, uint64_t *values, unsigned int size); -- 2.34.0 --- Diff of the applied patch vs upstream commit (please double-check if non-empty: --- --- - 2021-11-30 16:50:09.338805055 +0100 +++ 0057-ethdev-fix-xstats-by-ID-API-documentation.patch 2021-11-30 16:50:05.714872972 +0100 @@ -1 +1 @@ -From bc5112ca599c1e565c0f2d3dc3de0f73381a8c05 Mon Sep 17 00:00:00 2001 +From e40ae0091cb7378988e62858eaeb014fd107a772 Mon Sep 17 00:00:00 2001 @@ -5,0 +6,2 @@ +[ upstream commit bc5112ca599c1e565c0f2d3dc3de0f73381a8c05 ] + @@ -10 +11,0 @@ -Cc: stable@dpdk.org @@ -17 +18 @@ - lib/ethdev/rte_ethdev.h | 35 +++++++++++++++++++---------------- + lib/librte_ethdev/rte_ethdev.h | 35 ++++++++++++++++++---------------- @@ -20,5 +21,5 @@ -diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h -index afdc53b674..2ad2bf2019 100644 ---- a/lib/ethdev/rte_ethdev.h -+++ b/lib/ethdev/rte_ethdev.h -@@ -2896,21 +2896,23 @@ int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats, +diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h +index d42226daa3..091a77bf21 100644 +--- a/lib/librte_ethdev/rte_ethdev.h ++++ b/lib/librte_ethdev/rte_ethdev.h +@@ -2384,21 +2384,23 @@ int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats, @@ -56 +57 @@ -@@ -2923,22 +2925,23 @@ rte_eth_xstats_get_names_by_id(uint16_t port_id, +@@ -2411,22 +2413,23 @@ rte_eth_xstats_get_names_by_id(uint16_t port_id,