From patchwork Sun Nov 19 09:24:45 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Saeed Mahameed X-Patchwork-Id: 16753 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:9910:0:b0:403:3b70:6f57 with SMTP id i16csp1572517vqn; Sun, 19 Nov 2023 01:44:14 -0800 (PST) X-Google-Smtp-Source: AGHT+IHlb6rMNr7wtLTFWZKKwZdREvNEEYM9BuvgnZPJrD8DEZMv2wpq6kCisni9ceJtGRO7z2j3 X-Received: by 2002:a17:902:e808:b0:1cf:5cb5:95c1 with SMTP id u8-20020a170902e80800b001cf5cb595c1mr99167plg.37.1700387054207; Sun, 19 Nov 2023 01:44:14 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1700387054; cv=none; d=google.com; s=arc-20160816; b=Ssm0Dvb7NymVOgHp2l0/QoOVB70xUB8ff47vkStzYsLYOsF+pWRhUnCfN9vmSIkN6a qh8GFVVeAiZ16+W8iaalBzrBvj0wkF7CX2gYiQBALkt8oXQKyjaoVt/nHAvSN45bl/DD VAi2LNpIgOUGb3vs1vhFoLMuhnbitpT5Zv5yattgEV8F08TjSs2sAYrL3wk1kLWkNW6r 9rokR0TaEBhd4+Te+GX2zd3XGn2N4CDVtAzzOsc51b+jlzD/SrUbSd+gewJ3dRs5HTlU dZHnh6cB/mwqP1CPveqg2uzAL9NYzEvSHrN1yfPXFCaryjOztO0ibbJTQp1T73JEtI9Y vU0g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=hXybAqPXQ8lbiCNNkgM/IDqg/UeGJqODv7e7GPj/R9A=; fh=X0hOMbpOU1raqJinhHHPFdyR1sBFq2lMGBVOqO0x1pk=; b=F2h7oZPWoDF2YGxG+r2UrJ90XBh3Gd+EXBKbHCt0zsEsSeQHX2BmCYKzWZS5Zt0vga jd+XDuJ0JfCR/g1VmuW7+9plIAXNMfdYJcGOZL4YAVMtw2QasRgpEOJGl1QIuE5hBomA 8kt4LVsVnqrx/aXOsHwjoP+o/0y+pV/jEPAzZ1DiugczInMwaepRm/qY9zbiBcol8m5h B97nx0TqtUP7RXFbzEgYCSM4OqzCiY9vAHfZBxgtTZZm/AnNpazwi4cB3NrbIPNTlgnD Iep9hB1y/Rx4OYIrQVY/lvjBrED2L2ImZpCl99axWpe+XDYgAId1nu9s6ZzvfCie4Yp5 Hlfg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=MQU4zhtH; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:7 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: from snail.vger.email (snail.vger.email. [2620:137:e000::3:7]) by mx.google.com with ESMTPS id y6-20020a17090322c600b001cbe7f1db37si6341542plg.331.2023.11.19.01.44.13 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 19 Nov 2023 01:44:14 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:7 as permitted sender) client-ip=2620:137:e000::3:7; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=MQU4zhtH; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:7 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by snail.vger.email (Postfix) with ESMTP id 34F69805ECD2; Sun, 19 Nov 2023 01:44:13 -0800 (PST) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.11 at snail.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230389AbjKSJn4 (ORCPT + 99 others); Sun, 19 Nov 2023 04:43:56 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45886 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229580AbjKSJn4 (ORCPT ); Sun, 19 Nov 2023 04:43:56 -0500 Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 43AC7F9 for ; Sun, 19 Nov 2023 01:43:52 -0800 (PST) Received: by smtp.kernel.org (Postfix) with ESMTPSA id C2EBAC433C7; Sun, 19 Nov 2023 09:43:51 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1700387031; bh=PhoyyqsLoTQZk0akuJTAr8GtTs0QjK34zibgZUOs/Ts=; h=From:To:Cc:Subject:Date:From; b=MQU4zhtHaxxcZGSG8Uqh+XRuU5EgH2zlefjnHabzdcAwydrl0jrAIZ1Tvp1kHhatX CFpjUY324Yq056jtL6vsRsCrU0YGimlrCAjg9Qc4aaUBxalYxsCE/wnTXq+fzvoorx lspyuCohKq7eYSNIY+3kcb/WXEHA+Udk5aZebH9s2KwzpAkcIF6/e72Wlh8BD2AdnL EBrQWU6YNguw1P76iGWytWkmipWbtva6mdgfNkLUGLu9GmnzLfMaOtoavddtHeGWG0 /Mj+Jegqxv6/lCOn2xZ0s6oR2oFLSyclRx/OWB6yI0NMdRP4Ye7ez1o/w5VQBmHcy6 OAzTwyUfPz1sA== From: Saeed Mahameed To: Arnd Bergmann , Greg Kroah-Hartman Cc: Jason Gunthorpe , Leon Romanovsky , Jiri Pirko , Leonid Bloch , Itay Avraham , Jakub Kicinski , linux-kernel@vger.kernel.org, Saeed Mahameed Subject: [PATCH V2 0/5] mlx5 ConnectX diagnostic misc driver Date: Sun, 19 Nov 2023 01:24:45 -0800 Message-ID: <20231119092450.164996-1-saeed@kernel.org> X-Mailer: git-send-email 2.41.0 MIME-Version: 1.0 X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED, SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (snail.vger.email [0.0.0.0]); Sun, 19 Nov 2023 01:44:13 -0800 (PST) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1782985055902038297 X-GMAIL-MSGID: 1782985055902038297 From: Saeed Mahameed V1: https://lore.kernel.org/all/20231018081941.475277-1-saeed@kernel.org/T/#rf22c2070325b7da020ee29242dc25ffbd286d40d Following Greg's and Arnd's comments on V1 here are the V2 changes: V1->V2: - Provide legal statement and sign-off for dual license use - Fix License clause to use: BSD-3-Clause OR GPL-2.0 - Fix kernel robot warnings - Use dev_dbg directly instead of umem_dbg() local wrapper - Implement .compat_ioctl for 32bit compatibility - Fix mlx5ctl_info ABI structure size and alignment - Local pointer to correct type instead of in-place cast - Check unused fields and flags are 0 on ioctl path - Use correct macro to declare scalar arg ioctl command #define MLX5CTL_IOCTL_UMEM_UNREG \ _IO(MLX5CTL_IOCTL_MAGIC, 0x3) The ConnectX HW family supported by the mlx5 drivers uses an architecture where a FW component executes "mailbox RPCs" issued by the driver to make changes to the device. This results in a complex debugging environment where the FW component has information and low level configuration that needs to be accessed to userspace for debugging purposes. Historically a userspace program was used that accessed the PCI register and config space directly through /sys/bus/pci/.../XXX and could operate these debugging interfaces in parallel with the running driver. This approach is incompatible with secure boot and kernel lockdown so this driver provides a secure and restricted interface to that. 1) The first patch in the series introduces the main driver file with the implementation of a new mlx5 auxiliary device driver to run on top mlx5_core device instances, on probe it creates a new misc device and in this patch we implement the open and release fops, On open the driver would allocate a special FW UID (user context ID) restricted to debug RPCs only, where all user debug rpcs will be executed under this UID, and on release the UID will be freed. 2) The second patch adds an info ioctl that will show the allocated UID and the available capability masks of the device and the current UID, and some other useful device information such as the underlying ConnectX Example: $ sudo ./mlx5ctlu mlx5_core.ctl.0 mlx5dev: 0000:00:04.0 UCTX UID: 1 UCTX CAP: 0x3 DEV UCTX CAP: 0x3 USER CAP: 0x1d 3) Third patch will add the capability to execute debug RPCs under the special UID. In the mlx5 architecture the FW RPC commands are of the format of inbox and outbox buffers. The inbox buffer contains the command rpc layout as described in the ConnectX Programmers Reference Manual (PRM) document and as defined in linux/include/mlx5/mlx5_ifc.h. On success the user outbox buffer will be filled with the device's rpc response. For example to query device capabilities: a user fills out an inbox buffer with the inbox layout: struct mlx5_ifc_query_hca_cap_in_bits and expects an outbox buffer with the layout: struct mlx5_ifc_cmd_hca_cap_bits 4) The fourth patch adds the ability to register user memory into the ConntectX device and create a umem object that points to that memory. Command rpc outbox buffer is limited in size, which can be very annoying when trying to pull large traces out of the device. Many rpcs offer the ability to scatter output traces, contexts and logs directly into user space buffers in a single shot. The registered memory will be described by a device UMEM object which has a unique umem_id, this umem_id can be later used in the rpc inbox to tell the device where to populate the response output, e.g HW traces and other debug object queries. Example usecase, a ConnectX device coredump can be as large as 2MB. Using inline rpcs will take thousands of rpcs to get the full coredump which can consume multiple seconds. With UMEM, it can be done in a single rpc, using 2MB of umem user buffer. Other usecases with umem: - dynamic HW and FW trace monitoring - high frequency diagnostic counters sampling - batched objects and resource dumps See links below for information about user space tools that use this interface: [1] https://github.com/saeedtx/mlx5ctl [2] https://github.com/Mellanox/mstflint see: d) mstregdump utility This utility dumps hardware registers from Mellanox hardware for later analysis by Mellanox. g) mstconfig This tool sets or queries non-volatile configurable options for Mellanox HCAs. h) mstfwmanager Mellanox firmware update and query utility which scans the system for available Mellanox devices (only mst PCI devices) and performs the necessary firmware updates. i) mstreg The mlxreg utility allows users to obtain information regarding supported access registers, such as their fields License: BSD-3-Clause OR GPL-2.0 ================================ After a review of this thread [3], and a conversation with the LF, Mellanox and NVIDIA legal continue to approve the use of a Dual GPL & Permissive License for mlx5 related driver contributions. This makes it clear to future contributors that this file may be adapted and reused under BSD-3-Clause terms on other operating systems. Contributions will be handled in the normal way and the dual license will apply automatically. If people wish to contribute significantly and opt out of a dual license they may separate their GPL only contributions in dedicated files. Jason has a signing authority for NVIDIA and has gone through our internal process to get approval. Signed-off-by: Jason Gunthorpe # for legal [3] https://lore.kernel.org/all/20231018081941.475277-3-saeed@kernel.org/#r ================================ Signed-off-by: Saeed Mahameed Saeed Mahameed (5): mlx5: Add aux dev for ctl interface misc: mlx5ctl: Add mlx5ctl misc driver misc: mlx5ctl: Add info ioctl misc: mlx5ctl: Add command rpc ioctl misc: mlx5ctl: Add umem reg/unreg ioctl .../userspace-api/ioctl/ioctl-number.rst | 1 + MAINTAINERS | 8 + drivers/misc/Kconfig | 1 + drivers/misc/Makefile | 1 + drivers/misc/mlx5ctl/Kconfig | 14 + drivers/misc/mlx5ctl/Makefile | 5 + drivers/misc/mlx5ctl/main.c | 559 ++++++++++++++++++ drivers/misc/mlx5ctl/umem.c | 320 ++++++++++ drivers/misc/mlx5ctl/umem.h | 17 + drivers/net/ethernet/mellanox/mlx5/core/dev.c | 8 + include/uapi/misc/mlx5ctl.h | 53 ++ 11 files changed, 987 insertions(+) create mode 100644 drivers/misc/mlx5ctl/Kconfig create mode 100644 drivers/misc/mlx5ctl/Makefile create mode 100644 drivers/misc/mlx5ctl/main.c create mode 100644 drivers/misc/mlx5ctl/umem.c create mode 100644 drivers/misc/mlx5ctl/umem.h create mode 100644 include/uapi/misc/mlx5ctl.h --- 2.41.0