Skip to contentSkip to conversation

can: mcba_usb: Fix memory leak when cancelling urb

PATCH Superseded Bui Quang Minh 2 participants 5 messages Jan 11, 2021 – Jan 21, 2021

Subsystems (3)

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 can: mcba_usb: Fix memory leak when cancelling urb

In mcba_usb_read_bulk_callback(), when we don't resubmit or fails to resubmit the urb, we need to deallocate the transfer buffer that is allocated in mcba_usb_start().

---
v1: add memory leak fix when not resubmitting urb
v2: add memory leak fix when failing to resubmit urb

 drivers/net/can/usb/mcba_usb.c | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)
drivers/net/can/usb/mcba_usb.c +8 -3
index df54eb7d4b36..30236e640116 100644
@@ -584,6 +584,8 @@ static void mcba_usb_read_bulk_callback(struct urb *urb)
 	case -EPIPE:
 	case -EPROTO:
 	case -ESHUTDOWN:
+		usb_free_coherent(urb->dev, urb->transfer_buffer_length,
+				  urb->transfer_buffer, urb->transfer_dma);
 		return;
 
 	default:
@@ -615,11 +617,14 @@ static void mcba_usb_read_bulk_callback(struct urb *urb)
 
 	retval = usb_submit_urb(urb, GFP_ATOMIC);
 
-	if (retval == -ENODEV)
-		netif_device_detach(netdev);
-	else if (retval)
+	if (retval < 0) {
 		netdev_err(netdev, "failed resubmitting read bulk urb: %d\n",
 			   retval);
+		usb_free_coherent(urb->dev, urb->transfer_buffer_length,
+				  urb->transfer_buffer, urb->transfer_dma);
+		if (retval == -ENODEV)
+			netif_device_detach(netdev);
+	}
 }
 
 /* Start USB device */
Signature · 1 line
2.17.1
#1 lore raw

Am Montag, den 11.01.2021, 10:49 +0000 schrieb Bui Quang Minh:

Quoted 18 lines

In mcba_usb_read_bulk_callback(), when we don't resubmit or fails to resubmit the urb, we need to deallocate the transfer buffer that is allocated in mcba_usb_start().

---
v1: add memory leak fix when not resubmitting urb
v2: add memory leak fix when failing to resubmit urb

 drivers/net/can/usb/mcba_usb.c | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)
drivers/net/can/usb/mcba_usb.c +0 -0
index df54eb7d4b36..30236e640116 100644

drivers/net/can/usb/mcba_usb.c static void mcba_usb_read_bulk_callback(struct urb *urb) · line 590

Quoted 7 lines
drivers/net/can/usb/mcba_usb.c +2 -0
@@ -584,6 +584,8 @@ static void mcba_usb_read_bulk_callback(struct urb *urb)
 	case -EPIPE:
 	case -EPROTO:
 	case -ESHUTDOWN:
+		usb_free_coherent(urb->dev, urb->transfer_buffer_length,
+				  urb->transfer_buffer, urb->transfer_dma);
 		return;
 

Can you call usb_free_coherent() in what can be hard IRQ context?

Regards
Oliver

#2 lore raw
Quoted 14 lines · Oliver Neukum

Am Montag, den 11.01.2021, 10:49 +0000 schrieb Bui Quang Minh:

Quoted 13 lines

In mcba_usb_read_bulk_callback(), when we don't resubmit or fails to resubmit the urb, we need to deallocate the transfer buffer that is allocated in mcba_usb_start().

---
v1: add memory leak fix when not resubmitting urb
v2: add memory leak fix when failing to resubmit urb

 drivers/net/can/usb/mcba_usb.c | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)
Quoted 14 lines

drivers/net/can/usb/mcba_usb.c static void mcba_usb_read_bulk_callback(struct urb *urb) · line 590

Quoted 12 lines
drivers/net/can/usb/mcba_usb.c +2 -0
index df54eb7d4b36..30236e640116 100644
@@ -584,6 +584,8 @@ static void mcba_usb_read_bulk_callback(struct urb *urb)
 	case -EPIPE:
 	case -EPROTO:
 	case -ESHUTDOWN:
+		usb_free_coherent(urb->dev, urb->transfer_buffer_length,
+				  urb->transfer_buffer, urb->transfer_dma);
 		return;
 

Can you call usb_free_coherent() in what can be hard IRQ context?

You are right, I digged in the code and saw some comments that on some architectures, usb_free_coherent() cannot be called in hard IRQ context. I see the usb_free_coherent() is called in write_bulk_callback too. I will send a patch that uses usb_anchor to keep track of these urbs and cleanup the transfer buffer later in disconnect().

Thank you for your review,
Quang Minh.

#3 lore raw
Quoted 31 lines · Bui Quang Minh
Quoted 14 lines · Oliver Neukum

Am Montag, den 11.01.2021, 10:49 +0000 schrieb Bui Quang Minh:

Quoted 13 lines

In mcba_usb_read_bulk_callback(), when we don't resubmit or fails to resubmit the urb, we need to deallocate the transfer buffer that is allocated in mcba_usb_start().

---
v1: add memory leak fix when not resubmitting urb
v2: add memory leak fix when failing to resubmit urb

 drivers/net/can/usb/mcba_usb.c | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)
Quoted 14 lines

drivers/net/can/usb/mcba_usb.c static void mcba_usb_read_bulk_callback(struct urb *urb) · line 590

Quoted 12 lines
drivers/net/can/usb/mcba_usb.c +2 -0
index df54eb7d4b36..30236e640116 100644
@@ -584,6 +584,8 @@ static void mcba_usb_read_bulk_callback(struct urb *urb)
    case -EPIPE:
    case -EPROTO:
    case -ESHUTDOWN:
+           usb_free_coherent(urb->dev, urb->transfer_buffer_length,
+                             urb->transfer_buffer, urb->transfer_dma);
            return;
 

Can you call usb_free_coherent() in what can be hard IRQ context?

Quoted 5 lines

You are right, I digged in the code and saw some comments that on some architectures, usb_free_coherent() cannot be called in hard IRQ context. I see the usb_free_coherent() is called in write_bulk_callback too. I will send a patch that uses usb_anchor to keep track of these urbs and cleanup the transfer buffer later in disconnect().

Hi, I have sent a version 3 patch. However, I found out that usb_free_coherent() is ok in this situation. In usb_free_coherent(), if the buffer is allocated via dma_alloc_coherent() in usb_alloc_coherent(), dma_free_coherent() is called. In dma_free_coherent(), ops->free() may be called in some cases which may contains calls to vunmap() that is not permitted in interrupt context. However, in usb_alloc_coherent(), buffer can be allocated from dma pool if the size is less
than 2048 and the buffer size in mcba_usb is obviously less than 2048. As a result,
usb_free_coherent() will at most fall in the path that calls dma_pool_free(), which is
safe. Am I right?

Thanks,
Quang Minh.

#4 lore raw
Quoted 38 lines · Minh Bùi Quang
Quoted 31 lines · Bui Quang Minh
Quoted 14 lines · Oliver Neukum

Am Montag, den 11.01.2021, 10:49 +0000 schrieb Bui Quang Minh:

Quoted 13 lines

In mcba_usb_read_bulk_callback(), when we don't resubmit or fails to resubmit the urb, we need to deallocate the transfer buffer that is allocated in mcba_usb_start().

---
v1: add memory leak fix when not resubmitting urb
v2: add memory leak fix when failing to resubmit urb

 drivers/net/can/usb/mcba_usb.c | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)
Quoted 14 lines

drivers/net/can/usb/mcba_usb.c static void mcba_usb_read_bulk_callback(struct urb *urb) · line 590

Quoted 12 lines
drivers/net/can/usb/mcba_usb.c +2 -0
index df54eb7d4b36..30236e640116 100644
@@ -584,6 +584,8 @@ static void mcba_usb_read_bulk_callback(struct urb *urb)
    case -EPIPE:
    case -EPROTO:
    case -ESHUTDOWN:
+           usb_free_coherent(urb->dev, urb->transfer_buffer_length,
+                             urb->transfer_buffer, urb->transfer_dma);
            return;
 

Can you call usb_free_coherent() in what can be hard IRQ context?

Quoted 5 lines

You are right, I digged in the code and saw some comments that on some architectures, usb_free_coherent() cannot be called in hard IRQ context. I see the usb_free_coherent() is called in write_bulk_callback too. I will send a patch that uses usb_anchor to keep track of these urbs and cleanup the transfer buffer later in disconnect().

Quoted 12 lines

Hi, I have sent a version 3 patch. However, I found out that usb_free_coherent() is ok in this situation. In usb_free_coherent(), if the buffer is allocated via dma_alloc_coherent() in usb_alloc_coherent(), dma_free_coherent() is called. In dma_free_coherent(), ops->free() may be called in some cases which may contains calls to vunmap() that is not permitted in interrupt context. However, in usb_alloc_coherent(), buffer can be allocated from dma pool if the size is less
than 2048 and the buffer size in mcba_usb is obviously less than 2048. As a result,
usb_free_coherent() will at most fall in the path that calls dma_pool_free(), which is
safe. Am I right?

Hi, I'm CC'ing CAN network driver maintainers so we can discuss the patch properly.

I'm so sorry for spamming emails.

Thanks,
Quang Minh.