netdev - [PATCH v2 01/32] driver core: Constify API device_find

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-Id: <20241203-const_dfc_done-v2-1-7436a98c497f@quicinc.com>
Date: Tue, 03 Dec 2024 08:33:23 +0800
From: Zijun Hu <zijun_hu@...oud.com>
To: Greg Kroah-Hartman <gregkh@...uxfoundation.org>, 
 "Rafael J. Wysocki" <rafael@...nel.org>, 
 Chun-Kuang Hu <chunkuang.hu@...nel.org>, 
 Philipp Zabel <p.zabel@...gutronix.de>, David Airlie <airlied@...il.com>, 
 Simona Vetter <simona@...ll.ch>, Matthias Brugger <matthias.bgg@...il.com>, 
 AngeloGioacchino Del Regno <angelogioacchino.delregno@...labora.com>, 
 Jean Delvare <jdelvare@...e.com>, Guenter Roeck <linux@...ck-us.net>, 
 Martin Tuma <martin.tuma@...iteqautomotive.com>, 
 Mauro Carvalho Chehab <mchehab@...nel.org>, 
 Andreas Noever <andreas.noever@...il.com>, 
 Michael Jamet <michael.jamet@...el.com>, 
 Mika Westerberg <mika.westerberg@...ux.intel.com>, 
 Yehezkel Bernat <YehezkelShB@...il.com>, 
 Linus Walleij <linus.walleij@...aro.org>, 
 Bartosz Golaszewski <brgl@...ev.pl>, Andrew Lunn <andrew@...n.ch>, 
 Vladimir Oltean <olteanv@...il.com>, 
 "David S. Miller" <davem@...emloft.net>, Eric Dumazet <edumazet@...gle.com>, 
 Jakub Kicinski <kuba@...nel.org>, Paolo Abeni <pabeni@...hat.com>, 
 Simon Horman <horms@...nel.org>, 
 Uwe Kleine-König <ukleinek@...nel.org>, 
 Dan Williams <dan.j.williams@...el.com>, 
 Vishal Verma <vishal.l.verma@...el.com>, Dave Jiang <dave.jiang@...el.com>, 
 Ira Weiny <ira.weiny@...el.com>, Takashi Sakamoto <o-takashi@...amocchi.jp>, 
 Jiri Slaby <jirislaby@...nel.org>, 
 Heikki Krogerus <heikki.krogerus@...ux.intel.com>, 
 Srinivas Kandagatla <srinivas.kandagatla@...aro.org>, 
 Lee Duncan <lduncan@...e.com>, Chris Leech <cleech@...hat.com>, 
 Mike Christie <michael.christie@...cle.com>, 
 "James E.J. Bottomley" <James.Bottomley@...senPartnership.com>, 
 "Martin K. Petersen" <martin.petersen@...cle.com>, 
 Nilesh Javali <njavali@...vell.com>, 
 Manish Rangankar <mrangankar@...vell.com>, 
 GR-QLogic-Storage-Upstream@...vell.com, Davidlohr Bueso <dave@...olabs.net>, 
 Jonathan Cameron <jonathan.cameron@...wei.com>, 
 Alison Schofield <alison.schofield@...el.com>, 
 Andreas Larsson <andreas@...sler.com>, Stuart Yoder <stuyoder@...il.com>, 
 Laurentiu Tudor <laurentiu.tudor@....com>, Jens Axboe <axboe@...nel.dk>, 
 Sudeep Holla <sudeep.holla@....com>, 
 Cristian Marussi <cristian.marussi@....com>, 
 Ard Biesheuvel <ardb@...nel.org>, Bjorn Andersson <andersson@...nel.org>, 
 Mathieu Poirier <mathieu.poirier@...aro.org>
Cc: Zijun Hu <zijun_hu@...oud.com>, linux-kernel@...r.kernel.org, 
 dri-devel@...ts.freedesktop.org, linux-mediatek@...ts.infradead.org, 
 linux-arm-kernel@...ts.infradead.org, linux-hwmon@...r.kernel.org, 
 linux-media@...r.kernel.org, linux-usb@...r.kernel.org, 
 linux-gpio@...r.kernel.org, netdev@...r.kernel.org, 
 linux-pwm@...r.kernel.org, nvdimm@...ts.linux.dev, 
 linux1394-devel@...ts.sourceforge.net, linux-serial@...r.kernel.org, 
 linux-sound@...r.kernel.org, open-iscsi@...glegroups.com, 
 linux-scsi@...r.kernel.org, linux-cxl@...r.kernel.org, 
 sparclinux@...r.kernel.org, linux-block@...r.kernel.org, 
 arm-scmi@...r.kernel.org, linux-efi@...r.kernel.org, 
 linux-remoteproc@...r.kernel.org, Zijun Hu <quic_zijuhu@...cinc.com>
Subject: [PATCH v2 01/32] driver core: Constify API device_find_child()

From: Zijun Hu <quic_zijuhu@...cinc.com>

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);
with the following reasons:

- 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 match functions can be directly taken
  as the API's argument, they were exported by driver core.

Now, no (*match)() argument of the API usages is modifying @*data in
current kernel tree, so it is safe to constify the API.

Signed-off-by: Zijun Hu <quic_zijuhu@...cinc.com>
---
 drivers/base/core.c    | 11 +++--------
 include/linux/device.h |  4 ++--
 2 files changed, 5 insertions(+), 10 deletions(-)

diff --git a/drivers/base/core.c b/drivers/base/core.c
index 94865c9d8adcf5f2ce5002ffd7bf0ef4fc85e4d7..a122ea1d84a3b08fce16dd1abdfa7746d31dc430 100644
--- a/drivers/base/core.c
+++ b/drivers/base/core.c
@@ -4079,8 +4079,8 @@ EXPORT_SYMBOL_GPL(device_for_each_child_reverse_from);
  *
  * NOTE: you will need to drop the reference with put_device() after use.
  */
-struct device *device_find_child(struct device *parent, void *data,
-				 int (*match)(struct device *dev, void *data))
+struct device *device_find_child(struct device *parent, const void *data,
+				 device_match_t match)
 {
 	struct klist_iter i;
 	struct device *child;
@@ -4125,11 +4125,6 @@ struct device *device_find_child_by_name(struct device *parent,
 }
 EXPORT_SYMBOL_GPL(device_find_child_by_name);
 
-static int match_any(struct device *dev, void *unused)
-{
-	return 1;
-}
-
 /**
  * device_find_any_child - device iterator for locating a child device, if any.
  * @parent: parent struct device
@@ -4141,7 +4136,7 @@ static int match_any(struct device *dev, void *unused)
  */
 struct device *device_find_any_child(struct device *parent)
 {
-	return device_find_child(parent, NULL, match_any);
+	return device_find_child(parent, NULL, device_match_any);
 }
 EXPORT_SYMBOL_GPL(device_find_any_child);
 
diff --git a/include/linux/device.h b/include/linux/device.h
index 667cb6db9019349c9db0233acf9e78ff6a6d9625..0e0bc9bfe0d15a8734bf3d34106300f4df6b5364 100644
--- a/include/linux/device.h
+++ b/include/linux/device.h
@@ -1081,8 +1081,8 @@ int device_for_each_child_reverse(struct device *dev, void *data,
 int device_for_each_child_reverse_from(struct device *parent,
 				       struct device *from, const void *data,
 				       int (*fn)(struct device *, const void *));
-struct device *device_find_child(struct device *dev, void *data,
-				 int (*match)(struct device *dev, void *data));
+struct device *device_find_child(struct device *dev, const void *data,
+				 device_match_t match);
 struct device *device_find_child_by_name(struct device *parent,
 					 const char *name);
 struct device *device_find_any_child(struct device *parent);

-- 
2.34.1