Skip to contentSkip to conversation

iio: buffer: hw-consumer: free scan_mask on buffer release

PATCH Applied Felix Gu 4 participants 7 messages Apr 27 – May 18 IIO

lore
Share & tools
lore

Felix Gu

author
#0 lore raw

PATCH 1/1 iio: buffer: hw-consumer: free scan_mask on buffer release

The scan_mask lifetime changed in commit 9a2e1233d38c ("iio: buffer:
hw-consumer: remove redundant scan_mask flexible array").

Before that change, the scan mask storage was embedded in struct hw_consumer_buffer, so iio_hw_buf_release() could free the whole allocation with a single kfree(hw_buf).

That commit moved the scan mask to a separate bitmap_zalloc() allocation stored in buffer.scan_mask, but left iio_hw_buf_release() unchanged.

Free the scan mask in iio_hw_buf_release() before freeing the buffer wrapper.

Fixes 9a2e1233d38c ("iio: buffer: hw-consumer: remove redundant scan_mask flexible array")
---
 drivers/iio/buffer/industrialio-hw-consumer.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/iio/buffer/industrialio-hw-consumer.c +2 -0
index 24d7df603760..d1ab2cbf8c88 100644
@@ -40,6 +40,8 @@ static void iio_hw_buf_release(struct iio_buffer *buffer)
 {
 	struct hw_consumer_buffer *hw_buf =
 		iio_buffer_to_hw_consumer_buffer(buffer);
+
+	bitmap_free(buffer->scan_mask);
 	kfree(hw_buf);
 }
 

---
base-commit: 7080e32d3f09d8688c4a87d81bdcc71f7f606b16
change-id: 20260427-iio_buf-0459b3fa3de8

Best regards,

Signature · 1 line
Felix Gu <[email protected]>
Reviewed-by on v1 1/1
#1 lore raw
Quoted 7 lines · Felix Gu

The scan_mask lifetime changed in commit 9a2e1233d38c ("iio: buffer:
hw-consumer: remove redundant scan_mask flexible array").

Before that change, the scan mask storage was embedded in struct hw_consumer_buffer, so iio_hw_buf_release() could free the whole allocation with a single kfree(hw_buf).

Quoted 5 lines

That commit moved the scan mask to a separate bitmap_zalloc() allocation stored in buffer.scan_mask, but left iio_hw_buf_release() unchanged.

Free the scan mask in iio_hw_buf_release() before freeing the buffer wrapper.

Good catch!

Seems that struct iio_buffer is a foundation class that is used in several objects and hence each of them is responsible to allocate/free scan_mask (and others, if required). That's why it's easy to forget to clean up that properly. I was thinking of a common ground to have that being done in one place, but it seems unfeasible.

Signature · 2 lines
With Best Regards,
Andy Shevchenko
maintainer
#2 lore raw
In reply to Felix Gu
Quoted 11 lines · On Mon, 27 Apr 2026 19:11:39 +0800 Felix Gu <[email protected]> wrote:

The scan_mask lifetime changed in commit 9a2e1233d38c ("iio: buffer:
hw-consumer: remove redundant scan_mask flexible array").

Before that change, the scan mask storage was embedded in struct hw_consumer_buffer, so iio_hw_buf_release() could free the whole allocation with a single kfree(hw_buf).

That commit moved the scan mask to a separate bitmap_zalloc() allocation

stored in buffer.scan_mask, but left iio_hw_buf_release() unchanged.

Hmm. This reuse of a pointer that is otherwise set via very different paths sent me down a wild goose chase.

Patch seems fine, but I'd like Nuno to take a quick look before I pick it up.

Jonathan

Quoted 29 lines

Free the scan mask in iio_hw_buf_release() before freeing the buffer wrapper.

Fixes 9a2e1233d38c ("iio: buffer: hw-consumer: remove redundant scan_mask flexible array")
---
 drivers/iio/buffer/industrialio-hw-consumer.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/iio/buffer/industrialio-hw-consumer.c +2 -1
index 24d7df603760..d1ab2cbf8c88 100644
@@ -40,6 +40,8 @@ static void iio_hw_buf_release(struct iio_buffer *buffer)
 {
 	struct hw_consumer_buffer *hw_buf =
 		iio_buffer_to_hw_consumer_buffer(buffer);
+
+	bitmap_free(buffer->scan_mask);
 	kfree(hw_buf);
 }
 
 
---

base-commit: 7080e32d3f09d8688c4a87d81bdcc71f7f606b16
change-id: 20260427-iio_buf-0459b3fa3de8

Best regards,

#3 lore raw
Quoted 10 lines · Jonathan Cameron
Quoted 6 lines · On Mon, 27 Apr 2026 19:11:39 +0800 Felix Gu <[email protected]> wrote:

The scan_mask lifetime changed in commit 9a2e1233d38c ("iio: buffer:
hw-consumer: remove redundant scan_mask flexible array").

Before that change, the scan mask storage was embedded in struct hw_consumer_buffer, so iio_hw_buf_release() could free the whole allocation with a single kfree(hw_buf).

Quoted 8 lines
Quoted 3 lines

That commit moved the scan mask to a separate bitmap_zalloc() allocation

stored in buffer.scan_mask, but left iio_hw_buf_release() unchanged.

Hmm. This reuse of a pointer that is otherwise set via very different paths sent me down a wild goose chase.

Patch seems fine, but I'd like Nuno to take a quick look before I pick it up.

Yeah, more eyeballs is better here. I spent like an hour to understand mysterious ways of scan_mask in IIO (we have a few of them and we have a few objects based on struct iio_buffer), and we have constructors/destructors for those objects which of that is responsible to handle scan_mask as appropriate.

May be all of this is documented somewhere?.. Dunno.

Quoted 2 lines
Quoted 2 lines

Free the scan mask in iio_hw_buf_release() before freeing the buffer wrapper.

Signature · 2 lines
With Best Regards,
Andy Shevchenko
maintainer
#4 lore raw
Quoted 18 lines · On Wed, 29 Apr 2026 10:04:48 +0300 Andy Shevchenko…
Quoted 17 lines · Jonathan Cameron
Quoted 10 lines · On Mon, 27 Apr 2026 19:11:39 +0800 Felix Gu <[email protected]> wrote:

The scan_mask lifetime changed in commit 9a2e1233d38c ("iio: buffer:
hw-consumer: remove redundant scan_mask flexible array").

Before that change, the scan mask storage was embedded in struct hw_consumer_buffer, so iio_hw_buf_release() could free the whole allocation with a single kfree(hw_buf).

That commit moved the scan mask to a separate bitmap_zalloc() allocation

stored in buffer.scan_mask, but left iio_hw_buf_release() unchanged.

Hmm. This reuse of a pointer that is otherwise set via very different paths sent me down a wild goose chase.

Quoted 6 lines
Quoted 1 line

Patch seems fine, but I'd like Nuno to take a quick look before I pick it up.

Yeah, more eyeballs is better here. I spent like an hour to understand mysterious ways of scan_mask in IIO (we have a few of them and we have a few objects based on struct iio_buffer), and we have constructors/destructors for those objects which of that is responsible to handle scan_mask as appropriate.

Likewise on time to understand this and I wrote some of them :(

Quoted 2 lines

May be all of this is documented somewhere?.. Dunno.

Have a guess :( Nope. This one is downright odd and only really exists
to leverage some helper functions. With hindsight I think maybe we'd
be better of separating it out so it doesn't use the same structure.

But for now we need a fix.

Quoted 4 lines
Quoted 3 lines
Quoted 3 lines

Free the scan mask in iio_hw_buf_release() before freeing the buffer wrapper.

Reviewed-by on v1 1/1
#5 lore raw
In reply to Felix Gu
Quoted 10 lines · Felix Gu

The scan_mask lifetime changed in commit 9a2e1233d38c ("iio: buffer:
hw-consumer: remove redundant scan_mask flexible array").

Before that change, the scan mask storage was embedded in struct hw_consumer_buffer, so iio_hw_buf_release() could free the whole allocation with a single kfree(hw_buf).

That commit moved the scan mask to a separate bitmap_zalloc() allocation stored in buffer.scan_mask, but left iio_hw_buf_release() unchanged.

Quoted 6 lines

Free the scan mask in iio_hw_buf_release() before freeing the buffer wrapper.

Fixes 9a2e1233d38c ("iio: buffer: hw-consumer: remove redundant scan_mask flexible array")

---

For some reason this one did not get into my mailbox. Anyways, looks good and in line with buffer-cb. Thanks for fixing this:

Quoted 25 lines
 drivers/iio/buffer/industrialio-hw-consumer.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/iio/buffer/industrialio-hw-consumer.c +2 -1
index 24d7df603760..d1ab2cbf8c88 100644
@@ -40,6 +40,8 @@ static void iio_hw_buf_release(struct iio_buffer *buffer)
 {
 	struct hw_consumer_buffer *hw_buf =
 		iio_buffer_to_hw_consumer_buffer(buffer);
+
+	bitmap_free(buffer->scan_mask);
 	kfree(hw_buf);
 }
 
 
---

base-commit: 7080e32d3f09d8688c4a87d81bdcc71f7f606b16
change-id: 20260427-iio_buf-0459b3fa3de8

Best regards,

Signature · 1 line
Felix Gu <[email protected]>
maintainer Applied
#6 lore raw
Quoted 14 lines · On Mon, 18 May 2026 09:26:00 +0100 Nuno Sá <[email protected]> wrote:
Quoted 13 lines · Felix Gu

The scan_mask lifetime changed in commit 9a2e1233d38c ("iio: buffer:
hw-consumer: remove redundant scan_mask flexible array").

Before that change, the scan mask storage was embedded in struct hw_consumer_buffer, so iio_hw_buf_release() could free the whole allocation with a single kfree(hw_buf).

That commit moved the scan mask to a separate bitmap_zalloc() allocation stored in buffer.scan_mask, but left iio_hw_buf_release() unchanged.

Free the scan mask in iio_hw_buf_release() before freeing the buffer wrapper.

Quoted 8 lines
Quoted 3 lines
Fixes 9a2e1233d38c ("iio: buffer: hw-consumer: remove redundant scan_mask flexible array")

---

For some reason this one did not get into my mailbox. Anyways, looks good and in line with buffer-cb. Thanks for fixing this:

Applied to the fixes-togreg branch of iio.git and marked for stable.

Thanks,

Jonathan

Quoted 27 lines
Quoted 26 lines
 drivers/iio/buffer/industrialio-hw-consumer.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/iio/buffer/industrialio-hw-consumer.c +2 -1
index 24d7df603760..d1ab2cbf8c88 100644
@@ -40,6 +40,8 @@ static void iio_hw_buf_release(struct iio_buffer *buffer)
 {
 	struct hw_consumer_buffer *hw_buf =
 		iio_buffer_to_hw_consumer_buffer(buffer);
+
+	bitmap_free(buffer->scan_mask);
 	kfree(hw_buf);
 }
 
 
---

base-commit: 7080e32d3f09d8688c4a87d81bdcc71f7f606b16
change-id: 20260427-iio_buf-0459b3fa3de8

Best regards,

Signature · 1 line
Felix Gu <[email protected]>