| Message ID | 20241205-const_dfc_done-v3-0-1611f1486b5a@quicinc.com |
|---|---|
| Headers | show |
| Series | driver core: Constify API device_find_child() | expand |
On 2024/12/5 08:10, Zijun Hu wrote: > This patch series is to constify the following API: This patch series is based on the lasted mainline commit Commit: feffde684ac2 ("Merge tag 'for-6.13-rc1-tag' of git://git.kernel.org/pub/scm/linux/kernel/git/kdave/linux") to avoid potential conflict as much as possible. > struct device *device_find_child(struct device *dev, void *data, > int (*match)(struct device *dev, void *data)); > To : > struct device *device_find_child(struct device *dev, const void *data, > device_match_t match); > typedef int (*device_match_t)(struct device *dev, const void *data); > > Why to constify the API? > > - Protect caller's match data @*data which is for comparison and lookup > and the API does not actually need to modify @*data. > > - Make the API's parameters (@match)() and @data have the same type as > all of other device finding APIs (bus|class|driver)_find_device(). > > - All kinds of existing device matching functions can be directly taken > as the API's argument, they were exported by driver core. > > What to do? > > - Patches [1/11, 3/11] prepare for constifying the API. > > - Patch 4/11 constifies the API and adapt for its various subsystem usages. > > - Remaining do cleanup for several usages with benefits brought above.
On Thu, Dec 05, 2024 at 08:10:10AM +0800, Zijun Hu wrote: > From: Zijun Hu <quic_zijuhu@quicinc.com> Hi Zihun, Similar to my comment on Patch 10/11, this commit msg can be explicit: libnvdimm: Replace namespace_match() w device_find_child_by_name() > > Simplify nd_namespace_store() implementation by device_find_child_by_name() ^using Otherwise you can add: Reviewed-by: Alison Schofield <alison.schofield@intel.com> > > Signed-off-by: Zijun Hu <quic_zijuhu@quicinc.com> > --- > drivers/nvdimm/claim.c | 9 +-------- > 1 file changed, 1 insertion(+), 8 deletions(-) > > diff --git a/drivers/nvdimm/claim.c b/drivers/nvdimm/claim.c > index 030dbde6b0882050c90fb8db106ec15b1baef7ca..9e84ab411564f9d5e7ceb687c6491562564552e3 100644 > --- a/drivers/nvdimm/claim.c > +++ b/drivers/nvdimm/claim.c > @@ -67,13 +67,6 @@ bool nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach, > return claimed; > } > > -static int namespace_match(struct device *dev, void *data) > -{ > - char *name = data; > - > - return strcmp(name, dev_name(dev)) == 0; > -} > - > static bool is_idle(struct device *dev, struct nd_namespace_common *ndns) > { > struct nd_region *nd_region = to_nd_region(dev->parent); > @@ -168,7 +161,7 @@ ssize_t nd_namespace_store(struct device *dev, > goto out; > } > > - found = device_find_child(dev->parent, name, namespace_match); > + found = device_find_child_by_name(dev->parent, name); > if (!found) { > dev_dbg(dev, "'%s' not found under %s\n", name, > dev_name(dev->parent)); > > -- > 2.34.1 > >
On 2024/12/6 07:30, Alison Schofield wrote: > On Thu, Dec 05, 2024 at 08:10:10AM +0800, Zijun Hu wrote: >> From: Zijun Hu <quic_zijuhu@quicinc.com> > > Hi Zihun, > > Similar to my comment on Patch 10/11, this commit msg can be > explicit: > > libnvdimm: Replace namespace_match() w device_find_child_by_name() > >> >> Simplify nd_namespace_store() implementation by device_find_child_by_name() > ^using > thank you Alison for code review. will send v4 with your suggestions. (^^) > Otherwise you can add: > Reviewed-by: Alison Schofield <alison.schofield@intel.com> > >> >> Signed-off-by: Zijun Hu <quic_zijuhu@quicinc.com> >> --- >> drivers/nvdimm/claim.c | 9 +-------- >> 1 file changed, 1 insertion(+), 8 deletions(-) >> >> diff --git a/drivers/nvdimm/claim.c b/drivers/nvdimm/claim.c >> index 030dbde6b0882050c90fb8db106ec15b1baef7ca..9e84ab411564f9d5e7ceb687c6491562564552e3 100644 >> --- a/drivers/nvdimm/claim.c >> +++ b/drivers/nvdimm/claim.c >> @@ -67,13 +67,6 @@ bool nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach, >> return claimed; >> } >> >> -static int namespace_match(struct device *dev, void *data) >> -{ >> - char *name = data; >> - >> - return strcmp(name, dev_name(dev)) == 0; >> -} >> - >> static bool is_idle(struct device *dev, struct nd_namespace_common *ndns) >> { >> struct nd_region *nd_region = to_nd_region(dev->parent); >> @@ -168,7 +161,7 @@ ssize_t nd_namespace_store(struct device *dev, >> goto out; >> } >> >> - found = device_find_child(dev->parent, name, namespace_match); >> + found = device_find_child_by_name(dev->parent, name); >> if (!found) { >> dev_dbg(dev, "'%s' not found under %s\n", name, >> dev_name(dev->parent)); >> >> -- >> 2.34.1 >> >>
This patch series is to constify the following API: struct device *device_find_child(struct device *dev, void *data, int (*match)(struct device *dev, void *data)); To : struct device *device_find_child(struct device *dev, const void *data, device_match_t match); typedef int (*device_match_t)(struct device *dev, const void *data); Why to constify the API? - Protect caller's match data @*data which is for comparison and lookup and the API does not actually need to modify @*data. - Make the API's parameters (@match)() and @data have the same type as all of other device finding APIs (bus|class|driver)_find_device(). - All kinds of existing device matching functions can be directly taken as the API's argument, they were exported by driver core. What to do? - Patches [1/11, 3/11] prepare for constifying the API. - Patch 4/11 constifies the API and adapt for its various subsystem usages. - Remaining do cleanup for several usages with benefits brought above. --- Changes in v3: - Solve build broken issue by squashing changes of various subsystem. - Reduce recipients to try to send out full patch serial. - Correct tiles and commit messages. - Link to v2: https://lore.kernel.org/all/20241203-const_dfc_done-v2-0-7436a98c497f@quicinc.com Changes in v2: - Series v1 have no code review comments and are posted a long time ago, so may ignore differences. - Link to v1: https://lore.kernel.org/r/20240811-const_dfc_done-v1-0-9d85e3f943cb@quicinc.com - Motivation link: https://lore.kernel.org/lkml/917359cc-a421-41dd-93f4-d28937fe2325@icloud.com --- Zijun Hu (11): libnvdimm: Simplify nd_namespace_store() implementation slimbus: core: Constify slim_eaddr_equal() bus: fsl-mc: Constify fsl_mc_device_match() driver core: Constify API device_find_child() then adapt for various usages driver core: Simplify API device_find_child_by_name() implementation driver core: Remove match_any() slimbus: core: Simplify of_find_slim_device() implementation gpio: sim: Remove gpio_sim_dev_match_fwnode() driver core: Introduce an device matching API device_match_type() cxl/pmem: Remove match_nvdimm_bridge() usb: typec: class: Remove both cable_match() and partner_match() arch/sparc/kernel/vio.c | 6 +++--- drivers/base/core.c | 30 ++++++++++-------------------- drivers/block/sunvdc.c | 6 +++--- drivers/bus/fsl-mc/dprc-driver.c | 8 ++++---- drivers/cxl/core/pci.c | 4 ++-- drivers/cxl/core/pmem.c | 9 +++------ drivers/cxl/core/region.c | 21 ++++++++++++--------- drivers/firewire/core-device.c | 4 ++-- drivers/firmware/arm_scmi/bus.c | 4 ++-- drivers/firmware/efi/dev-path-parser.c | 4 ++-- drivers/gpio/gpio-sim.c | 7 +------ drivers/gpu/drm/mediatek/mtk_drm_drv.c | 2 +- drivers/hwmon/hwmon.c | 2 +- drivers/media/pci/mgb4/mgb4_core.c | 4 ++-- drivers/nvdimm/bus.c | 2 +- drivers/nvdimm/claim.c | 9 +-------- drivers/pwm/core.c | 2 +- drivers/rpmsg/rpmsg_core.c | 4 ++-- drivers/scsi/qla4xxx/ql4_os.c | 3 ++- drivers/scsi/scsi_transport_iscsi.c | 10 +++++----- drivers/slimbus/core.c | 17 +++++------------ drivers/thunderbolt/retimer.c | 2 +- drivers/thunderbolt/xdomain.c | 2 +- drivers/tty/serial/serial_core.c | 4 ++-- drivers/usb/typec/class.c | 31 ++++++++++++++----------------- include/linux/device.h | 4 ++-- include/linux/device/bus.h | 1 + include/scsi/scsi_transport_iscsi.h | 4 ++-- net/dsa/dsa.c | 2 +- tools/testing/cxl/test/cxl.c | 2 +- 30 files changed, 90 insertions(+), 120 deletions(-) --- base-commit: feffde684ac29a3b7aec82d2df850fbdbdee55e4 change-id: 20241201-const_dfc_done-aaec71e3bbea Best regards,