From nobody Thu Dec 18 15:24:17 2025 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2BA07C5ACB3 for ; Sun, 19 Nov 2023 09:44:03 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230418AbjKSJn5 (ORCPT ); Sun, 19 Nov 2023 04:43:57 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45918 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230391AbjKSJn4 (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 3804212D for ; Sun, 19 Nov 2023 01:43:53 -0800 (PST) Received: by smtp.kernel.org (Postfix) with ESMTPSA id B7024C433CA; Sun, 19 Nov 2023 09:43:52 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1700387032; bh=LtPGF9rLnrTjx4KOW6bP4tyG32DyV0XUPY4ZXkV6sgY=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=RYgG9auU9nH9bapRq3jPlMdmo7jFriHnk68LO8cUREdpCe9j6eRd2N6BSWPdmxp92 EBOk4Cp+/8lxRp/Jsncw+pG5vLOSuNT556lG4sCsak7vVKPhMqvXIDWs1FtgFBExlv rBmuZU84BI7RZbZ/zDUQ/xWUqe1rbQoF9wDfA7rOSorGR6vt0430MMVcgMGVWMzdKT MV9nkN9jkHpHr5HNSWso15n3+Mlw9khyr4cV6CF+3xL0YGQHNpG+e6MwWPGiQaq/Z3 hw1On4U7cI3zIrBxfvmPY9sAttp+T5oR72z6En/jQadU6KGElS+7krW11bew749kC5 2f/46HGBBIVmw== 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 1/5] mlx5: Add aux dev for ctl interface Date: Sun, 19 Nov 2023 01:24:46 -0800 Message-ID: <20231119092450.164996-2-saeed@kernel.org> X-Mailer: git-send-email 2.41.0 In-Reply-To: <20231119092450.164996-1-saeed@kernel.org> References: <20231119092450.164996-1-saeed@kernel.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" From: Saeed Mahameed Allow ctl protocol interface auxiliary driver in mlx5. Signed-off-by: Saeed Mahameed --- drivers/net/ethernet/mellanox/mlx5/core/dev.c | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/drivers/net/ethernet/mellanox/mlx5/core/dev.c b/drivers/net/et= hernet/mellanox/mlx5/core/dev.c index cf0477f53dc4..753c11f7050d 100644 --- a/drivers/net/ethernet/mellanox/mlx5/core/dev.c +++ b/drivers/net/ethernet/mellanox/mlx5/core/dev.c @@ -228,8 +228,14 @@ enum { MLX5_INTERFACE_PROTOCOL_VNET, =20 MLX5_INTERFACE_PROTOCOL_DPLL, + MLX5_INTERFACE_PROTOCOL_CTL, }; =20 +static bool is_ctl_supported(struct mlx5_core_dev *dev) +{ + return MLX5_CAP_GEN(dev, uctx_cap); +} + static const struct mlx5_adev_device { const char *suffix; bool (*is_supported)(struct mlx5_core_dev *dev); @@ -252,6 +258,8 @@ static const struct mlx5_adev_device { .is_supported =3D &is_mp_supported }, [MLX5_INTERFACE_PROTOCOL_DPLL] =3D { .suffix =3D "dpll", .is_supported =3D &is_dpll_supported }, + [MLX5_INTERFACE_PROTOCOL_CTL] =3D { .suffix =3D "ctl", + .is_supported =3D &is_ctl_supported }, }; =20 int mlx5_adev_idx_alloc(void) --=20 2.41.0 From nobody Thu Dec 18 15:24:17 2025 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 50F1CC5AD4C for ; Sun, 19 Nov 2023 09:44:03 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230450AbjKSJoD (ORCPT ); Sun, 19 Nov 2023 04:44:03 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45922 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230391AbjKSJn6 (ORCPT ); Sun, 19 Nov 2023 04:43:58 -0500 Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 24ED3F9 for ; Sun, 19 Nov 2023 01:43:54 -0800 (PST) Received: by smtp.kernel.org (Postfix) with ESMTPSA id AF405C433C7; Sun, 19 Nov 2023 09:43:53 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1700387033; bh=K2hCqg3bMkRpXfCHyDtzl7WXWdC6U//nQzvOG1sXB5U=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=oBOMpMqmz3hisgt6lQm9sFUJ57hnfm3Xjrm/Sj5t0UBbiBTDrT3BctWqKkRlZykO5 Uurl0JsvUxp3d6mtdVgGrcaIkJs/UnReLa4OYkzK8G5tCfMZz5iP94bMSgw7sdGJ82 /G6JkPihZ6mtILhtcZ+LNthZGGLKHoHccpQ/TXKI3KJVT8X1E9OprZ7qUFZYYd9qTi zb7ja0E+wRtPRMQlwRaiXMwQBaxDLgno4v1Nb3x9j5NGnfaLp1UWlI5sba5et1vUgX 7odmBDCGZZ14EcME2LHgTcNL7yTpDexmR9WIhiseuDT7LfgEkQDl8y6XBTXQkuOs50 XM5VIOnSykrcw== 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 2/5] misc: mlx5ctl: Add mlx5ctl misc driver Date: Sun, 19 Nov 2023 01:24:47 -0800 Message-ID: <20231119092450.164996-3-saeed@kernel.org> X-Mailer: git-send-email 2.41.0 In-Reply-To: <20231119092450.164996-1-saeed@kernel.org> References: <20231119092450.164996-1-saeed@kernel.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" From: Saeed Mahameed 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 same data. On open the driver would allocate a special FW UID (user context ID) restrected to debug RPCs only, later in this series all user RPCs will be stamped with this UID. Reviewed-by: Jiri Pirko Reviewed-by: Leon Romanovsky igned-off-by: Saeed Mahameed --- MAINTAINERS | 8 + drivers/misc/Kconfig | 1 + drivers/misc/Makefile | 1 + drivers/misc/mlx5ctl/Kconfig | 14 ++ drivers/misc/mlx5ctl/Makefile | 4 + drivers/misc/mlx5ctl/main.c | 314 ++++++++++++++++++++++++++++++++++ 6 files changed, 342 insertions(+) create mode 100644 drivers/misc/mlx5ctl/Kconfig create mode 100644 drivers/misc/mlx5ctl/Makefile create mode 100644 drivers/misc/mlx5ctl/main.c diff --git a/MAINTAINERS b/MAINTAINERS index 97f51d5ec1cf..4b532df16b19 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -13835,6 +13835,14 @@ L: virtualization@lists.linux-foundation.org S: Supported F: drivers/vdpa/mlx5/ =20 +MELLANOX MLX5 ConnectX Diag DRIVER +M: Saeed Mahameed +R: Itay Avraham +L: linux-kernel@vger.kernel.org +S: Supported +F: drivers/misc/mlx5ctl/ +F: include/uapi/misc/mlx5ctl.h + MELLANOX MLXCPLD I2C AND MUX DRIVER M: Vadim Pasternak M: Michael Shych diff --git a/drivers/misc/Kconfig b/drivers/misc/Kconfig index f37c4b8380ae..c0e4823648ed 100644 --- a/drivers/misc/Kconfig +++ b/drivers/misc/Kconfig @@ -579,4 +579,5 @@ source "drivers/misc/cardreader/Kconfig" source "drivers/misc/uacce/Kconfig" source "drivers/misc/pvpanic/Kconfig" source "drivers/misc/mchp_pci1xxxx/Kconfig" +source "drivers/misc/mlx5ctl/Kconfig" endmenu diff --git a/drivers/misc/Makefile b/drivers/misc/Makefile index f2a4d1ff65d4..49bc4697f498 100644 --- a/drivers/misc/Makefile +++ b/drivers/misc/Makefile @@ -67,3 +67,4 @@ obj-$(CONFIG_TMR_MANAGER) +=3D xilinx_tmr_manager.o obj-$(CONFIG_TMR_INJECT) +=3D xilinx_tmr_inject.o obj-$(CONFIG_TPS6594_ESM) +=3D tps6594-esm.o obj-$(CONFIG_TPS6594_PFSM) +=3D tps6594-pfsm.o +obj-$(CONFIG_MLX5CTL) +=3D mlx5ctl/ diff --git a/drivers/misc/mlx5ctl/Kconfig b/drivers/misc/mlx5ctl/Kconfig new file mode 100644 index 000000000000..faaa1dba2cc2 --- /dev/null +++ b/drivers/misc/mlx5ctl/Kconfig @@ -0,0 +1,14 @@ +# SPDX-License-Identifier: GPL-2.0 +# + +config MLX5CTL + tristate "mlx5 ConnectX control misc driver" + depends on MLX5_CORE + help + MLX5CTL provides interface for the user process to access the debug and + configuration registers of the ConnectX hardware family + (NICs, PCI switches and SmartNIC SoCs). + This will allow configuration and debug tools to work out of the= box on + mainstream kernel. + + If you don't know what to do here, say N. diff --git a/drivers/misc/mlx5ctl/Makefile b/drivers/misc/mlx5ctl/Makefile new file mode 100644 index 000000000000..b5c7f99e0ab6 --- /dev/null +++ b/drivers/misc/mlx5ctl/Makefile @@ -0,0 +1,4 @@ +# SPDX-License-Identifier: GPL-2.0 + +obj-$(CONFIG_MLX5CTL) +=3D mlx5ctl.o +mlx5ctl-y :=3D main.o diff --git a/drivers/misc/mlx5ctl/main.c b/drivers/misc/mlx5ctl/main.c new file mode 100644 index 000000000000..8eb150461b80 --- /dev/null +++ b/drivers/misc/mlx5ctl/main.c @@ -0,0 +1,314 @@ +// SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 +/* Copyright (c) 2023, NVIDIA CORPORATION & AFFILIATES. All rights reserve= d. */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +MODULE_DESCRIPTION("mlx5 ConnectX control misc driver"); +MODULE_AUTHOR("Saeed Mahameed "); +MODULE_LICENSE("Dual BSD/GPL"); + +struct mlx5ctl_dev { + struct mlx5_core_dev *mdev; + struct miscdevice miscdev; + struct auxiliary_device *adev; + struct list_head fd_list; + spinlock_t fd_list_lock; /* protect list add/del */ + struct rw_semaphore rw_lock; + struct kref refcount; +}; + +struct mlx5ctl_fd { + u16 uctx_uid; + u32 uctx_cap; + u32 ucap; /* user cap */ + struct mlx5ctl_dev *mcdev; + struct list_head list; +}; + +#define mlx5ctl_err(mcdev, format, ...) \ + dev_err(mcdev->miscdev.parent, format, ##__VA_ARGS__) + +#define mlx5ctl_dbg(mcdev, format, ...) \ + dev_dbg(mcdev->miscdev.parent, "PID %d: " format, \ + current->pid, ##__VA_ARGS__) + +enum { + MLX5_UCTX_OBJECT_CAP_RAW_TX =3D 0x1, + MLX5_UCTX_OBJECT_CAP_INTERNAL_DEVICE_RESOURCES =3D 0x2, + MLX5_UCTX_OBJECT_CAP_TOOLS_RESOURCES =3D 0x4, +}; + +static int mlx5ctl_alloc_uid(struct mlx5ctl_dev *mcdev, u32 cap) +{ + u32 out[MLX5_ST_SZ_DW(create_uctx_out)] =3D {}; + u32 in[MLX5_ST_SZ_DW(create_uctx_in)] =3D {}; + void *uctx; + int err; + u16 uid; + + uctx =3D MLX5_ADDR_OF(create_uctx_in, in, uctx); + + mlx5ctl_dbg(mcdev, "MLX5_CMD_OP_CREATE_UCTX: caps 0x%x\n", cap); + MLX5_SET(create_uctx_in, in, opcode, MLX5_CMD_OP_CREATE_UCTX); + MLX5_SET(uctx, uctx, cap, cap); + + err =3D mlx5_cmd_exec(mcdev->mdev, in, sizeof(in), out, sizeof(out)); + if (err) + return err; + + uid =3D MLX5_GET(create_uctx_out, out, uid); + mlx5ctl_dbg(mcdev, "allocated uid %d with caps 0x%x\n", uid, cap); + return uid; +} + +static void mlx5ctl_release_uid(struct mlx5ctl_dev *mcdev, u16 uid) +{ + u32 in[MLX5_ST_SZ_DW(destroy_uctx_in)] =3D {}; + struct mlx5_core_dev *mdev =3D mcdev->mdev; + int err; + + MLX5_SET(destroy_uctx_in, in, opcode, MLX5_CMD_OP_DESTROY_UCTX); + MLX5_SET(destroy_uctx_in, in, uid, uid); + + err =3D mlx5_cmd_exec_in(mdev, destroy_uctx, in); + mlx5ctl_dbg(mcdev, "released uid %d err(%d)\n", uid, err); +} + +static void mcdev_get(struct mlx5ctl_dev *mcdev); +static void mcdev_put(struct mlx5ctl_dev *mcdev); + +static int mlx5ctl_open_mfd(struct mlx5ctl_fd *mfd) +{ + struct mlx5_core_dev *mdev =3D mfd->mcdev->mdev; + struct mlx5ctl_dev *mcdev =3D mfd->mcdev; + u32 ucap =3D 0, cap =3D 0; + int uid; + +#define MLX5_UCTX_CAP(mdev, cap) \ + (MLX5_CAP_GEN(mdev, uctx_cap) & MLX5_UCTX_OBJECT_CAP_##cap) + + if (capable(CAP_NET_RAW) && MLX5_UCTX_CAP(mdev, RAW_TX)) { + ucap |=3D CAP_NET_RAW; + cap |=3D MLX5_UCTX_OBJECT_CAP_RAW_TX; + } + + if (capable(CAP_SYS_RAWIO) && MLX5_UCTX_CAP(mdev, INTERNAL_DEVICE_RESOURC= ES)) { + ucap |=3D CAP_SYS_RAWIO; + cap |=3D MLX5_UCTX_OBJECT_CAP_INTERNAL_DEVICE_RESOURCES; + } + + if (capable(CAP_SYS_ADMIN) && MLX5_UCTX_CAP(mdev, TOOLS_RESOURCES)) { + ucap |=3D CAP_SYS_ADMIN; + cap |=3D MLX5_UCTX_OBJECT_CAP_TOOLS_RESOURCES; + } + + uid =3D mlx5ctl_alloc_uid(mcdev, cap); + if (uid < 0) + return uid; + + mfd->uctx_uid =3D uid; + mfd->uctx_cap =3D cap; + mfd->ucap =3D ucap; + mfd->mcdev =3D mcdev; + + mlx5ctl_dbg(mcdev, "allocated uid %d with uctx caps 0x%x, user cap 0x%x\n= ", + uid, cap, ucap); + return 0; +} + +static void mlx5ctl_release_mfd(struct mlx5ctl_fd *mfd) +{ + struct mlx5ctl_dev *mcdev =3D mfd->mcdev; + + mlx5ctl_release_uid(mcdev, mfd->uctx_uid); +} + +static int mlx5ctl_open(struct inode *inode, struct file *file) +{ + struct mlx5_core_dev *mdev; + struct mlx5ctl_dev *mcdev; + struct mlx5ctl_fd *mfd; + int err =3D 0; + + mcdev =3D container_of(file->private_data, struct mlx5ctl_dev, miscdev); + mcdev_get(mcdev); + down_read(&mcdev->rw_lock); + mdev =3D mcdev->mdev; + if (!mdev) { + err =3D -ENODEV; + goto unlock; + } + + mfd =3D kzalloc(sizeof(*mfd), GFP_KERNEL_ACCOUNT); + if (!mfd) + return -ENOMEM; + + mfd->mcdev =3D mcdev; + err =3D mlx5ctl_open_mfd(mfd); + if (err) + goto unlock; + + spin_lock(&mcdev->fd_list_lock); + list_add_tail(&mfd->list, &mcdev->fd_list); + spin_unlock(&mcdev->fd_list_lock); + + file->private_data =3D mfd; + +unlock: + up_read(&mcdev->rw_lock); + if (err) { + mcdev_put(mcdev); + kfree(mfd); + } + return err; +} + +static int mlx5ctl_release(struct inode *inode, struct file *file) +{ + struct mlx5ctl_fd *mfd =3D file->private_data; + struct mlx5ctl_dev *mcdev =3D mfd->mcdev; + + down_read(&mcdev->rw_lock); + if (!mcdev->mdev) { + pr_debug("[%d] UID %d mlx5ctl: mdev is already released\n", + current->pid, mfd->uctx_uid); + /* All mfds are already released, skip ... */ + goto unlock; + } + + spin_lock(&mcdev->fd_list_lock); + list_del(&mfd->list); + spin_unlock(&mcdev->fd_list_lock); + + mlx5ctl_release_mfd(mfd); + +unlock: + kfree(mfd); + up_read(&mcdev->rw_lock); + mcdev_put(mcdev); + file->private_data =3D NULL; + return 0; +} + +static const struct file_operations mlx5ctl_fops =3D { + .owner =3D THIS_MODULE, + .open =3D mlx5ctl_open, + .release =3D mlx5ctl_release, +}; + +static int mlx5ctl_probe(struct auxiliary_device *adev, + const struct auxiliary_device_id *id) + +{ + struct mlx5_adev *madev =3D container_of(adev, struct mlx5_adev, adev); + struct mlx5_core_dev *mdev =3D madev->mdev; + struct mlx5ctl_dev *mcdev; + char *devname =3D NULL; + int err; + + mcdev =3D kzalloc(sizeof(*mcdev), GFP_KERNEL_ACCOUNT); + if (!mcdev) + return -ENOMEM; + + kref_init(&mcdev->refcount); + INIT_LIST_HEAD(&mcdev->fd_list); + spin_lock_init(&mcdev->fd_list_lock); + init_rwsem(&mcdev->rw_lock); + mcdev->mdev =3D mdev; + mcdev->adev =3D adev; + devname =3D kasprintf(GFP_KERNEL_ACCOUNT, "mlx5ctl-%s", + dev_name(&adev->dev)); + if (!devname) { + err =3D -ENOMEM; + goto abort; + } + + mcdev->miscdev =3D (struct miscdevice) { + .minor =3D MISC_DYNAMIC_MINOR, + .name =3D devname, + .fops =3D &mlx5ctl_fops, + .parent =3D &adev->dev, + }; + + err =3D misc_register(&mcdev->miscdev); + if (err) { + mlx5ctl_err(mcdev, "mlx5ctl: failed to register misc device err %d\n", e= rr); + goto abort; + } + + mlx5ctl_dbg(mcdev, "probe mdev@%s %s\n", dev_driver_string(mdev->device),= dev_name(mdev->device)); + + auxiliary_set_drvdata(adev, mcdev); + + return 0; + +abort: + kfree(devname); + kfree(mcdev); + return err; +} + +static void mlx5ctl_remove(struct auxiliary_device *adev) +{ + struct mlx5ctl_dev *mcdev =3D auxiliary_get_drvdata(adev); + struct mlx5_core_dev *mdev =3D mcdev->mdev; + struct mlx5ctl_fd *mfd, *n; + + misc_deregister(&mcdev->miscdev); + down_write(&mcdev->rw_lock); + + list_for_each_entry_safe(mfd, n, &mcdev->fd_list, list) { + mlx5ctl_dbg(mcdev, "UID %d still has open FDs\n", mfd->uctx_uid); + list_del(&mfd->list); + mlx5ctl_release_mfd(mfd); + } + + mlx5ctl_dbg(mcdev, "removed mdev %s %s\n", + dev_driver_string(mdev->device), dev_name(mdev->device)); + + mcdev->mdev =3D NULL; /* prevent already open fds from accessing the devi= ce */ + up_write(&mcdev->rw_lock); + mcdev_put(mcdev); +} + +static void mcdev_free(struct kref *ref) +{ + struct mlx5ctl_dev *mcdev =3D container_of(ref, struct mlx5ctl_dev, refco= unt); + + kfree(mcdev->miscdev.name); + kfree(mcdev); +} + +static void mcdev_get(struct mlx5ctl_dev *mcdev) +{ + kref_get(&mcdev->refcount); +} + +static void mcdev_put(struct mlx5ctl_dev *mcdev) +{ + kref_put(&mcdev->refcount, mcdev_free); +} + +static const struct auxiliary_device_id mlx5ctl_id_table[] =3D { + { .name =3D MLX5_ADEV_NAME ".ctl", }, + {}, +}; + +MODULE_DEVICE_TABLE(auxiliary, mlx5ctl_id_table); + +static struct auxiliary_driver mlx5ctl_driver =3D { + .name =3D "ctl", + .probe =3D mlx5ctl_probe, + .remove =3D mlx5ctl_remove, + .id_table =3D mlx5ctl_id_table, +}; + +module_auxiliary_driver(mlx5ctl_driver); --=20 2.41.0 From nobody Thu Dec 18 15:24:17 2025 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id E88EDC072A2 for ; Sun, 19 Nov 2023 09:44:13 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230484AbjKSJoH (ORCPT ); Sun, 19 Nov 2023 04:44:07 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45930 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230426AbjKSJn6 (ORCPT ); Sun, 19 Nov 2023 04:43:58 -0500 Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 14922CE for ; Sun, 19 Nov 2023 01:43:55 -0800 (PST) Received: by smtp.kernel.org (Postfix) with ESMTPSA id A3692C433C8; Sun, 19 Nov 2023 09:43:54 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1700387034; bh=9jMI2vx8nOKTbPAAjqs6b+jb8bpd0TYFkj49pFrwOis=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=DPw2tySRvcB0+wJaFTh/0ds1Z/OljL6doPJHQcqbWGIHQrQ1dmJB1o5LWCsA0z9Ug HxBtK6Sf2MlzpYo19Udh70RtFOfRS69dim2P2pK1ZlcwhDZDq7Oc6oG0Ism3AXx6VW R2b78SmkgC3iv2NPh+udAqFKM/JAecZ7+9ESMoi/k5bdnmzm6f5d1888cK4vX/LyGw UKMpnyqUV/UBW+HEFv7Zj31XRgjIDsLxq7x7ZfUpv4TPAgJt4mMyjQ08YlSwa9dZVI MKecpHKa4mP6QnPjmW/qdNn93Fyf1ZMu4HIQ2mcQ/sJIoUa6winwOs+l4jVkh1yJj3 72DUZISATJa0w== 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 3/5] misc: mlx5ctl: Add info ioctl Date: Sun, 19 Nov 2023 01:24:48 -0800 Message-ID: <20231119092450.164996-4-saeed@kernel.org> X-Mailer: git-send-email 2.41.0 In-Reply-To: <20231119092450.164996-1-saeed@kernel.org> References: <20231119092450.164996-1-saeed@kernel.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" From: Saeed Mahameed Implement INFO ioctl to return the allocated UID and the capability flags and some other useful device information such as the underlying ConnectX device. 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 Reviewed-by: Jiri Pirko Reviewed-by: Leon Romanovsky Signed-off-by: Saeed Mahameed --- .../userspace-api/ioctl/ioctl-number.rst | 1 + drivers/misc/mlx5ctl/main.c | 71 +++++++++++++++++++ include/uapi/misc/mlx5ctl.h | 24 +++++++ 3 files changed, 96 insertions(+) create mode 100644 include/uapi/misc/mlx5ctl.h diff --git a/Documentation/userspace-api/ioctl/ioctl-number.rst b/Documenta= tion/userspace-api/ioctl/ioctl-number.rst index 4ea5b837399a..9faf91ffefff 100644 --- a/Documentation/userspace-api/ioctl/ioctl-number.rst +++ b/Documentation/userspace-api/ioctl/ioctl-number.rst @@ -89,6 +89,7 @@ Code Seq# Include File = Comments 0x20 all drivers/cdrom/cm206.h 0x22 all scsi/sg.h 0x3E 00-0F linux/counter.h +0x5c all uapi/misc/mlx5ctl.h Nvidi= a ConnectX control '!' 00-1F uapi/linux/seccomp.h '#' 00-3F IEEE = 1394 Subsystem Block= for the entire subsystem diff --git a/drivers/misc/mlx5ctl/main.c b/drivers/misc/mlx5ctl/main.c index 8eb150461b80..6a98b40e4300 100644 --- a/drivers/misc/mlx5ctl/main.c +++ b/drivers/misc/mlx5ctl/main.c @@ -8,6 +8,7 @@ #include #include #include +#include #include #include =20 @@ -198,10 +199,80 @@ static int mlx5ctl_release(struct inode *inode, struc= t file *file) return 0; } =20 +static int mlx5ctl_info_ioctl(struct file *file, + struct mlx5ctl_info __user *arg, + size_t usize) +{ + struct mlx5ctl_fd *mfd =3D file->private_data; + struct mlx5ctl_dev *mcdev =3D mfd->mcdev; + struct mlx5_core_dev *mdev =3D mcdev->mdev; + struct mlx5ctl_info *info; + size_t ksize =3D 0; + int err =3D 0; + + ksize =3D max(sizeof(struct mlx5ctl_info), usize); + info =3D kzalloc(ksize, GFP_KERNEL_ACCOUNT); + if (!info) + return -ENOMEM; + + info->size =3D sizeof(struct mlx5ctl_info); + + info->dev_uctx_cap =3D MLX5_CAP_GEN(mdev, uctx_cap); + info->uctx_cap =3D mfd->uctx_cap; + info->uctx_uid =3D mfd->uctx_uid; + info->ucap =3D mfd->ucap; + + strscpy(info->devname, dev_name(&mdev->pdev->dev), + sizeof(info->devname)); + + if (copy_to_user(arg, info, usize)) + err =3D -EFAULT; + + kfree(info); + return err; +} + +static long mlx5ctl_ioctl(struct file *file, unsigned int cmd, unsigned lo= ng arg) +{ + struct mlx5ctl_fd *mfd =3D file->private_data; + struct mlx5ctl_dev *mcdev =3D mfd->mcdev; + void __user *argp =3D (void __user *)arg; + size_t size =3D _IOC_SIZE(cmd); + int err =3D 0; + + if (!capable(CAP_SYS_ADMIN)) + return -EPERM; + + mlx5ctl_dbg(mcdev, "ioctl 0x%x type/nr: %d/%d size: %d DIR:%d\n", cmd, + _IOC_TYPE(cmd), _IOC_NR(cmd), _IOC_SIZE(cmd), _IOC_DIR(cmd)); + + down_read(&mcdev->rw_lock); + if (!mcdev->mdev) { + err =3D -ENODEV; + goto unlock; + } + + switch (cmd) { + case MLX5CTL_IOCTL_INFO: + err =3D mlx5ctl_info_ioctl(file, argp, size); + break; + + default: + mlx5ctl_dbg(mcdev, "Unknown ioctl %x\n", cmd); + err =3D -ENOIOCTLCMD; + break; + } +unlock: + up_read(&mcdev->rw_lock); + return err; +} + static const struct file_operations mlx5ctl_fops =3D { .owner =3D THIS_MODULE, .open =3D mlx5ctl_open, .release =3D mlx5ctl_release, + .unlocked_ioctl =3D mlx5ctl_ioctl, + .compat_ioctl =3D compat_ptr_ioctl, }; =20 static int mlx5ctl_probe(struct auxiliary_device *adev, diff --git a/include/uapi/misc/mlx5ctl.h b/include/uapi/misc/mlx5ctl.h new file mode 100644 index 000000000000..37153cc0fc6e --- /dev/null +++ b/include/uapi/misc/mlx5ctl.h @@ -0,0 +1,24 @@ +/* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 WITH Linux-syscall-not= e */ +/* Copyright (c) 2023, NVIDIA CORPORATION & AFFILIATES. All rights reserve= d. */ + +#ifndef __MLX5CTL_IOCTL_H__ +#define __MLX5CTL_IOCTL_H__ + +struct mlx5ctl_info { + __aligned_u64 flags; + __u32 size; + __u8 devname[64]; /* underlaying ConnectX device */ + __u16 uctx_uid; /* current process allocated UCTX UID */ + __u16 reserved1; + __u32 uctx_cap; /* current process effective UCTX cap */ + __u32 dev_uctx_cap; /* device's UCTX capabilities */ + __u32 ucap; /* process user capability */ + __u32 reserved2; +}; + +#define MLX5CTL_IOCTL_MAGIC 0x5c + +#define MLX5CTL_IOCTL_INFO \ + _IOR(MLX5CTL_IOCTL_MAGIC, 0x0, struct mlx5ctl_info) + +#endif /* __MLX5CTL_IOCTL_H__ */ --=20 2.41.0 From nobody Thu Dec 18 15:24:17 2025 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 0E3E6C5AD4C for ; Sun, 19 Nov 2023 09:44:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230463AbjKSJoK (ORCPT ); Sun, 19 Nov 2023 04:44:10 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45944 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230432AbjKSJn7 (ORCPT ); Sun, 19 Nov 2023 04:43:59 -0500 Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id EC1D0126 for ; Sun, 19 Nov 2023 01:43:55 -0800 (PST) Received: by smtp.kernel.org (Postfix) with ESMTPSA id B0D26C433CA; Sun, 19 Nov 2023 09:43:55 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1700387035; bh=gvFxak/gysvppAhuauVGMKlKJBpqKmbpR9uk5BfMjy0=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=llzYrAxHbzNv7l24wTxLyAZG3zOz3sZPfq/CcbdpLL4ToXXco0wlIa91UqAPabkAY wvQ4z8pMtdXHcxkDEKOn34qKpUrk9ZDeYlz9I9g+eX69FKVj7KffkHinwKPqNJG5JG hFYKBTr/1rnS5Aoi1BRUlPhJNuXOE+SNwYbw666gZO5JBBdYhW4tnGxMvkS49u8KUT bpDz0aMjG2JpwQopK6dpkBtuSYCC0BxTKSRY9HKc7Y9olMsY2iu1m4yn/Eo4/esz9K 6BkxjooN1t75oXBNoUGoLEsUvuvENPGKMxPqEWG06LKNuOddBqkEtYb9CbqNSkzKgW 7J0SQzbNJ/uqQ== 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 4/5] misc: mlx5ctl: Add command rpc ioctl Date: Sun, 19 Nov 2023 01:24:49 -0800 Message-ID: <20231119092450.164996-5-saeed@kernel.org> X-Mailer: git-send-email 2.41.0 In-Reply-To: <20231119092450.164996-1-saeed@kernel.org> References: <20231119092450.164996-1-saeed@kernel.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" From: Saeed Mahameed Add new IOCTL to allow user space to send device debug rpcs and attach the user's uctx UID to each rpc. 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 include/linux/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 Reviewed-by: Jiri Pirko Reviewed-by: Leon Romanovsky Signed-off-by: Saeed Mahameed --- drivers/misc/mlx5ctl/main.c | 95 +++++++++++++++++++++++++++++++++++++ include/uapi/misc/mlx5ctl.h | 13 +++++ 2 files changed, 108 insertions(+) diff --git a/drivers/misc/mlx5ctl/main.c b/drivers/misc/mlx5ctl/main.c index 6a98b40e4300..e7776ea4bfca 100644 --- a/drivers/misc/mlx5ctl/main.c +++ b/drivers/misc/mlx5ctl/main.c @@ -232,6 +232,97 @@ static int mlx5ctl_info_ioctl(struct file *file, return err; } =20 +struct mlx5_ifc_mbox_in_hdr_bits { + u8 opcode[0x10]; + u8 uid[0x10]; + + u8 reserved_at_20[0x10]; + u8 op_mod[0x10]; + + u8 reserved_at_40[0x40]; +}; + +struct mlx5_ifc_mbox_out_hdr_bits { + u8 status[0x8]; + u8 reserved_at_8[0x18]; + + u8 syndrome[0x20]; + + u8 reserved_at_40[0x40]; +}; + +static int mlx5ctl_cmdrpc_ioctl(struct file *file, + struct mlx5ctl_cmdrpc __user *arg, + size_t usize) +{ + struct mlx5ctl_fd *mfd =3D file->private_data; + struct mlx5ctl_dev *mcdev =3D mfd->mcdev; + struct mlx5ctl_cmdrpc *rpc =3D NULL; + void *in =3D NULL, *out =3D NULL; + size_t ksize =3D 0; + int err; + + ksize =3D max(sizeof(struct mlx5ctl_cmdrpc), usize); + rpc =3D kzalloc(ksize, GFP_KERNEL_ACCOUNT); + if (!rpc) + return -ENOMEM; + + err =3D copy_from_user(rpc, arg, usize); + if (err) + goto out; + + mlx5ctl_dbg(mcdev, "[UID %d] cmdrpc: rpc->inlen %d rpc->outlen %d\n", + mfd->uctx_uid, rpc->inlen, rpc->outlen); + + if (rpc->inlen < MLX5_ST_SZ_BYTES(mbox_in_hdr) || + rpc->outlen < MLX5_ST_SZ_BYTES(mbox_out_hdr) || + rpc->inlen > MLX5CTL_MAX_RPC_SIZE || + rpc->outlen > MLX5CTL_MAX_RPC_SIZE) { + err =3D -EINVAL; + goto out; + } + + if (rpc->flags) { + err =3D -EOPNOTSUPP; + goto out; + } + + in =3D memdup_user(u64_to_user_ptr(rpc->in), rpc->inlen); + if (IS_ERR(in)) { + err =3D PTR_ERR(in); + goto out; + } + + out =3D kvzalloc(rpc->outlen, GFP_KERNEL_ACCOUNT); + if (!out) { + err =3D -ENOMEM; + goto out; + } + + mlx5ctl_dbg(mcdev, "[UID %d] cmdif: opcode 0x%x inlen %d outlen %d\n", + mfd->uctx_uid, + MLX5_GET(mbox_in_hdr, in, opcode), rpc->inlen, rpc->outlen); + + MLX5_SET(mbox_in_hdr, in, uid, mfd->uctx_uid); + err =3D mlx5_cmd_do(mcdev->mdev, in, rpc->inlen, out, rpc->outlen); + mlx5ctl_dbg(mcdev, "[UID %d] cmdif: opcode 0x%x retval %d\n", + mfd->uctx_uid, + MLX5_GET(mbox_in_hdr, in, opcode), err); + + /* -EREMOTEIO means outbox is valid, but out.status is not */ + if (!err || err =3D=3D -EREMOTEIO) { + err =3D 0; + if (copy_to_user(u64_to_user_ptr(rpc->out), out, rpc->outlen)) + err =3D -EFAULT; + } + +out: + kvfree(out); + kfree(in); + kfree(rpc); + return err; +} + static long mlx5ctl_ioctl(struct file *file, unsigned int cmd, unsigned lo= ng arg) { struct mlx5ctl_fd *mfd =3D file->private_data; @@ -257,6 +348,10 @@ static long mlx5ctl_ioctl(struct file *file, unsigned = int cmd, unsigned long arg err =3D mlx5ctl_info_ioctl(file, argp, size); break; =20 + case MLX5CTL_IOCTL_CMDRPC: + err =3D mlx5ctl_cmdrpc_ioctl(file, argp, size); + break; + default: mlx5ctl_dbg(mcdev, "Unknown ioctl %x\n", cmd); err =3D -ENOIOCTLCMD; diff --git a/include/uapi/misc/mlx5ctl.h b/include/uapi/misc/mlx5ctl.h index 37153cc0fc6e..3277eaf78a37 100644 --- a/include/uapi/misc/mlx5ctl.h +++ b/include/uapi/misc/mlx5ctl.h @@ -16,9 +16,22 @@ struct mlx5ctl_info { __u32 reserved2; }; =20 +struct mlx5ctl_cmdrpc { + __aligned_u64 in; /* RPC inbox buffer user address */ + __aligned_u64 out; /* RPC outbox buffer user address */ + __u32 inlen; /* inbox buffer length */ + __u32 outlen; /* outbox buffer length */ + __aligned_u64 flags; +}; + +#define MLX5CTL_MAX_RPC_SIZE 8192 + #define MLX5CTL_IOCTL_MAGIC 0x5c =20 #define MLX5CTL_IOCTL_INFO \ _IOR(MLX5CTL_IOCTL_MAGIC, 0x0, struct mlx5ctl_info) =20 +#define MLX5CTL_IOCTL_CMDRPC \ + _IOWR(MLX5CTL_IOCTL_MAGIC, 0x1, struct mlx5ctl_cmdrpc) + #endif /* __MLX5CTL_IOCTL_H__ */ --=20 2.41.0 From nobody Thu Dec 18 15:24:17 2025 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 223D5C5ACB3 for ; Sun, 19 Nov 2023 09:44:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231147AbjKSJoN (ORCPT ); Sun, 19 Nov 2023 04:44:13 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45970 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230437AbjKSJoB (ORCPT ); Sun, 19 Nov 2023 04:44:01 -0500 Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E23E9131 for ; Sun, 19 Nov 2023 01:43:56 -0800 (PST) Received: by smtp.kernel.org (Postfix) with ESMTPSA id A93C2C433CB; Sun, 19 Nov 2023 09:43:56 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1700387036; bh=FOLXuXY9ylFw25aSPAVvNy0qC58xy0lNAqAr0ns7EwQ=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=gwele+8ybLBpLs6xgY95mV5F4cY9VyX+ifRV1ZwIojJhs3u8rHyffwUQJSoWRf1p0 m/br7zUH6/af5mk5H27RlCLAgy+Z7u8upiU6ECypUL3Sc2XHpyuXWOA7RcHShN0OeX jAj+MbkuzZ4qqTk0Tb9k2mGj9z+JgbmCZ1kkUWg7F9qyNUkMMUZtlyk8C7NE7I585V H+IsNA46jNkgnWXPgUJGCR+gRvBEf0CuDc7SILrXOCRcewkPte55zTNIPhc7MQMgRY zDKXySfhzX2ToSZ2t6BLv0fFwYeJf4fKwwCKRBh7bH8dTLXxHl5IA8ovHBDfq7Zj3l BK7/isvGljKeg== 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 5/5] misc: mlx5ctl: Add umem reg/unreg ioctl Date: Sun, 19 Nov 2023 01:24:50 -0800 Message-ID: <20231119092450.164996-6-saeed@kernel.org> X-Mailer: git-send-email 2.41.0 In-Reply-To: <20231119092450.164996-1-saeed@kernel.org> References: <20231119092450.164996-1-saeed@kernel.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" From: Saeed Mahameed Command rpc outbox buffer is limited in size, which can be very annoying when trying to pull large traces out of the device. Many device rpcs offer the ability to scatter output traces, contexts and logs directly into user space buffers in a single shot. Allow user to register user memory space, so the device may dump information directly into user memory space. 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. To do so this patch introduces two ioctls: MLX5CTL_IOCTL_UMEM_REG(va_address, size): - calculate page fragments from the user provided virtual address - pin the pages, and allocate a sg list - dma map the sg list - create a UMEM device object that points to the dma addresses - add a driver umem object to an xarray data base for bookkeeping - return UMEM ID to user so it can be used in subsequent rpcs MLX5CTL_IOCTL_UMEM_UNREG(umem_id): - user provides a pre allocated umem ID - unwinds the above Example usecase, ConnectX device coredump can be as large as 2MB. Using inline rpcs will take thousands of rpcs to get the full coredump which can take multiple seconds. With UMEM, it can be done in a single rpc, using 2MB of umem user buffer. $ ./mlx5ctlu mlx5_core.ctl.0 coredump --umem_size=3D$(( 2 ** 20 )) 00 00 00 00 01 00 20 00 00 00 00 04 00 00 48 ec 00 00 00 08 00 00 00 00 00 00 00 0c 00 00 00 03 00 00 00 10 00 00 00 00 00 00 00 14 00 00 00 00 .... 00 50 0b 3c 00 00 00 00 00 50 0b 40 00 00 00 00 00 50 0b 44 00 00 00 00 00 50 0b 48 00 00 00 00 00 50 0c 00 00 00 00 00 INFO : Core dump done INFO : Core dump size 831304 INFO : Core dump address 0x0 INFO : Core dump cookie 0x500c04 INFO : More Dump 0 Other usecases are: dynamic HW and FW trace monitoring, high frequency diagnostic counters sampling and batched objects and resource dumps. Reviewed-by: Jiri Pirko Reviewed-by: Leon Romanovsky Signed-off-by: Saeed Mahameed --- drivers/misc/mlx5ctl/Makefile | 1 + drivers/misc/mlx5ctl/main.c | 81 ++++++++- drivers/misc/mlx5ctl/umem.c | 320 ++++++++++++++++++++++++++++++++++ drivers/misc/mlx5ctl/umem.h | 17 ++ include/uapi/misc/mlx5ctl.h | 16 ++ 5 files changed, 434 insertions(+), 1 deletion(-) create mode 100644 drivers/misc/mlx5ctl/umem.c create mode 100644 drivers/misc/mlx5ctl/umem.h diff --git a/drivers/misc/mlx5ctl/Makefile b/drivers/misc/mlx5ctl/Makefile index b5c7f99e0ab6..f35234e931a8 100644 --- a/drivers/misc/mlx5ctl/Makefile +++ b/drivers/misc/mlx5ctl/Makefile @@ -2,3 +2,4 @@ =20 obj-$(CONFIG_MLX5CTL) +=3D mlx5ctl.o mlx5ctl-y :=3D main.o +mlx5ctl-y +=3D umem.o diff --git a/drivers/misc/mlx5ctl/main.c b/drivers/misc/mlx5ctl/main.c index e7776ea4bfca..58900f2be212 100644 --- a/drivers/misc/mlx5ctl/main.c +++ b/drivers/misc/mlx5ctl/main.c @@ -12,6 +12,8 @@ #include #include =20 +#include "umem.h" + MODULE_DESCRIPTION("mlx5 ConnectX control misc driver"); MODULE_AUTHOR("Saeed Mahameed "); MODULE_LICENSE("Dual BSD/GPL"); @@ -30,6 +32,8 @@ struct mlx5ctl_fd { u16 uctx_uid; u32 uctx_cap; u32 ucap; /* user cap */ + + struct mlx5ctl_umem_db *umem_db; struct mlx5ctl_dev *mcdev; struct list_head list; }; @@ -115,6 +119,12 @@ static int mlx5ctl_open_mfd(struct mlx5ctl_fd *mfd) if (uid < 0) return uid; =20 + mfd->umem_db =3D mlx5ctl_umem_db_create(mdev, uid); + if (IS_ERR(mfd->umem_db)) { + mlx5ctl_release_uid(mcdev, uid); + return PTR_ERR(mfd->umem_db); + } + mfd->uctx_uid =3D uid; mfd->uctx_cap =3D cap; mfd->ucap =3D ucap; @@ -129,6 +139,7 @@ static void mlx5ctl_release_mfd(struct mlx5ctl_fd *mfd) { struct mlx5ctl_dev *mcdev =3D mfd->mcdev; =20 + mlx5ctl_umem_db_destroy(mfd->umem_db); mlx5ctl_release_uid(mcdev, mfd->uctx_uid); } =20 @@ -323,6 +334,57 @@ static int mlx5ctl_cmdrpc_ioctl(struct file *file, return err; } =20 +static int mlx5ctl_ioctl_umem_reg(struct file *file, void __user *arg, + size_t usize) +{ + struct mlx5ctl_fd *mfd =3D file->private_data; + struct mlx5ctl_umem_reg *umem_reg; + int umem_id, err =3D 0; + size_t ksize =3D 0; + + ksize =3D max(sizeof(struct mlx5ctl_umem_reg), usize); + umem_reg =3D kzalloc(ksize, GFP_KERNEL_ACCOUNT); + if (!umem_reg) + return -ENOMEM; + + umem_reg->size =3D sizeof(struct mlx5ctl_umem_reg); + + if (copy_from_user(umem_reg, arg, usize)) { + err =3D -EFAULT; + goto out; + } + + if (umem_reg->flags || umem_reg->reserved1 || umem_reg->reserved2) { + err =3D -EOPNOTSUPP; + goto out; + } + + umem_id =3D mlx5ctl_umem_reg(mfd->umem_db, + (unsigned long)umem_reg->addr, + umem_reg->len); + if (umem_id < 0) { + err =3D umem_id; + goto out; + } + + umem_reg->umem_id =3D umem_id; + + if (copy_to_user(arg, umem_reg, usize)) { + mlx5ctl_umem_unreg(mfd->umem_db, umem_id); + err =3D -EFAULT; + } +out: + kfree(umem_reg); + return err; +} + +static int mlx5ctl_ioctl_umem_unreg(struct file *file, unsigned long arg) +{ + struct mlx5ctl_fd *mfd =3D file->private_data; + + return mlx5ctl_umem_unreg(mfd->umem_db, (u32)arg); +} + static long mlx5ctl_ioctl(struct file *file, unsigned int cmd, unsigned lo= ng arg) { struct mlx5ctl_fd *mfd =3D file->private_data; @@ -352,6 +414,14 @@ static long mlx5ctl_ioctl(struct file *file, unsigned = int cmd, unsigned long arg err =3D mlx5ctl_cmdrpc_ioctl(file, argp, size); break; =20 + case MLX5CTL_IOCTL_UMEM_REG: + err =3D mlx5ctl_ioctl_umem_reg(file, argp, size); + break; + + case MLX5CTL_IOCTL_UMEM_UNREG: + err =3D mlx5ctl_ioctl_umem_unreg(file, arg); + break; + default: mlx5ctl_dbg(mcdev, "Unknown ioctl %x\n", cmd); err =3D -ENOIOCTLCMD; @@ -362,12 +432,21 @@ static long mlx5ctl_ioctl(struct file *file, unsigned= int cmd, unsigned long arg return err; } =20 +static long mlx5ctl_compat_ioctl(struct file *file, unsigned int cmd, unsi= gned long arg) +{ + if (cmd =3D=3D MLX5CTL_IOCTL_UMEM_UNREG) /* arg is a scalar */ + return mlx5ctl_ioctl(file, cmd, arg); + + /* arg is a pointer */ + return compat_ptr_ioctl(file, cmd, arg); +} + static const struct file_operations mlx5ctl_fops =3D { .owner =3D THIS_MODULE, .open =3D mlx5ctl_open, .release =3D mlx5ctl_release, .unlocked_ioctl =3D mlx5ctl_ioctl, - .compat_ioctl =3D compat_ptr_ioctl, + .compat_ioctl =3D mlx5ctl_compat_ioctl, }; =20 static int mlx5ctl_probe(struct auxiliary_device *adev, diff --git a/drivers/misc/mlx5ctl/umem.c b/drivers/misc/mlx5ctl/umem.c new file mode 100644 index 000000000000..0f13ccffe7e7 --- /dev/null +++ b/drivers/misc/mlx5ctl/umem.c @@ -0,0 +1,320 @@ +// SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 +/* Copyright (c) 2023, NVIDIA CORPORATION & AFFILIATES. All rights reserve= d. */ + +#include +#include +#include + +#include "umem.h" + +#define MLX5CTL_UMEM_MAX_MB 64 + +static unsigned long umem_num_pages(u64 addr, size_t len) +{ + return DIV_ROUND_UP(addr + len - PAGE_ALIGN_DOWN(addr), PAGE_SIZE); +} + +struct mlx5ctl_umem { + struct sg_table sgt; + unsigned long addr; + size_t size; + size_t offset; + size_t npages; + struct task_struct *source_task; + struct mm_struct *source_mm; + struct user_struct *source_user; + u32 umem_id; + struct page **page_list; +}; + +struct mlx5ctl_umem_db { + struct xarray xarray; + struct mlx5_core_dev *mdev; + u32 uctx_uid; +}; + +static int inc_user_locked_vm(struct mlx5ctl_umem *umem, unsigned long npa= ges) +{ + unsigned long lock_limit; + unsigned long cur_pages; + unsigned long new_pages; + + lock_limit =3D task_rlimit(umem->source_task, RLIMIT_MEMLOCK) >> + PAGE_SHIFT; + do { + cur_pages =3D atomic_long_read(&umem->source_user->locked_vm); + new_pages =3D cur_pages + npages; + if (new_pages > lock_limit) + return -ENOMEM; + } while (atomic_long_cmpxchg(&umem->source_user->locked_vm, cur_pages, + new_pages) !=3D cur_pages); + return 0; +} + +static void dec_user_locked_vm(struct mlx5ctl_umem *umem, unsigned long np= ages) +{ + if (WARN_ON(atomic_long_read(&umem->source_user->locked_vm) < npages)) + return; + atomic_long_sub(npages, &umem->source_user->locked_vm); +} + +static struct mlx5ctl_umem *mlx5ctl_umem_pin(struct mlx5ctl_umem_db *umem_= db, + unsigned long addr, size_t size) +{ + size_t npages =3D umem_num_pages(addr, size); + struct mlx5_core_dev *mdev =3D umem_db->mdev; + unsigned long endaddr =3D addr + size; + struct mlx5ctl_umem *umem; + struct page **page_list; + int err =3D -EINVAL; + int pinned =3D 0; + + dev_dbg(mdev->device, "%s: addr %p size %zu npages %zu\n", + __func__, (void __user *)addr, size, npages); + + /* Avoid integer overflow */ + if (endaddr < addr || PAGE_ALIGN(endaddr) < endaddr) + return ERR_PTR(-EINVAL); + + if (npages =3D=3D 0 || pages_to_mb(npages) > MLX5CTL_UMEM_MAX_MB) + return ERR_PTR(-EINVAL); + + page_list =3D kvmalloc_array(npages, sizeof(struct page *), GFP_KERNEL_AC= COUNT); + if (!page_list) + return ERR_PTR(-ENOMEM); + + umem =3D kzalloc(sizeof(*umem), GFP_KERNEL_ACCOUNT); + if (!umem) { + kvfree(page_list); + return ERR_PTR(-ENOMEM); + } + + umem->addr =3D addr; + umem->size =3D size; + umem->offset =3D addr & ~PAGE_MASK; + umem->npages =3D npages; + + umem->page_list =3D page_list; + umem->source_mm =3D current->mm; + umem->source_task =3D current->group_leader; + get_task_struct(current->group_leader); + umem->source_user =3D get_uid(current_user()); + + /* mm and RLIMIT_MEMLOCK user task accounting similar to what is + * being done in iopt_alloc_pages() and do_update_pinned() + * for IOPT_PAGES_ACCOUNT_USER @drivers/iommu/iommufd/pages.c + */ + mmgrab(umem->source_mm); + + pinned =3D pin_user_pages_fast(addr, npages, FOLL_WRITE, page_list); + if (pinned !=3D npages) { + dev_dbg(mdev->device, "pin_user_pages_fast failed %d\n", pinned); + err =3D pinned < 0 ? pinned : -ENOMEM; + goto pin_failed; + } + + err =3D inc_user_locked_vm(umem, npages); + if (err) + goto pin_failed; + + atomic64_add(npages, &umem->source_mm->pinned_vm); + + err =3D sg_alloc_table_from_pages(&umem->sgt, page_list, npages, 0, + npages << PAGE_SHIFT, GFP_KERNEL_ACCOUNT); + if (err) { + dev_dbg(mdev->device, "sg_alloc_table failed: %d\n", err); + goto sgt_failed; + } + + dev_dbg(mdev->device, "\tsgt: size %zu npages %zu sgt.nents (%d)\n", + size, npages, umem->sgt.nents); + + err =3D dma_map_sgtable(mdev->device, &umem->sgt, DMA_BIDIRECTIONAL, 0); + if (err) { + dev_dbg(mdev->device, "dma_map_sgtable failed: %d\n", err); + goto dma_failed; + } + + dev_dbg(mdev->device, "\tsgt: dma_nents %d\n", umem->sgt.nents); + return umem; + +dma_failed: +sgt_failed: + sg_free_table(&umem->sgt); + atomic64_sub(npages, &umem->source_mm->pinned_vm); + dec_user_locked_vm(umem, npages); +pin_failed: + if (pinned > 0) + unpin_user_pages(page_list, pinned); + mmdrop(umem->source_mm); + free_uid(umem->source_user); + put_task_struct(umem->source_task); + + kfree(umem); + kvfree(page_list); + return ERR_PTR(err); +} + +static void mlx5ctl_umem_unpin(struct mlx5ctl_umem_db *umem_db, + struct mlx5ctl_umem *umem) +{ + struct mlx5_core_dev *mdev =3D umem_db->mdev; + + dev_dbg(mdev->device, "%s: addr %p size %zu npages %zu dma_nents %d\n", + __func__, (void *)umem->addr, umem->size, umem->npages, + umem->sgt.nents); + + dma_unmap_sgtable(mdev->device, &umem->sgt, DMA_BIDIRECTIONAL, 0); + sg_free_table(&umem->sgt); + + atomic64_sub(umem->npages, &umem->source_mm->pinned_vm); + dec_user_locked_vm(umem, umem->npages); + unpin_user_pages(umem->page_list, umem->npages); + mmdrop(umem->source_mm); + free_uid(umem->source_user); + put_task_struct(umem->source_task); + + kvfree(umem->page_list); + kfree(umem); +} + +static int mlx5ctl_umem_create(struct mlx5_core_dev *mdev, + struct mlx5ctl_umem *umem, u32 uid) +{ + u32 out[MLX5_ST_SZ_DW(create_umem_out)] =3D {}; + int err, inlen, i, n =3D 0; + struct scatterlist *sg; + void *in, *umemptr; + __be64 *mtt; + + inlen =3D MLX5_ST_SZ_BYTES(create_umem_in) + + umem->npages * MLX5_ST_SZ_BYTES(mtt); + + in =3D kzalloc(inlen, GFP_KERNEL_ACCOUNT); + if (!in) + return -ENOMEM; + + MLX5_SET(create_umem_in, in, opcode, MLX5_CMD_OP_CREATE_UMEM); + MLX5_SET(create_umem_in, in, uid, uid); + + umemptr =3D MLX5_ADDR_OF(create_umem_in, in, umem); + + MLX5_SET(umem, umemptr, log_page_size, + PAGE_SHIFT - MLX5_ADAPTER_PAGE_SHIFT); + MLX5_SET64(umem, umemptr, num_of_mtt, umem->npages); + MLX5_SET(umem, umemptr, page_offset, umem->offset); + + dev_dbg(mdev->device, + "UMEM CREATE: log_page_size %d num_of_mtt %lld page_offset %d\n", + MLX5_GET(umem, umemptr, log_page_size), + MLX5_GET64(umem, umemptr, num_of_mtt), + MLX5_GET(umem, umemptr, page_offset)); + + mtt =3D MLX5_ADDR_OF(create_umem_in, in, umem.mtt); + for_each_sgtable_dma_sg(&umem->sgt, sg, i) { + u64 dma_addr =3D sg_dma_address(sg); + ssize_t len =3D sg_dma_len(sg); + + for (; n < umem->npages && len > 0; n++, mtt++) { + *mtt =3D cpu_to_be64(dma_addr); + MLX5_SET(mtt, mtt, wr_en, 1); + MLX5_SET(mtt, mtt, rd_en, 1); + dma_addr +=3D PAGE_SIZE; + len -=3D PAGE_SIZE; + } + WARN_ON_ONCE(n =3D=3D umem->npages && len > 0); + } + + err =3D mlx5_cmd_exec(mdev, in, inlen, out, sizeof(out)); + if (err) + goto out; + + umem->umem_id =3D MLX5_GET(create_umem_out, out, umem_id); + dev_dbg(mdev->device, "\tUMEM CREATED: umem_id %d\n", umem->umem_id); +out: + kfree(in); + return err; +} + +static void mlx5ctl_umem_destroy(struct mlx5_core_dev *mdev, + struct mlx5ctl_umem *umem) +{ + u32 in[MLX5_ST_SZ_DW(destroy_umem_in)] =3D {}; + + MLX5_SET(destroy_umem_in, in, opcode, MLX5_CMD_OP_DESTROY_UMEM); + MLX5_SET(destroy_umem_in, in, umem_id, umem->umem_id); + + dev_dbg(mdev->device, "UMEM DESTROY: umem_id %d\n", umem->umem_id); + mlx5_cmd_exec_in(mdev, destroy_umem, in); +} + +int mlx5ctl_umem_reg(struct mlx5ctl_umem_db *umem_db, unsigned long addr, + size_t size) +{ + struct mlx5ctl_umem *umem; + void *ret; + int err; + + umem =3D mlx5ctl_umem_pin(umem_db, addr, size); + if (IS_ERR(umem)) + return PTR_ERR(umem); + + err =3D mlx5ctl_umem_create(umem_db->mdev, umem, umem_db->uctx_uid); + if (err) + goto umem_create_err; + + ret =3D xa_store(&umem_db->xarray, umem->umem_id, umem, GFP_KERNEL_ACCOUN= T); + if (WARN(xa_is_err(ret), "Failed to store UMEM")) { + err =3D xa_err(ret); + goto xa_store_err; + } + + return umem->umem_id; + +xa_store_err: + mlx5ctl_umem_destroy(umem_db->mdev, umem); +umem_create_err: + mlx5ctl_umem_unpin(umem_db, umem); + return err; +} + +int mlx5ctl_umem_unreg(struct mlx5ctl_umem_db *umem_db, u32 umem_id) +{ + struct mlx5ctl_umem *umem; + + umem =3D xa_erase(&umem_db->xarray, umem_id); + if (!umem) + return -ENOENT; + + mlx5ctl_umem_destroy(umem_db->mdev, umem); + mlx5ctl_umem_unpin(umem_db, umem); + return 0; +} + +struct mlx5ctl_umem_db *mlx5ctl_umem_db_create(struct mlx5_core_dev *mdev, + u32 uctx_uid) +{ + struct mlx5ctl_umem_db *umem_db; + + umem_db =3D kzalloc(sizeof(*umem_db), GFP_KERNEL_ACCOUNT); + if (!umem_db) + return ERR_PTR(-ENOMEM); + + xa_init(&umem_db->xarray); + umem_db->mdev =3D mdev; + umem_db->uctx_uid =3D uctx_uid; + + return umem_db; +} + +void mlx5ctl_umem_db_destroy(struct mlx5ctl_umem_db *umem_db) +{ + struct mlx5ctl_umem *umem; + unsigned long index; + + xa_for_each(&umem_db->xarray, index, umem) + mlx5ctl_umem_unreg(umem_db, umem->umem_id); + + xa_destroy(&umem_db->xarray); + kfree(umem_db); +} diff --git a/drivers/misc/mlx5ctl/umem.h b/drivers/misc/mlx5ctl/umem.h new file mode 100644 index 000000000000..9cf62e5e775e --- /dev/null +++ b/drivers/misc/mlx5ctl/umem.h @@ -0,0 +1,17 @@ +/* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */ +/* Copyright (c) 2023, NVIDIA CORPORATION & AFFILIATES. All rights reserve= d. */ + +#ifndef __MLX5CTL_UMEM_H__ +#define __MLX5CTL_UMEM_H__ + +#include +#include + +struct mlx5ctl_umem_db; + +struct mlx5ctl_umem_db *mlx5ctl_umem_db_create(struct mlx5_core_dev *mdev,= u32 uctx_uid); +void mlx5ctl_umem_db_destroy(struct mlx5ctl_umem_db *umem_db); +int mlx5ctl_umem_reg(struct mlx5ctl_umem_db *umem_db, unsigned long addr, = size_t size); +int mlx5ctl_umem_unreg(struct mlx5ctl_umem_db *umem_db, u32 umem_id); + +#endif /* __MLX5CTL_UMEM_H__ */ diff --git a/include/uapi/misc/mlx5ctl.h b/include/uapi/misc/mlx5ctl.h index 3277eaf78a37..eaf6c954a1ff 100644 --- a/include/uapi/misc/mlx5ctl.h +++ b/include/uapi/misc/mlx5ctl.h @@ -24,6 +24,16 @@ struct mlx5ctl_cmdrpc { __aligned_u64 flags; }; =20 +struct mlx5ctl_umem_reg { + __aligned_u64 flags; + __u32 size; + __u32 reserved1; + __aligned_u64 addr; /* user address */ + __aligned_u64 len; /* user buffer length */ + __u32 umem_id; /* returned device's umem ID */ + __u32 reserved2; +}; + #define MLX5CTL_MAX_RPC_SIZE 8192 =20 #define MLX5CTL_IOCTL_MAGIC 0x5c @@ -34,4 +44,10 @@ struct mlx5ctl_cmdrpc { #define MLX5CTL_IOCTL_CMDRPC \ _IOWR(MLX5CTL_IOCTL_MAGIC, 0x1, struct mlx5ctl_cmdrpc) =20 +#define MLX5CTL_IOCTL_UMEM_REG \ + _IOWR(MLX5CTL_IOCTL_MAGIC, 0x2, struct mlx5ctl_umem_reg) + +#define MLX5CTL_IOCTL_UMEM_UNREG \ + _IO(MLX5CTL_IOCTL_MAGIC, 0x3) + #endif /* __MLX5CTL_IOCTL_H__ */ --=20 2.41.0