From patchwork Fri Apr 19 08:35:59 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Marco Pagani X-Patchwork-Id: 13635938 Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 3E4DD4CE05 for ; Fri, 19 Apr 2024 08:36:10 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=170.10.133.124 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1713515771; cv=none; b=joR8wZM3TaTJAQJQDxbyj3Otl7XuYjB8HoLHxGCEbe4UUNs/4yi8NTWuntQPmwNbfOf6f4a4XzvUsusjV4nHGWTF/Q86IwWvLCm92du05pMYMyKrNZKkR11Xya96eAKnXb4p9xYHhQOa70ewlJKgZq9CVzRbFkn0VqvpcwjqOVg= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1713515771; c=relaxed/simple; bh=ki32pQWZPdeOnqu6wy6iaFLnakDcjYIYqsw/JYzRlS0=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=UvaPSpQMovtHZWcNbpxq2OdnEaZ2QfqLlXg0a+ZWRkY0yjC/7kIXj4sNxIwdrPQArM4PYBx1BPrIJ19/nw2puybY9Rk2EEfa0jY+371JxofBKuugg5BjPANph8DznjQ0hnWTug/gcEPVjZcD41HclIFxWNWQmy5QG7p1V1R4ONo= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=redhat.com; spf=pass smtp.mailfrom=redhat.com; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b=iwh3bAjA; arc=none smtp.client-ip=170.10.133.124 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=redhat.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=redhat.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="iwh3bAjA" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1713515769; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding; bh=m8Z4JwBEgcNs/PB0AnWXpJ2AEsgxb+gwBzYIddtlxkc=; b=iwh3bAjAv9C/g9W9LmObq1/+7OUuOmZc1joXM3KnSXFC4oRTYlNuILel3PoU9OtTxK6ZVx OAASKRNjafzcc5/6uzxLdkJJamuduIo5LkFxWoYHIfqnhQsS8AKn9LOpoNf0h+b5FB19O8 3CXSn1PnEN/PK4Le1ncSlhWrz0clEZE= Received: from mail-qv1-f70.google.com (mail-qv1-f70.google.com [209.85.219.70]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-226-NrNvrVHjOw-2fm2DXWK65A-1; Fri, 19 Apr 2024 04:36:08 -0400 X-MC-Unique: NrNvrVHjOw-2fm2DXWK65A-1 Received: by mail-qv1-f70.google.com with SMTP id 6a1803df08f44-69b7ea6fdb2so22600806d6.1 for ; Fri, 19 Apr 2024 01:36:08 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1713515767; x=1714120567; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=m8Z4JwBEgcNs/PB0AnWXpJ2AEsgxb+gwBzYIddtlxkc=; b=RNtqLYV/XwiVQ6RSLGuWQvG5t4Sl/WKXCzc7qD2VKqzNd7OCZ91UlrXg5E8wzJANpR SaOs0Inao4f2DEV3a7tTxPTFyVmzUQiBXiCLnui8LrN7k2WUYsLtYO2sQaEWuE9Ez3qf 3fmoRPFSsuBUddtShVfdjrVlklEOUiJjgFWoa2xeqn9IBjkEC0ouurwQnKlKWnOcX/VN yMRzG8HcoLGjEaYTX2MM2CBynq7DqR+bziP/qL108XZ+gYXTJQg83x53VCjhtpWF7YB6 9OmCY7G7PO9FpnCGPh0Z0y1XsOxs3vi76fDYYzqWaRXGf73aE3Baf7JPzdfuoNmvnxnM tr+g== X-Forwarded-Encrypted: i=1; AJvYcCWAxFfK/nlfajPy4ebhrITqeXnYrsAx2A7GCEl7IxUlGIR+bno1WEOonc2QIYAD9V8VpOdWahgx87gQc3/y2bvHQLkBnSikObglhQ== X-Gm-Message-State: AOJu0YzfGDAUEufD6MXIxiDQJz9wnUcKgzqLt4fAdjsHWwXMoZnfL7wo QAMufWksztIOMsmKbE/W3zUUI6VVwUG11ZoTAFhzq3ipBk+5tM8bZxbbZ/4jt1aFcdj4Ub0CSYi 8o91mvLt/avc2FBxchA020E0qSydMvWdmn8k7RiUDrBR+iU4okhAPUpzliQ== X-Received: by 2002:a0c:f583:0:b0:69b:695e:bde1 with SMTP id k3-20020a0cf583000000b0069b695ebde1mr1579691qvm.5.1713515767574; Fri, 19 Apr 2024 01:36:07 -0700 (PDT) X-Google-Smtp-Source: AGHT+IEGlA/WHb28Nuedm28MeG6UOBldUGYch8jOZ6vtabDmqXmylQ9Td7yq87/W2KGiQ+Yy3+jupA== X-Received: by 2002:a0c:f583:0:b0:69b:695e:bde1 with SMTP id k3-20020a0cf583000000b0069b695ebde1mr1579679qvm.5.1713515767287; Fri, 19 Apr 2024 01:36:07 -0700 (PDT) Received: from klayman.redhat.com (net-2-34-26-208.cust.vodafonedsl.it. [2.34.26.208]) by smtp.gmail.com with ESMTPSA id n11-20020a0ce48b000000b0069b6c831e86sm1368482qvl.97.2024.04.19.01.36.05 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 19 Apr 2024 01:36:07 -0700 (PDT) From: Marco Pagani To: Moritz Fischer , Wu Hao , Xu Yilun , Tom Rix , Jonathan Corbet , Alan Tull , Greg Kroah-Hartman Cc: Marco Pagani , Russ Weight , linux-fpga@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v6] fpga: region: add owner module and take its refcount Date: Fri, 19 Apr 2024 10:35:59 +0200 Message-ID: <20240419083601.77403-1-marpagan@redhat.com> X-Mailer: git-send-email 2.44.0 Precedence: bulk X-Mailing-List: linux-fpga@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 The current implementation of the fpga region assumes that the low-level module registers a driver for the parent device and uses its owner pointer to take the module's refcount. This approach is problematic since it can lead to a null pointer dereference while attempting to get the region during programming if the parent device does not have a driver. To address this problem, add a module owner pointer to the fpga_region struct and use it to take the module's refcount. Modify the functions for registering a region to take an additional owner module parameter and rename them to avoid conflicts. Use the old function names for helper macros that automatically set the module that registers the region as the owner. This ensures compatibility with existing low-level control modules and reduces the chances of registering a region without setting the owner. Also, update the documentation to keep it consistent with the new interface for registering an fpga region. Fixes: 0fa20cdfcc1f ("fpga: fpga-region: device tree control for FPGA") Suggested-by: Greg Kroah-Hartman Suggested-by: Xu Yilun Reviewed-by: Russ Weight Signed-off-by: Marco Pagani Acked-by: Xu Yilun --- v6: - Fixed typos in the @owner parameter description v5: - Reverted function names swap in the documentation - Renamed owner module pointer br_owner -> ops_owner v4: - Split out the swap between put_device() and mutex_unlock() while releasing the region to avoid potential use after release issues v3: - Add reviewed-by Russ Weight v2: - Fixed typo in the documentation sets -> set - Renamed owner module pointer get_br_owner -> br_owner --- Documentation/driver-api/fpga/fpga-region.rst | 13 ++++++---- drivers/fpga/fpga-region.c | 24 +++++++++++-------- include/linux/fpga/fpga-region.h | 13 +++++++--- 3 files changed, 32 insertions(+), 18 deletions(-) base-commit: 5d04660b29fb31e88e945c8b3eb658976824d0fa diff --git a/Documentation/driver-api/fpga/fpga-region.rst b/Documentation/driver-api/fpga/fpga-region.rst index dc55d60a0b4a..2d03b5fb7657 100644 --- a/Documentation/driver-api/fpga/fpga-region.rst +++ b/Documentation/driver-api/fpga/fpga-region.rst @@ -46,13 +46,16 @@ API to add a new FPGA region ---------------------------- * struct fpga_region - The FPGA region struct -* struct fpga_region_info - Parameter structure for fpga_region_register_full() -* fpga_region_register_full() - Create and register an FPGA region using the +* struct fpga_region_info - Parameter structure for __fpga_region_register_full() +* __fpga_region_register_full() - Create and register an FPGA region using the fpga_region_info structure to provide the full flexibility of options -* fpga_region_register() - Create and register an FPGA region using standard +* __fpga_region_register() - Create and register an FPGA region using standard arguments * fpga_region_unregister() - Unregister an FPGA region +Helper macros ``fpga_region_register()`` and ``fpga_region_register_full()`` +automatically set the module that registers the FPGA region as the owner. + The FPGA region's probe function will need to get a reference to the FPGA Manager it will be using to do the programming. This usually would happen during the region's probe function. @@ -82,10 +85,10 @@ following APIs to handle building or tearing down that list. :functions: fpga_region_info .. kernel-doc:: drivers/fpga/fpga-region.c - :functions: fpga_region_register_full + :functions: __fpga_region_register_full .. kernel-doc:: drivers/fpga/fpga-region.c - :functions: fpga_region_register + :functions: __fpga_region_register .. kernel-doc:: drivers/fpga/fpga-region.c :functions: fpga_region_unregister diff --git a/drivers/fpga/fpga-region.c b/drivers/fpga/fpga-region.c index b364a929425c..753cd142503e 100644 --- a/drivers/fpga/fpga-region.c +++ b/drivers/fpga/fpga-region.c @@ -53,7 +53,7 @@ static struct fpga_region *fpga_region_get(struct fpga_region *region) } get_device(dev); - if (!try_module_get(dev->parent->driver->owner)) { + if (!try_module_get(region->ops_owner)) { put_device(dev); mutex_unlock(®ion->mutex); return ERR_PTR(-ENODEV); @@ -75,7 +75,7 @@ static void fpga_region_put(struct fpga_region *region) dev_dbg(dev, "put\n"); - module_put(dev->parent->driver->owner); + module_put(region->ops_owner); put_device(dev); mutex_unlock(®ion->mutex); } @@ -181,14 +181,16 @@ static struct attribute *fpga_region_attrs[] = { ATTRIBUTE_GROUPS(fpga_region); /** - * fpga_region_register_full - create and register an FPGA Region device + * __fpga_region_register_full - create and register an FPGA Region device * @parent: device parent * @info: parameters for FPGA Region + * @owner: module containing the get_bridges function * * Return: struct fpga_region or ERR_PTR() */ struct fpga_region * -fpga_region_register_full(struct device *parent, const struct fpga_region_info *info) +__fpga_region_register_full(struct device *parent, const struct fpga_region_info *info, + struct module *owner) { struct fpga_region *region; int id, ret = 0; @@ -213,6 +215,7 @@ fpga_region_register_full(struct device *parent, const struct fpga_region_info * region->compat_id = info->compat_id; region->priv = info->priv; region->get_bridges = info->get_bridges; + region->ops_owner = owner; mutex_init(®ion->mutex); INIT_LIST_HEAD(®ion->bridge_list); @@ -241,13 +244,14 @@ fpga_region_register_full(struct device *parent, const struct fpga_region_info * return ERR_PTR(ret); } -EXPORT_SYMBOL_GPL(fpga_region_register_full); +EXPORT_SYMBOL_GPL(__fpga_region_register_full); /** - * fpga_region_register - create and register an FPGA Region device + * __fpga_region_register - create and register an FPGA Region device * @parent: device parent * @mgr: manager that programs this region * @get_bridges: optional function to get bridges to a list + * @owner: module containing the get_bridges function * * This simple version of the register function should be sufficient for most users. * The fpga_region_register_full() function is available for users that need to @@ -256,17 +260,17 @@ EXPORT_SYMBOL_GPL(fpga_region_register_full); * Return: struct fpga_region or ERR_PTR() */ struct fpga_region * -fpga_region_register(struct device *parent, struct fpga_manager *mgr, - int (*get_bridges)(struct fpga_region *)) +__fpga_region_register(struct device *parent, struct fpga_manager *mgr, + int (*get_bridges)(struct fpga_region *), struct module *owner) { struct fpga_region_info info = { 0 }; info.mgr = mgr; info.get_bridges = get_bridges; - return fpga_region_register_full(parent, &info); + return __fpga_region_register_full(parent, &info, owner); } -EXPORT_SYMBOL_GPL(fpga_region_register); +EXPORT_SYMBOL_GPL(__fpga_region_register); /** * fpga_region_unregister - unregister an FPGA region diff --git a/include/linux/fpga/fpga-region.h b/include/linux/fpga/fpga-region.h index 9d4d32909340..5fbc05fe70a6 100644 --- a/include/linux/fpga/fpga-region.h +++ b/include/linux/fpga/fpga-region.h @@ -36,6 +36,7 @@ struct fpga_region_info { * @mgr: FPGA manager * @info: FPGA image info * @compat_id: FPGA region id for compatibility check. + * @ops_owner: module containing the get_bridges function * @priv: private data * @get_bridges: optional function to get bridges to a list */ @@ -46,6 +47,7 @@ struct fpga_region { struct fpga_manager *mgr; struct fpga_image_info *info; struct fpga_compat_id *compat_id; + struct module *ops_owner; void *priv; int (*get_bridges)(struct fpga_region *region); }; @@ -58,12 +60,17 @@ fpga_region_class_find(struct device *start, const void *data, int fpga_region_program_fpga(struct fpga_region *region); +#define fpga_region_register_full(parent, info) \ + __fpga_region_register_full(parent, info, THIS_MODULE) struct fpga_region * -fpga_region_register_full(struct device *parent, const struct fpga_region_info *info); +__fpga_region_register_full(struct device *parent, const struct fpga_region_info *info, + struct module *owner); +#define fpga_region_register(parent, mgr, get_bridges) \ + __fpga_region_register(parent, mgr, get_bridges, THIS_MODULE) struct fpga_region * -fpga_region_register(struct device *parent, struct fpga_manager *mgr, - int (*get_bridges)(struct fpga_region *)); +__fpga_region_register(struct device *parent, struct fpga_manager *mgr, + int (*get_bridges)(struct fpga_region *), struct module *owner); void fpga_region_unregister(struct fpga_region *region); #endif /* _FPGA_REGION_H */