From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from ws5-mx01.kavi.com (ws5-mx01.kavi.com [34.193.7.191]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id C130DC77B61 for ; Fri, 28 Apr 2023 04:21:49 +0000 (UTC) Received: from lists.oasis-open.org (oasis.ws5.connectedcommunity.org [10.110.1.242]) by ws5-mx01.kavi.com (Postfix) with ESMTP id AEA8016E5A3 for ; Fri, 28 Apr 2023 04:20:46 +0000 (UTC) Received: from lists.oasis-open.org (oasis-open.org [10.110.1.242]) by lists.oasis-open.org (Postfix) with ESMTP id C724D9867A3 for ; Fri, 28 Apr 2023 04:20:44 +0000 (UTC) Received: from host09.ws5.connectedcommunity.org (host09.ws5.connectedcommunity.org [10.110.1.97]) by lists.oasis-open.org (Postfix) with QMQP id 6FEB198674B; Fri, 28 Apr 2023 04:20:43 +0000 (UTC) Mailing-List: contact virtio-dev-help@lists.oasis-open.org; run by ezmlm List-ID: Sender: Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: Received: from lists.oasis-open.org (oasis-open.org [10.110.1.242]) by lists.oasis-open.org (Postfix) with ESMTP id 9A375986720; Fri, 28 Apr 2023 04:20:30 +0000 (UTC) X-Virus-Scanned: amavisd-new at kavi.com ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=M7rtWaeGdNMIx+B8Wk6SqcFRd9/pCvF1AafnetG2e2acGe7ttjnFQkExpCCPJCgRLlSNRv9mm4mAFtxlzspa2NPiT5JFdo4r6CazecInwJ7xTrdCn7fV156BdOP2OBklp+e/cYJrNOz5Z/fnctgnIIbNsy53ffs5DfdL9GcW/G1qORVRAon4wrRpiSXntyKwcNxw9XuIys4Pu/moYmq/g6htZ6Dgb7FPzx/eRYPKb/0bbif0MN/uNSRB7ytCYozgy+3Qu5lIlt25c3fpoUVIvdKl2xZvTF4q1o406JHFqpXqSe9XzF/fXLaMODne+DnBk218/yfbzFjcZNyuOAO2yw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=r9YGl9r3NuS6oqLdlkZBlgEl2TruAG+3nMC0NxbRlR4=; b=PloKAgZJ5oTrY/c8QRBWFvq8Pjiat16eaI1ZVMotD0J0LOoIEeAW1L7N9hj2vBn/6UoFoxeqOPUe1YMFg4bSdaZ5YUkmfStV12pIHuZ+99a5MwRkUAtUBEJ2lwM8uAkMOl77YvwlGAZsTH0EKx/mNu1RmwTUeS376xwedgqpreN/PowFHSQHRc8cBSgtuDPjgWD1KVffpNmNPbs3+PawEnPSVij7UN3rx3RUEaI2lJXMzL8dNtF5D6AVB+mMarWCeZWdeqxgkPSfjlbiNX0z3ECdA3kRgO3ZHm2iTf1Z9o6q+I0uams7P1xemm45yIAnI436+zuzufS7iIewpN6+gw== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 216.228.117.161) smtp.rcpttodomain=redhat.com smtp.mailfrom=nvidia.com; dmarc=pass (p=reject sp=reject pct=100) action=none header.from=nvidia.com; dkim=none (message not signed); arc=none X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 216.228.117.161) smtp.mailfrom=nvidia.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=nvidia.com; Received-SPF: Pass (protection.outlook.com: domain of nvidia.com designates 216.228.117.161 as permitted sender) receiver=protection.outlook.com; client-ip=216.228.117.161; helo=mail.nvidia.com; pr=C From: Parav Pandit To: , , CC: , , , , Parav Pandit Date: Fri, 28 Apr 2023 07:19:48 +0300 Message-ID: <20230428041949.411221-11-parav@nvidia.com> X-Mailer: git-send-email 2.26.2 In-Reply-To: <20230428041949.411221-1-parav@nvidia.com> References: <20230428041949.411221-1-parav@nvidia.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-Originating-IP: [10.126.231.37] X-ClientProxiedBy: rnnvmail203.nvidia.com (10.129.68.9) To rnnvmail201.nvidia.com (10.129.68.8) X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: BN8NAM11FT051:EE_|MN2PR12MB4424:EE_ X-MS-Office365-Filtering-Correlation-Id: 7980a03f-e104-48af-8670-08db479fe479 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: O4SMzuwxQFlO0VhlT9GQvoMMMgyBI+Rxee4cMEiS5f3HdF8MUSEK50Cfm+Nt/MQn45U7Mai/czeiP5KmvRI0b1mN/h+cf9nQUbVZTZYAaTK1qJDNqM8MdYP34upqZuBgYQy9RH2NcVcE7MjfZQ2pPivLUzQUHheGlsPPhRDplbxlppeW9aj5EEz9peQTxX8128XyPxkaDEt/qqnsSS+O0/6+luxroBWMXZjVMLS/rK5U7ZUdZPOwCTAHcvBDTAY/inXFFnSRfUi7ryd7eLWCKxN4UE1W0ZbRhp+/nqN3hAab3TUzwBY82Tar6+XdkTI2d9r4jcmSGr7KSi791o+HC0iJ8BHX/EQlKzqes5/OIkr67GFtesufs8K5g6glldpfY3AvT3YyelQoiqlgoMx+MHVbKjOSZn5lCpeUssOrtEfL3PFWxTYBc+Z1xekFHZSf3hs/VcK6QZF7CvR6nDrin5DT/gezQJipvqVPctUci6szxqu+/zPhH07opN8cvlENr5qKVGW7hAM0QoUJhkw88/qzfK5I686Ag2AQFjBc70dP5pGxCpiqMg5jf8K38nmbwBxmANRZYMfCpt8wyC5Mw2TJe2T3XBkCrvxQxburxyikAXl1+V92CM/7ZTbZQmQP2wlxsnq1TkpRfRLE6a10ssnViea3oYdGD2B7ni1eH3TLCTDiD13QiZC7cjxhZXKtPzQ/Iy2385qb74cui3BZBAI6jZI40ZLd3jVKMSK3OXMHtipHbbXEVF9XRnHysQAXFto4BtVZe8Jxm06Dfrkvfg== X-Forefront-Antispam-Report: CIP:216.228.117.161;CTRY:US;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:mail.nvidia.com;PTR:dc6edge2.nvidia.com;CAT:NONE;SFS:(13230028)(4636009)(396003)(39860400002)(346002)(136003)(376002)(451199021)(36840700001)(40470700004)(46966006)(2616005)(40480700001)(47076005)(83380400001)(36860700001)(426003)(336012)(186003)(40460700003)(26005)(16526019)(1076003)(7636003)(86362001)(4326008)(70206006)(70586007)(82740400003)(316002)(2906002)(41300700001)(34020700004)(107886003)(356005)(110136005)(478600001)(54906003)(8936002)(5660300002)(36756003)(8676002)(6666004)(966005)(82310400005);DIR:OUT;SFP:1101; X-OriginatorOrg: Nvidia.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 28 Apr 2023 04:20:25.9567 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 7980a03f-e104-48af-8670-08db479fe479 X-MS-Exchange-CrossTenant-Id: 43083d15-7273-40c1-b7db-39efd9ccc17a X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=43083d15-7273-40c1-b7db-39efd9ccc17a;Ip=[216.228.117.161];Helo=[mail.nvidia.com] X-MS-Exchange-CrossTenant-AuthSource: BN8NAM11FT051.eop-nam11.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: MN2PR12MB4424 Subject: [virtio-dev] [PATCH v15 10/11] virtio-net: Describe RSS using rss rq id The content of the indirection table and unclassified_queue were originally described based on mathematical operations. In order to make it easier to understand and to avoid intermixing the array index with the vq index, introduce a structure rss_rq_id (RSS receive queue ID) and use it to describe the unclassified_queue and indirection_table fields. As part of it, have the example that uses non-zero virtqueue index which helps to have better mapping between receiveX object with virtqueue index and the actual value in the indirection table. Fixes: https://github.com/oasis-tcs/virtio-spec/issues/163 Signed-off-by: Parav Pandit --- changelog: v14->v15: - address next comment from Michael and Halil - changed description of unclassified_queue to use 'specifies' v12->v13: - rename vqn to vq_index - renamed vq index to virtqueue index v11->v12: - use 'virtqueue index' instead of 'virtqueue number' v10->v11: - commit log updated to drop old reference to rq_handle, replaced with rss_rq_id detail v8->v9: - reword rss_rq_id and unclassified_packets description - use article - use 'vq number' instead of 'virtqueue number' v4->v5: - change subject to reflect rss_rq_id - fixed accidental removal of "unclassifed packets". - simplfied text around indirection_table mask to use the term destination receive virtqueue. This aligns with next line about queue reset. - removed rss_rq_id references as indirection table and unclassified_queue data type is self explanatory v3->v4: - renamed rq_handle to rss_rq_id - moved rss_rq_id definition close to its usage in rss_config struct v2->v3: - moved rq_handle definition before using it - removed duplicate example as rq_handle is now described first v0->v1: - new patch suggested by Michael Tsirkin --- device-types/net/description.tex | 27 ++++++++++++++++++++------- 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/device-types/net/description.tex b/device-types/net/description.tex index f3f9f1d..e25a9d0 100644 --- a/device-types/net/description.tex +++ b/device-types/net/description.tex @@ -1434,11 +1434,16 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi Driver sends a VIRTIO_NET_CTRL_MQ_RSS_CONFIG command using the following format for \field{command-specific-data}: \begin{lstlisting} +struct rss_rq_id { + le16 vq_index_1_16: 15; /* Bits 1 to 16 of the virtqueue index */ + le16 reserved: 1; /* Set to zero */ +}; + struct virtio_net_rss_config { le32 hash_types; le16 indirection_table_mask; - le16 unclassified_queue; - le16 indirection_table[indirection_table_length]; + struct rss_rq_id unclassified_queue; + struct rss_rq_id indirection_table[indirection_table_length]; le16 max_tx_vq; u8 hash_key_length; u8 hash_key_data[hash_key_length]; @@ -1453,10 +1458,15 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi \field{indirection_table} array. Number of entries in \field{indirection_table} is (\field{indirection_table_mask} + 1). -Field \field{unclassified_queue} contains the 0-based index of -the receive virtqueue to place unclassified packets in. Index 0 corresponds to receiveq1. +\field{rss_rq_id} is a receive virtqueue id. \field{vq_index_1_16} +consists of bits 1 to 16 of a virtqueue index. For example, a +\field{vq_index_1_16} value of 3 corresponds to virtqueue index 6, +which maps to receiveq4. + +Field \field{unclassified_queue} specifies the receive virtqueue in which to +place unclassified packets. -Field \field{indirection_table} contains an array of 0-based indices of receive virtqueues. Index 0 corresponds to receiveq1. +Field \field{indirection_table} is an array of receive virtqueues. A driver sets \field{max_tx_vq} to inform a device how many transmit virtqueues it may use (transmitq1\ldots transmitq \field{max_tx_vq}). @@ -1466,7 +1476,8 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi A driver MUST NOT send the VIRTIO_NET_CTRL_MQ_RSS_CONFIG command if the feature VIRTIO_NET_F_RSS has not been negotiated. -A driver MUST fill the \field{indirection_table} array only with indices of enabled queues. Index 0 corresponds to receiveq1. +A driver MUST fill the \field{indirection_table} array only with +enabled receive virtqueues. The number of entries in \field{indirection_table} (\field{indirection_table_mask} + 1) MUST be a power of two. @@ -1479,7 +1490,9 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi \begin{itemize} \item Calculate the hash of the packet as defined in \ref{sec:Device Types / Network Device / Device Operation / Processing of Incoming Packets / Hash calculation for incoming packets}. \item If the device did not calculate the hash for the specific packet, the device directs the packet to the receiveq specified by \field{unclassified_queue} of virtio_net_rss_config structure. -\item Apply \field{indirection_table_mask} to the calculated hash and use the result as the index in the indirection table to get 0-based number of destination receiveq. +\item Apply \field{indirection_table_mask} to the calculated hash +and use the result as the index in the indirection table to get +the destination receive virtqueue. \item If the destination receive queue is being reset (See \ref{sec:Basic Facilities of a Virtio Device / Virtqueues / Virtqueue Reset}), the device MUST drop the packet. \end{itemize} -- 2.26.2 --------------------------------------------------------------------- To unsubscribe, e-mail: virtio-dev-unsubscribe@lists.oasis-open.org For additional commands, e-mail: virtio-dev-help@lists.oasis-open.org