i2c: core: decrease reference count of device node in i2c_unregister_device

Message ID 1511766415-3732-1-git-send-email-alan.1.wang@nokia-sbell.com
State Accepted
Headers show
Series
  • i2c: core: decrease reference count of device node in i2c_unregister_device
Related show

Commit Message

Wang, Alan 1. (NSB - CN/Hangzhou) Nov. 27, 2017, 7:06 a.m.
Reference count of device node was increased in of_i2c_register_device,
but without decreasing it in i2c_unregister_device. Then the dynamically
added device node will never be released.
Fix this by adding the of_node_put.

Signed-off-by: Lixin Wang <alan.1.wang@nokia-sbell.com>
---
 drivers/i2c/i2c-core-base.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Comments

Wolfram Sang Nov. 27, 2017, 6:21 p.m. | #1
On Mon, Nov 27, 2017 at 03:06:55PM +0800, Lixin Wang wrote:
> Reference count of device node was increased in of_i2c_register_device,
> but without decreasing it in i2c_unregister_device. 

Huh, there is an of_node_put(bus) in of_i2c_register_device?

> Then the dynamically
> added device node will never be released.

Strange. Can you provide your test case, please?
Wang, Alan 1. (NSB - CN/Hangzhou) Nov. 29, 2017, 8:06 a.m. | #2
Hi Wolfram,

In my understand, the of_node_put(bus) is to of_get_child_by_name((adap->dev.of_node, "i2c-bus") or of_node_get(adap->dev.of_node).

What I said is the children of "bus" increased by "info.of_node = of_node_get(node)" in function of_i2c_register_device.

My description in last mail maybe not properly, I think all the nodes accessed by of_i2c_register_device shall not be decreased, not only the dynamically added ones. 

In my case, the SFP devices as i2c clients on one board are connected to the bus through i2c mux.
When plugin the board, all the related nodes are dynamically allocated and added into the device tree.
Then the probe function calls of_i2c_register_devices, in which the reference count increased by " info.of_node = of_node_get(node)".
When plug out the board, because the reference count of those nodes are not decreased down to 0, the memory of the nodes and their properties are not released.
New memory will be allocated but not released in the next plugin and plug out looping test. 

Best Regards,
Lixin Wang

> -----Original Message-----
> From: Wolfram Sang [mailto:wsa@the-dreams.de]
> Sent: Tuesday, November 28, 2017 2:22 AM
> To: Wang, Alan 1. (NSB - CN/Hangzhou) <alan.1.wang@nokia-sbell.com>
> Cc: linux-i2c@vger.kernel.org; linux-kernel@vger.kernel.org
> Subject: Re: [PATCH] i2c: core: decrease reference count of device node in
> i2c_unregister_device
> 
> On Mon, Nov 27, 2017 at 03:06:55PM +0800, Lixin Wang wrote:
> > Reference count of device node was increased in
> > of_i2c_register_device, but without decreasing it in i2c_unregister_device.
> 
> Huh, there is an of_node_put(bus) in of_i2c_register_device?
> 
> > Then the dynamically
> > added device node will never be released.
> 
> Strange. Can you provide your test case, please?
Wolfram Sang Jan. 15, 2018, 11:02 p.m. | #3
On Mon, Nov 27, 2017 at 03:06:55PM +0800, Lixin Wang wrote:
> Reference count of device node was increased in of_i2c_register_device,
> but without decreasing it in i2c_unregister_device. Then the dynamically
> added device node will never be released.
> Fix this by adding the of_node_put.
> 
> Signed-off-by: Lixin Wang <alan.1.wang@nokia-sbell.com>

Yes you are right! In my previous review, I mixed up
of_i2c_register_devices (with plural 's') with of_i2c_register_device
(without plural 's'). I could now verify your findings by rebinding an
adapter which had DT bindings for clients attached. With every rebind
cycle, the refcount for the client increased.

I did some rebasing, because your patch didn't apply to a v4.15
codebase. Now, applied to for-current, thanks!

Patch

diff --git a/drivers/i2c/i2c-core-base.c b/drivers/i2c/i2c-core-base.c
index 56e4658..b76adf9 100644
--- a/drivers/i2c/i2c-core-base.c
+++ b/drivers/i2c/i2c-core-base.c
@@ -808,8 +808,10 @@  EXPORT_SYMBOL_GPL(i2c_new_device);
  */
 void i2c_unregister_device(struct i2c_client *client)
 {
-	if (client->dev.of_node)
+	if (client->dev.of_node) {
 		of_node_clear_flag(client->dev.of_node, OF_POPULATED);
+		of_node_put(client->dev.of_node);
+	}
 	if (ACPI_COMPANION(&client->dev))
 		acpi_device_clear_enumerated(ACPI_COMPANION(&client->dev));
 	device_unregister(&client->dev);