Skip to contentSkip to conversation

serial: core: Fix kmemleak issue for serial core device remove

PATCH In review Tony Lindgren 4 participants 5 messages Aug 4, 2023 TTY layer and serial drivers

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 serial: core: Fix kmemleak issue for serial core device remove

Kmemleak reports issues for serial8250 ports after the hardware specific driver takes over on boot as noted by Tomi.

The kerneldoc for device_initialize() says we must call device_put() after calling device_initialize(). We are calling device_put() on the error path, but are missing it from the device remove path. This causes release() to never get called for the devices on remove.

Let's add the missing put_device() calls for both serial ctrl and port devices.

Fixes 84a9582fd203 ("serial: core: Start managing serial controllers to enable runtime PM")
---
 drivers/tty/serial/serial_base_bus.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/tty/serial/serial_base_bus.c +2 -0
@@ -99,6 +99,7 @@ void serial_base_ctrl_device_remove(struct serial_ctrl_device *ctrl_dev)
 		return;
 
 	device_del(&ctrl_dev->dev);
+	put_device(&ctrl_dev->dev);
 }
 
 struct serial_ctrl_device *serial_base_ctrl_add(struct uart_port *port,
@@ -174,6 +175,7 @@ void serial_base_port_device_remove(struct serial_port_device *port_dev)
 		return;
 
 	device_del(&port_dev->dev);
+	put_device(&port_dev->dev);
 }
 
 static int serial_base_init(void)
Signature · 1 line
2.41.0
maintainer
#1 lore raw
Quoted 30 lines · Tony Lindgren

Kmemleak reports issues for serial8250 ports after the hardware specific driver takes over on boot as noted by Tomi.

The kerneldoc for device_initialize() says we must call device_put() after calling device_initialize(). We are calling device_put() on the error path, but are missing it from the device remove path. This causes release() to never get called for the devices on remove.

Let's add the missing put_device() calls for both serial ctrl and port devices.

Fixes 84a9582fd203 ("serial: core: Start managing serial controllers to enable runtime PM")
---
  drivers/tty/serial/serial_base_bus.c | 2 ++
  1 file changed, 2 insertions(+)
drivers/tty/serial/serial_base_bus.c +1 -0
@@ -99,6 +99,7 @@ void serial_base_ctrl_device_remove(struct serial_ctrl_device *ctrl_dev)
  		return;
 
  	device_del(&ctrl_dev->dev);
+	put_device(&ctrl_dev->dev);
  }
 
  struct serial_ctrl_device *serial_base_ctrl_add(struct uart_port *port,

drivers/tty/serial/serial_base_bus.c void serial_base_port_device_remove(struct serial_port_device *port_dev) · line 178

Quoted 4 lines
drivers/tty/serial/serial_base_bus.c +1 -0
@@ -174,6 +175,7 @@ void serial_base_port_device_remove(struct serial_port_device *port_dev)
  		return;
 
  	device_del(&port_dev->dev);
+	put_device(&port_dev->dev);

I didn't check the code, but device_unregister()?

Signature · 2 lines
js
suse labs
#2 lore raw
Quoted 19 lines · Jiri Slaby
Quoted 18 lines · Tony Lindgren

Kmemleak reports issues for serial8250 ports after the hardware specific driver takes over on boot as noted by Tomi.

The kerneldoc for device_initialize() says we must call device_put() after calling device_initialize(). We are calling device_put() on the error path, but are missing it from the device remove path. This causes release() to never get called for the devices on remove.

Let's add the missing put_device() calls for both serial ctrl and port devices.

Fixes 84a9582fd203 ("serial: core: Start managing serial controllers to enable runtime PM")
---
  drivers/tty/serial/serial_base_bus.c | 2 ++
  1 file changed, 2 insertions(+)
Quoted 15 lines

drivers/tty/serial/serial_base_bus.c void serial_base_port_device_remove(struct serial_port_device *port_dev) · line 177

Quoted 13 lines
drivers/tty/serial/serial_base_bus.c +2 -0
@@ -99,6 +99,7 @@ void serial_base_ctrl_device_remove(struct serial_ctrl_device *ctrl_dev)
  		return;
  	device_del(&ctrl_dev->dev);
+	put_device(&ctrl_dev->dev);
  }
  struct serial_ctrl_device *serial_base_ctrl_add(struct uart_port *port,
@@ -174,6 +175,7 @@ void serial_base_port_device_remove(struct serial_port_device *port_dev)
  		return;
  	device_del(&port_dev->dev);
+	put_device(&port_dev->dev);

I didn't check the code, but device_unregister()?

I thought about that as it does the same, but since we're not calling device_register() I felt it would be and unpaired call. No objections to changing to use device_unregister() naturally if folks prefer that.

Regards,

Tony

#3 lore raw
Quoted 36 lines · Tony Lindgren
Quoted 19 lines · Jiri Slaby
Quoted 18 lines · Tony Lindgren

Kmemleak reports issues for serial8250 ports after the hardware specific driver takes over on boot as noted by Tomi.

The kerneldoc for device_initialize() says we must call device_put() after calling device_initialize(). We are calling device_put() on the error path, but are missing it from the device remove path. This causes release() to never get called for the devices on remove.

Let's add the missing put_device() calls for both serial ctrl and port devices.

Fixes 84a9582fd203 ("serial: core: Start managing serial controllers to enable runtime PM")
---
  drivers/tty/serial/serial_base_bus.c | 2 ++
  1 file changed, 2 insertions(+)
Quoted 15 lines

drivers/tty/serial/serial_base_bus.c void serial_base_port_device_remove(struct serial_port_device *port_dev) · line 177

Quoted 13 lines
drivers/tty/serial/serial_base_bus.c +2 -0
@@ -99,6 +99,7 @@ void serial_base_ctrl_device_remove(struct serial_ctrl_device *ctrl_dev)
  		return;
  	device_del(&ctrl_dev->dev);
+	put_device(&ctrl_dev->dev);
  }
  struct serial_ctrl_device *serial_base_ctrl_add(struct uart_port *port,
@@ -174,6 +175,7 @@ void serial_base_port_device_remove(struct serial_port_device *port_dev)
  		return;
  	device_del(&port_dev->dev);
+	put_device(&port_dev->dev);

I didn't check the code, but device_unregister()?

Quoted 3 lines

I thought about that as it does the same, but since we're not calling device_register() I felt it would be and unpaired call. No objections to changing to use device_unregister() naturally if folks prefer that.

This is fine as device_register() isn't happening, thanks.

greg k-h

Tested-by on v1 1/1
#4 lore raw
In reply to Tony Lindgren
Quoted 30 lines · Tony Lindgren

Kmemleak reports issues for serial8250 ports after the hardware specific driver takes over on boot as noted by Tomi.

The kerneldoc for device_initialize() says we must call device_put() after calling device_initialize(). We are calling device_put() on the error path, but are missing it from the device remove path. This causes release() to never get called for the devices on remove.

Let's add the missing put_device() calls for both serial ctrl and port devices.

Fixes 84a9582fd203 ("serial: core: Start managing serial controllers to enable runtime PM")
---
  drivers/tty/serial/serial_base_bus.c | 2 ++
  1 file changed, 2 insertions(+)
drivers/tty/serial/serial_base_bus.c +1 -0
@@ -99,6 +99,7 @@ void serial_base_ctrl_device_remove(struct serial_ctrl_device *ctrl_dev)
  		return;
 
  	device_del(&ctrl_dev->dev);
+	put_device(&ctrl_dev->dev);
  }
 
  struct serial_ctrl_device *serial_base_ctrl_add(struct uart_port *port,

drivers/tty/serial/serial_base_bus.c void serial_base_port_device_remove(struct serial_port_device *port_dev) · line 181

Quoted 7 lines
drivers/tty/serial/serial_base_bus.c +1 -0
@@ -174,6 +175,7 @@ void serial_base_port_device_remove(struct serial_port_device *port_dev)
  		return;
 
  	device_del(&port_dev->dev);
+	put_device(&port_dev->dev);
  }
 
  static int serial_base_init(void)

Tomi