cxl/port: Use __free() to drop put_device() for cxl_port
PATCH v3 1/3 cxl/port: Use __free() to drop put_device() for cxl_port
Using scope-based resource management __free() marco with a new helper called put_cxl_port() to drop open coded the put_device() used to dereference the 'struct device' in cxl_port.
---
v3:
- Jonathan: Keep the dereference sequence between port and parent port.
- Jonathan: Adjust the changelog of the patch 3.
Link to v2: https://lore.kernel.org/linux-cxl/[email protected]/T/#m49c20d7834114878c2e4ad03a55da8d4999caa59
v2:
- Use guard() instead of scoped_guard() in some cases.
- Ira: Check the return value of find_cxl_port_at().
Link to v1: https://lore.kernel.org/linux-cxl/[email protected]/T/#m07695675435bf702311dfc40f64289b9623afa16
--- drivers/cxl/core/pci.c | 6 ++---- drivers/cxl/core/port.c | 30 +++++++++++++----------------- drivers/cxl/cxl.h | 1 + drivers/cxl/mem.c | 5 ++--- drivers/cxl/pci.c | 7 ++----- 5 files changed, 20 insertions(+), 29 deletions(-)
drivers/cxl/core/pci.c +2 -4
@@ -915,15 +915,13 @@ static void cxl_handle_rdport_errors(struct cxl_dev_state *cxlds)struct pci_dev *pdev =to_pci_dev (cxlds->dev);struct aer_capability_regs aer_regs;struct cxl_dport *dport; -struct cxl_port *port;int severity; - port =cxl_pci_find_port (pdev, &dport); + struct cxl_port *port __free(put_cxl_port) = +cxl_pci_find_port (pdev, &dport);if (!port)return ; -put_device (&port->dev); -if (!cxl_rch_get_aer_info (dport->regs.dport_aer, &aer_regs))return ;
drivers/cxl/core/port.c +13 -17
@@ -1477,12 +1477,11 @@ static void cxl_detach_ep(void *data) .cxlmd = cxlmd, .depth = i, }; -struct device *dev;struct cxl_ep *ep;bool died = false; - dev =bus_find_device (&cxl_bus_type,NULL , &ctx, - port_has_memdev); + struct device *dev __free(put_device) = +bus_find_device (&cxl_bus_type,NULL , &ctx, port_has_memdev);if (!dev)continue ; port =to_cxl_port (dev);
@@ -1512,7 +1511,6 @@ static void cxl_detach_ep(void *data) dev_name(&port->dev));delete_switch_port (port); } -put_device (&port->dev);device_unlock (&parent_port->dev); } }
@@ -1540,7 +1538,6 @@ static int add_port_attach_ep(struct cxl_memdev *cxlmd, struct device *dport_dev) {struct device *dparent =grandparent (dport_dev); -struct cxl_port *port, *parent_port =NULL ;struct cxl_dport *dport, *parent_dport;resource_size_t component_reg_phys;int rc;
@@ -1556,12 +1553,18 @@ static int add_port_attach_ep(struct cxl_memdev *cxlmd,return -ENXIO ; } - parent_port =find_cxl_port (dparent, &parent_dport); + struct cxl_port *parent_port __free(put_cxl_port) = +find_cxl_port (dparent, &parent_dport);if (!parent_port) {/* iterate to create this parent_port */ return -EAGAIN ; } +/* +* Definition with __free() here to keep the sequence of +* dereferencing the device of the port before the parent_port releasing. +*/ + struct cxl_port *port __free(put_cxl_port) = NULL;device_lock (&parent_port->dev);if (!parent_port->dev.driver) { dev_warn(&cxlmd->dev,
@@ -1596,10 +1599,8 @@ static int add_port_attach_ep(struct cxl_memdev *cxlmd,*/ rc = -ENXIO ; } -put_device (&port->dev); } -put_device (&parent_port->dev);return rc; }
@@ -1630,7 +1631,6 @@ int devm_cxl_enumerate_ports(struct cxl_memdev *cxlmd)struct device *dport_dev =grandparent (iter);struct device *uport_dev;struct cxl_dport *dport; -struct cxl_port *port;/* * The terminal "grandparent" in PCI is NULL and @platform_bus
@@ -1649,7 +1649,8 @@ int devm_cxl_enumerate_ports(struct cxl_memdev *cxlmd)dev_dbg (dev,"scan: iter: %s dport_dev: %s parent: %s\n" ,dev_name (iter),dev_name (dport_dev),dev_name (uport_dev)); - port =find_cxl_port (dport_dev, &dport); + struct cxl_port *port __free(put_cxl_port) = +find_cxl_port (dport_dev, &dport);if (port) { dev_dbg(&cxlmd->dev, "found already registered port %s:%s\n",
@@ -1664,18 +1665,13 @@ int devm_cxl_enumerate_ports(struct cxl_memdev *cxlmd)* the parent_port lock as the current port may be being * reaped. */ -if (rc && rc != -EBUSY ) { -put_device (&port->dev); +if (rc && rc != -EBUSY )return rc; - }/* Any more ports to add between this one and the root? */ -if (!dev_is_cxl_root_child (&port->dev)) { -put_device (&port->dev); +if (!dev_is_cxl_root_child (&port->dev))continue ; - } -put_device (&port->dev);return 0 ; }
drivers/cxl/cxl.h +1 -0
@@ -744,6 +744,7 @@ struct cxl_root *find_cxl_root(struct cxl_port *port);void put_cxl_root (struct cxl_root *cxl_root); DEFINE_FREE(put_cxl_root, struct cxl_root *, if (_T) put_cxl_root(_T)) +DEFINE_FREE(put_cxl_port, struct cxl_port *, if (!IS_ERR_OR_NULL(_T)) put_device(&_T->dev))int devm_cxl_enumerate_ports (struct cxl_memdev *cxlmd);void cxl_bus_rescan (void );void cxl_bus_drain (void );
drivers/cxl/mem.c +2 -3
@@ -109,7 +109,6 @@ static int cxl_mem_probe(struct device *dev)struct cxl_memdev_state *mds =to_cxl_memdev_state (cxlmd->cxlds);struct cxl_dev_state *cxlds = cxlmd->cxlds;struct device *endpoint_parent; -struct cxl_port *parent_port;struct cxl_dport *dport;struct dentry *dentry;int rc;
@@ -146,7 +145,8 @@ static int cxl_mem_probe(struct device *dev)if (rc)return rc; - parent_port =cxl_mem_find_port (cxlmd, &dport); + struct cxl_port *parent_port __free(put_cxl_port) = +cxl_mem_find_port (cxlmd, &dport);if (!parent_port) {dev_err (dev,"CXL port topology not found\n" );return -ENXIO ;
@@ -179,7 +179,6 @@ static int cxl_mem_probe(struct device *dev) rc =devm_cxl_add_endpoint (endpoint_parent, cxlmd, dport); unlock:device_unlock (endpoint_parent); -put_device (&parent_port->dev);if (rc)return rc;
drivers/cxl/pci.c +2 -5
@@ -473,7 +473,6 @@ static bool is_cxl_restricted(struct pci_dev *pdev)static int cxl_rcrb_get_comp_regs (struct pci_dev *pdev,struct cxl_register_map *map) { -struct cxl_port *port;struct cxl_dport *dport;resource_size_t component_reg_phys;
@@ -482,14 +481,12 @@ static int cxl_rcrb_get_comp_regs(struct pci_dev *pdev, .resource = CXL_RESOURCE_NONE, }; - port =cxl_pci_find_port (pdev, &dport); + struct cxl_port *port __free(put_cxl_port) = +cxl_pci_find_port (pdev, &dport);if (!port)return -EPROBE_DEFER ; component_reg_phys =cxl_rcd_component_reg_phys (&pdev->dev, dport); - -put_device (&port->dev); -if (component_reg_phys ==CXL_RESOURCE_NONE )return -ENXIO ;
Signature · 1 line
2.40.1
PATCH v3 2/3 cxl/port: Use scoped_guard()/guard() to drop device_lock() for cxl_port
A device_lock() and device_unlock() pair can be replaced by a cleanup helper scoped_guard() or guard(), that can enhance code readability. In CXL subsystem, still use device_lock() and device_unlock() pairs for cxl port resource protection, most of them can be replaced by a scoped_guard() or a guard() simply.
--- drivers/cxl/core/mbox.c | 3 +- drivers/cxl/core/port.c | 93 +++++++++++++++++---------------------- drivers/cxl/core/region.c | 25 ++++++----- drivers/cxl/mem.c | 22 +++++---- drivers/cxl/pmem.c | 16 +++---- 5 files changed, 72 insertions(+), 87 deletions(-)
drivers/cxl/core/mbox.c +1 -2
@@ -1214,7 +1214,7 @@ int cxl_mem_sanitize(struct cxl_memdev *cxlmd, u16 cmd)int rc;/* synchronize with cxl_mem_probe() and decoder write operations */ -device_lock (&cxlmd->dev); +guard (device)(&cxlmd->dev); endpoint = cxlmd->endpoint;down_read (&cxl_region_rwsem);/*
@@ -1226,7 +1226,6 @@ int cxl_mem_sanitize(struct cxl_memdev *cxlmd, u16 cmd)else rc = -EBUSY ;up_read (&cxl_region_rwsem); -device_unlock (&cxlmd->dev);return rc; }
drivers/cxl/core/port.c +41 -52
131 lines not on this page · raw message
drivers/cxl/core/region.c +13 -12
@@ -3094,11 +3094,11 @@ static void cxlr_release_nvdimm(void *_cxlr)struct cxl_region *cxlr = _cxlr;struct cxl_nvdimm_bridge *cxl_nvb = cxlr->cxl_nvb; -device_lock (&cxl_nvb->dev); -if (cxlr->cxlr_pmem) -devm_release_action (&cxl_nvb->dev, cxlr_pmem_unregister, - cxlr->cxlr_pmem); -device_unlock (&cxl_nvb->dev); + scoped_guard(device, &cxl_nvb->dev) { +if (cxlr->cxlr_pmem) +devm_release_action (&cxl_nvb->dev, cxlr_pmem_unregister, + cxlr->cxlr_pmem); + } cxlr->cxl_nvb =NULL ;put_device (&cxl_nvb->dev); }
@@ -3134,13 +3134,14 @@ static int devm_cxl_add_pmem_region(struct cxl_region *cxlr)dev_dbg (&cxlr->dev,"%s: register %s\n" ,dev_name (dev->parent),dev_name (dev)); -device_lock (&cxl_nvb->dev); -if (cxl_nvb->dev.driver) - rc =devm_add_action_or_reset (&cxl_nvb->dev, - cxlr_pmem_unregister, cxlr_pmem); -else - rc = -ENXIO ; -device_unlock (&cxl_nvb->dev); + scoped_guard(device, &cxl_nvb->dev) { +if (cxl_nvb->dev.driver) + rc =devm_add_action_or_reset (&cxl_nvb->dev, + cxlr_pmem_unregister, + cxlr_pmem); +else + rc = -ENXIO ; + }if (rc) goto err_bridge;
drivers/cxl/mem.c +10 -12
@@ -168,19 +168,17 @@ static int cxl_mem_probe(struct device *dev)cxl_setup_parent_dport (dev, dport); -device_lock (endpoint_parent); -if (!endpoint_parent->driver) { -dev_err (dev,"CXL port topology %s not enabled\n" , -dev_name (endpoint_parent)); - rc = -ENXIO ; - goto unlock; - } + scoped_guard(device, endpoint_parent) { +if (!endpoint_parent->driver) { +dev_err (dev,"CXL port topology %s not enabled\n" , +dev_name (endpoint_parent)); +return -ENXIO ; + } - rc =devm_cxl_add_endpoint (endpoint_parent, cxlmd, dport); -unlock: -device_unlock (endpoint_parent); -if (rc) -return rc; + rc =devm_cxl_add_endpoint (endpoint_parent, cxlmd, dport); +if (rc) +return rc; + }/* * The kernel may be operating out of CXL memory on this device,
drivers/cxl/pmem.c +7 -9
@@ -233,15 +233,13 @@ static int detach_nvdimm(struct device *dev, void *data)if (!is_cxl_nvdimm (dev))return 0 ; -device_lock (dev); -if (!dev->driver) - goto out; - - cxl_nvd =to_cxl_nvdimm (dev); -if (cxl_nvd->cxlmd && cxl_nvd->cxlmd->cxl_nvb == data) - release = true; -out: -device_unlock (dev); + scoped_guard(device, dev) { +if (dev->driver) { + cxl_nvd =to_cxl_nvdimm (dev); +if (cxl_nvd->cxlmd && cxl_nvd->cxlmd->cxl_nvb == data) + release = true; + } + }if (release)device_release_driver (dev);return 0 ;
Signature · 1 line
2.40.1
PATCH v3 3/3 cxl/port: Refactor __devm_cxl_add_port() to drop goto pattern
In reply to Li MingIn __devm_cxl_add_port(), there is a 'goto' to call put_device() for the error cases between device_initialize() and device_add() to dereference the 'struct device' of a new cxl_port. The 'goto' pattern in the case can be removed by refactoring. Introducing a new function called cxl_port_add() which is used to add the 'struct device' of a new cxl_port to device hierarchy, moving the functions needing the help of the 'goto' into cxl_port_add(), and using a scoped-based resource management __free() to drop the open coded put_device() and the 'goto' for the error cases.
--- drivers/cxl/core/port.c | 59 ++++++++++++++++++++++++----------------- 1 file changed, 35 insertions(+), 24 deletions(-)
drivers/cxl/core/port.c +35 -24
@@ -828,27 +828,20 @@ static void cxl_debugfs_create_dport_dir(struct cxl_dport *dport) &cxl_einj_inject_fops); } -static struct cxl_port *__devm_cxl_add_port (struct device *host, -struct device *uport_dev, -resource_size_t component_reg_phys, -struct cxl_dport *parent_dport) +static int cxl_port_add (struct cxl_port *port, +resource_size_t component_reg_phys, +struct cxl_dport *parent_dport) { -struct cxl_port *port; -struct device *dev; + struct device *dev __free(put_device) = &port->dev;int rc; - port =cxl_port_alloc (uport_dev, parent_dport); -if (IS_ERR (port)) -return port; - - dev = &port->dev; -if (is_cxl_memdev (uport_dev)) { -struct cxl_memdev *cxlmd =to_cxl_memdev (uport_dev); +if (is_cxl_memdev (port->uport_dev)) { +struct cxl_memdev *cxlmd =to_cxl_memdev (port->uport_dev);struct cxl_dev_state *cxlds = cxlmd->cxlds; rc =dev_set_name (dev,"endpoint%d" , port->id);if (rc) - goto err; +return rc;/* * The endpoint driver already enumerated the component and RAS
@@ -861,19 +854,41 @@ static struct cxl_port *__devm_cxl_add_port(struct device *host, }else if (parent_dport) { rc =dev_set_name (dev,"port%d" , port->id);if (rc) - goto err; +return rc; rc =cxl_port_setup_regs (port, component_reg_phys);if (rc) - goto err; - }else +return rc; + }else { rc =dev_set_name (dev,"root%d" , port->id); -if (rc) - goto err; +if (rc) +return rc; + } rc =device_add (dev);if (rc) - goto err; +return rc; + +/* Inhibit the cleanup function invoked */ + dev =NULL ; +return 0 ; +} + +static struct cxl_port *__devm_cxl_add_port (struct device *host, +struct device *uport_dev, +resource_size_t component_reg_phys, +struct cxl_dport *parent_dport) +{ +struct cxl_port *port; +int rc; + + port =cxl_port_alloc (uport_dev, parent_dport); +if (IS_ERR (port)) +return port; + + rc =cxl_port_add (port, component_reg_phys, parent_dport); +if (rc) +return ERR_PTR (rc); rc =devm_add_action_or_reset (host, unregister_port, port);if (rc)
@@ -891,10 +906,6 @@ static struct cxl_port *__devm_cxl_add_port(struct device *host, port->pci_latency =cxl_pci_get_latency (to_pci_dev (uport_dev));return port; - -err: -put_device (dev); -return ERR_PTR (rc); }/**
Signature · 1 line
2.40.1
Quoted 6 lines · On Fri, 30 Aug 2024 01:31:36 +0000 Li Ming <[email protected]> wrote:
Using scope-based resource management
__free()marco with a new helper calledput_cxl_port()to drop open coded theput_device()used to dereference the 'struct device' incxl_port.Suggested-by Dan Williams <[email protected]>Signed-off-by Li Ming <[email protected]>
LGTM