Skip to contentSkip to conversation

gpio: sim: fix an invalid __free() usage

PATCH Superseded Bartosz Golaszewski 4 participants 8 messages Sep 18, 2023 – Sep 25, 2023 GPIO

v4 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

PATCH v4 1/1 gpio: sim: fix an invalid __free() usage

From: Bartosz Golaszewski <[email protected]>

gpio_sim_make_line_names() returns NULL or ERR_PTR() so we must not use __free(kfree) on the returned address. Split this function into two, one that determines the size of the "gpio-line-names" array to allocate and one that actually sets the names at correct offsets. The allocation and assignment of the managed pointer happens in between.

---
Linus,

I followed the pattern for determining the size of the line-names array from your patch in the end but with a changed variable naming. If this is fine, I'll queue it for fixes for the next rc.

Bart

v3 -> v4:
- simplify the line counting logic

v2 -> v3:
- restore the offset out-of-bounds checks

v1 -> v2:
- split the line name setting into two parts

 drivers/gpio/gpio-sim.c | 59 +++++++++++++++--------------------------
 1 file changed, 22 insertions(+), 37 deletions(-)
drivers/gpio/gpio-sim.c +22 -37
index 460389bb8e3f..b66abb55ef4d 100644
@@ -718,52 +718,32 @@ gpio_sim_device_config_live_show(struct config_item *item, char *page)
 	return sprintf(page, "%c\n", live ? '1' : '0');
 }
 
-static char **gpio_sim_make_line_names(struct gpio_sim_bank *bank,
-				       unsigned int *line_names_size)
+static unsigned int gpio_sim_get_line_names_size(struct gpio_sim_bank *bank)
 {
-	unsigned int max_offset = 0;
-	bool has_line_names = false;
 	struct gpio_sim_line *line;
-	char **line_names;
+	unsigned int size = 0;
 
 	list_for_each_entry(line, &bank->line_list, siblings) {
-		if (line->offset >= bank->num_lines)
+		if (!line->name || (line->offset >= bank->num_lines))
 			continue;
 
-		if (line->name) {
-			if (line->offset > max_offset)
-				max_offset = line->offset;
-
-			/*
-			 * max_offset can stay at 0 so it's not an indicator
-			 * of whether line names were configured at all.
-			 */
-			has_line_names = true;
-		}
+		size = line->offset + 1;
 	}
 
-	if (!has_line_names)
-		/*
-		 * This is not an error - NULL means, there are no line
-		 * names configured.
-		 */
-		return NULL;
-
-	*line_names_size = max_offset + 1;
+	return size;
+}
 
-	line_names = kcalloc(*line_names_size, sizeof(*line_names), GFP_KERNEL);
-	if (!line_names)
-		return ERR_PTR(-ENOMEM);
+static void
+gpio_sim_set_line_names(struct gpio_sim_bank *bank, char **line_names)
+{
+	struct gpio_sim_line *line;
 
 	list_for_each_entry(line, &bank->line_list, siblings) {
-		if (line->offset >= bank->num_lines)
+		if (!line->name || (line->offset >= bank->num_lines))
 			continue;
 
-		if (line->name && (line->offset <= max_offset))
-			line_names[line->offset] = line->name;
+		line_names[line->offset] = line->name;
 	}
-
-	return line_names;
 }
 
 static void gpio_sim_remove_hogs(struct gpio_sim_device *dev)
@@ -867,7 +847,7 @@ gpio_sim_make_bank_swnode(struct gpio_sim_bank *bank,
 			  struct fwnode_handle *parent)
 {
 	struct property_entry properties[GPIO_SIM_PROP_MAX];
-	unsigned int prop_idx = 0, line_names_size = 0;
+	unsigned int prop_idx = 0, line_names_size;
 	char **line_names __free(kfree) = NULL;
 
 	memset(properties, 0, sizeof(properties));
@@ -878,14 +858,19 @@ gpio_sim_make_bank_swnode(struct gpio_sim_bank *bank,
 		properties[prop_idx++] = PROPERTY_ENTRY_STRING("gpio-sim,label",
 							       bank->label);
 
-	line_names = gpio_sim_make_line_names(bank, &line_names_size);
-	if (IS_ERR(line_names))
-		return ERR_CAST(line_names);
+	line_names_size = gpio_sim_get_line_names_size(bank);
+	if (line_names_size) {
+		line_names = kcalloc(line_names_size, sizeof(*line_names),
+				     GFP_KERNEL);
+		if (!line_names)
+			return ERR_PTR(-ENOMEM);
+
+		gpio_sim_set_line_names(bank, line_names);
 
-	if (line_names)
 		properties[prop_idx++] = PROPERTY_ENTRY_STRING_ARRAY_LEN(
 						"gpio-line-names",
 						line_names, line_names_size);
+	}
 
 	return fwnode_create_software_node(properties, parent);
 }
Signature · 1 line
2.39.2
#1 lore raw
Quoted 7 lines · Bartosz Golaszewski

From: Bartosz Golaszewski <[email protected]>

gpio_sim_make_line_names() returns NULL or ERR_PTR() so we must not use __free(kfree) on the returned address. Split this function into two, one that determines the size of the "gpio-line-names" array to allocate and one that actually sets the names at correct offsets. The allocation and assignment of the managed pointer happens in between.

...

drivers/gpio/gpio-sim.c gpio_sim_device_config_live_show(struct config_item *item, char *page) · line 733

Quoted 10 lines
drivers/gpio/gpio-sim.c +4 -0
+	unsigned int size = 0;
 
 	list_for_each_entry(line, &bank->line_list, siblings) {
+		if (!line->name || (line->offset >= bank->num_lines))
 			continue;
 
+		size = line->offset + 1;
 	}
 
+	return size;

So, now the function iterates over all lines and returns the size of the last match, correct?

Why not

	list_for_each_entry_reversed() {
		if (line->name && ())
			break;
	}

	return size;

?

...

Quoted 7 lines
drivers/gpio/gpio-sim.c +4 -1
+static void
+gpio_sim_set_line_names(struct gpio_sim_bank *bank, char **line_names)
+{
+	struct gpio_sim_line *line;
 
 	list_for_each_entry(line, &bank->line_list, siblings) {
-		if (line->offset >= bank->num_lines)

drivers/gpio/gpio-sim.c gpio_sim_device_config_live_show(struct config_item *item, char *page) · line 747

Quoted 10 lines
drivers/gpio/gpio-sim.c +2 -4
+		if (!line->name || (line->offset >= bank->num_lines))
 			continue;
 
-		if (line->name && (line->offset <= max_offset))
-			line_names[line->offset] = line->name;
+		line_names[line->offset] = line->name;
 	}
-
-	return line_names;
 }

Can be done in the similar (I see the difference) way for the consistency with above.

...

drivers/gpio/gpio-sim.c gpio_sim_make_bank_swnode(struct gpio_sim_bank *bank,

Quoted 3 lines
drivers/gpio/gpio-sim.c +2 -0
+	line_names_size = gpio_sim_get_line_names_size(bank);
 
+	if (line_names_size) {

Of course this can be replace with...

drivers/gpio/gpio-sim.c gpio_sim_make_bank_swnode(struct gpio_sim_bank *bank,

Quoted 4 lines
drivers/gpio/gpio-sim.c +3 -0
+		line_names = kcalloc(line_names_size, sizeof(*line_names),
+				     GFP_KERNEL);
 
+		if (!line_names)

ZERO_OR_NULL_PTR() check here, but I assume we discourage use of it.

Quoted 9 lines
drivers/gpio/gpio-sim.c +4 -1
+			return ERR_PTR(-ENOMEM);
+
+		gpio_sim_set_line_names(bank, line_names);
 
-	if (line_names)
 		properties[prop_idx++] = PROPERTY_ENTRY_STRING_ARRAY_LEN(
 						"gpio-line-names",
 						line_names, line_names_size);
+	}
Signature · 2 lines
With Best Regards,
Andy Shevchenko
#2 lore raw
Quoted 27 lines · Andy Shevchenko
Quoted 7 lines · Bartosz Golaszewski

From: Bartosz Golaszewski <[email protected]>

gpio_sim_make_line_names() returns NULL or ERR_PTR() so we must not use __free(kfree) on the returned address. Split this function into two, one that determines the size of the "gpio-line-names" array to allocate and one that actually sets the names at correct offsets. The allocation and assignment of the managed pointer happens in between.

...

drivers/gpio/gpio-sim.c gpio_sim_device_config_live_show(struct config_item *item, char *page) · line 733

Quoted 10 lines
drivers/gpio/gpio-sim.c +4 -0
+	unsigned int size = 0;
 
 	list_for_each_entry(line, &bank->line_list, siblings) {
+		if (!line->name || (line->offset >= bank->num_lines))
 			continue;
 
+		size = line->offset + 1;
 	}
 
+	return size;

So, now the function iterates over all lines and returns the size of the last match, correct?

Why not

Quoted 8 lines
	list_for_each_entry_reversed() {
		if (line->name && ())
			break;
	}

	return size;

?

Because the line objects are not sorted by offset. They are added at the end of the list in the order the user creates their corresponding configfs groups.

Quoted 32 lines

...

Quoted 7 lines
drivers/gpio/gpio-sim.c +4 -1
+static void
+gpio_sim_set_line_names(struct gpio_sim_bank *bank, char **line_names)
+{
+	struct gpio_sim_line *line;
 
 	list_for_each_entry(line, &bank->line_list, siblings) {
-		if (line->offset >= bank->num_lines)

drivers/gpio/gpio-sim.c gpio_sim_device_config_live_show(struct config_item *item, char *page) · line 747

Quoted 10 lines
drivers/gpio/gpio-sim.c +2 -4
+		if (!line->name || (line->offset >= bank->num_lines))
 			continue;
 
-		if (line->name && (line->offset <= max_offset))
-			line_names[line->offset] = line->name;
+		line_names[line->offset] = line->name;
 	}
-
-	return line_names;
 }

Can be done in the similar (I see the difference) way for the consistency with above.

...

drivers/gpio/gpio-sim.c gpio_sim_make_bank_swnode(struct gpio_sim_bank *bank,

Quoted 3 lines
drivers/gpio/gpio-sim.c +2 -0
+	line_names_size = gpio_sim_get_line_names_size(bank);
 
+	if (line_names_size) {

Of course this can be replace with...

Quoted 6 lines

drivers/gpio/gpio-sim.c gpio_sim_make_bank_swnode(struct gpio_sim_bank *bank,

Quoted 4 lines
drivers/gpio/gpio-sim.c +3 -0
+		line_names = kcalloc(line_names_size, sizeof(*line_names),
+				     GFP_KERNEL);
 
+		if (!line_names)

ZERO_OR_NULL_PTR() check here, but I assume we discourage use of it.

Why? There are less than 40 instances of using it in the kernel. kmalloc() returns NULL on failure.

Bart

Quoted 17 lines

drivers/gpio/gpio-sim.c gpio_sim_make_bank_swnode(struct gpio_sim_bank *bank, · line 873

Quoted 10 lines
drivers/gpio/gpio-sim.c +4 -1
+			return ERR_PTR(-ENOMEM);
+
+		gpio_sim_set_line_names(bank, line_names);
 
-	if (line_names)
 		properties[prop_idx++] = PROPERTY_ENTRY_STRING_ARRAY_LEN(
 						"gpio-line-names",
 						line_names, line_names_size);
+	}

--
With Best Regards,
Andy Shevchenko

#3 lore raw
Quoted 34 lines · On Tue, Sep 19, 2023 at 12:31:36AM -0700, [email protected] wrote:
Quoted 32 lines · Andy Shevchenko
Quoted 7 lines · Bartosz Golaszewski

From: Bartosz Golaszewski <[email protected]>

gpio_sim_make_line_names() returns NULL or ERR_PTR() so we must not use __free(kfree) on the returned address. Split this function into two, one that determines the size of the "gpio-line-names" array to allocate and one that actually sets the names at correct offsets. The allocation and assignment of the managed pointer happens in between.

...

drivers/gpio/gpio-sim.c gpio_sim_device_config_live_show(struct config_item *item, char *page) · line 733

Quoted 10 lines
drivers/gpio/gpio-sim.c +4 -0
+	unsigned int size = 0;
 
 	list_for_each_entry(line, &bank->line_list, siblings) {
+		if (!line->name || (line->offset >= bank->num_lines))
 			continue;
 
+		size = line->offset + 1;
 	}
 
+	return size;

So, now the function iterates over all lines and returns the size of the last match, correct?

Why not

	list_for_each_entry_reversed() {
		if (line->name && ())
			break;
	}
Quoted 7 lines
Quoted 3 lines
	return size;

?

Because the line objects are not sorted by offset. They are added at the end of the list in the order the user creates their corresponding configfs groups.

Then your patch is also broken as it uses the last named entry, not the named entry with the greatest offset??

Cheers,
Kent.

#4 lore raw
Quoted 43 lines · Kent Gibson
Quoted 34 lines · On Tue, Sep 19, 2023 at 12:31:36AM -0700, [email protected] wrote:
Quoted 32 lines · Andy Shevchenko
Quoted 7 lines · Bartosz Golaszewski

From: Bartosz Golaszewski <[email protected]>

gpio_sim_make_line_names() returns NULL or ERR_PTR() so we must not use __free(kfree) on the returned address. Split this function into two, one that determines the size of the "gpio-line-names" array to allocate and one that actually sets the names at correct offsets. The allocation and assignment of the managed pointer happens in between.

...

drivers/gpio/gpio-sim.c gpio_sim_device_config_live_show(struct config_item *item, char *page) · line 733

Quoted 10 lines
drivers/gpio/gpio-sim.c +4 -0
+	unsigned int size = 0;
 
 	list_for_each_entry(line, &bank->line_list, siblings) {
+		if (!line->name || (line->offset >= bank->num_lines))
 			continue;
 
+		size = line->offset + 1;
 	}
 
+	return size;

So, now the function iterates over all lines and returns the size of the last match, correct?

Why not

	list_for_each_entry_reversed() {
		if (line->name && ())
			break;
	}
Quoted 7 lines
Quoted 3 lines
	return size;

?

Because the line objects are not sorted by offset. They are added at the end of the list in the order the user creates their corresponding configfs groups.

Quoted 6 lines

Then your patch is also broken as it uses the last named entry, not the named entry with the greatest offset??

Cheers,
Kent.

Yes, of course it is. Ironically v3 was at least correct in this part.

Thanks
Bart

#5 lore raw
In reply to [email protected]
Quoted 3 lines · On Tue, Sep 19, 2023 at 12:31:36AM -0700, [email protected] wrote:
Quoted 1 line · Andy Shevchenko

On Mon, Sep 18, 2023 at 04:55:33PM +0200, Bartosz Golaszewski wrote:

...

Quoted 11 lines
Quoted 8 lines

Of course this can be replace with...

drivers/gpio/gpio-sim.c gpio_sim_make_bank_swnode(struct gpio_sim_bank *bank,

Quoted 4 lines
drivers/gpio/gpio-sim.c +3 -0
+		line_names = kcalloc(line_names_size, sizeof(*line_names),
+				     GFP_KERNEL);
 
+		if (!line_names)

ZERO_OR_NULL_PTR() check here, but I assume we discourage use of it.

Why? There are less than 40 instances of using it in the kernel. kmalloc() returns NULL on failure.

Nope, k*alloc*() returns ZERO or NULL on failure. That's what most developers are missing :-)

Quoted 1 line
Quoted 1 line

drivers/gpio/gpio-sim.c gpio_sim_make_bank_swnode(struct gpio_sim_bank *bank, · line 866

Quoted 1 line
drivers/gpio/gpio-sim.c +1 -0
+			return ERR_PTR(-ENOMEM);

Hence either one needs to check for 0 the size given to the kmalloc(), _or_ to check for all possible return values from it.

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#6 lore raw
Quoted 3 lines · Andy Shevchenko

Nope, k*alloc*() returns ZERO or NULL on failure. That's what most developers are missing :-)

Absolutely not.

k*alloc() returns NULL on failure. Absolutely nothing else.

On *success*, it can return the special ZERO_SIZE_PTR. But that is *not* a failure at all. It's very much a successful pointer.

Now, it's a pointer that you can't actually dereference, but that's very much intentional. You can't dereference it, because you asked for a zero-sized allocation. You got a zero-sized allocation.

But please never *ever* think it's a failure. It's very much not a failure case, and it is very much intentional.

It's different from NULL exactly *because* it's successful, and exactly so that you can write

     ptr = kmalloc(size);
     if (!ptr)
          return -ENOMEM;

without having to worry about the "size is zero" case.

The standard user-space "malloc()" library is misdesigned. Surprise surprise. The kernel isn't.

Linus

#7 lore raw
Quoted 8 lines · Linus Torvalds
Quoted 3 lines · Andy Shevchenko

Nope, k*alloc*() returns ZERO or NULL on failure. That's what most developers are missing :-)

Absolutely not.

Quoted 8 lines

k*alloc() returns NULL on failure. Absolutely nothing else.

On *success*, it can return the special ZERO_SIZE_PTR. But that is *not* a failure at all. It's very much a successful pointer.

Now, it's a pointer that you can't actually dereference, but that's very much intentional. You can't dereference it, because you asked for a zero-sized allocation. You got a zero-sized allocation.

"A-ha" moment to me, thank you for elaboration!

Quoted 14 lines

But please never *ever* think it's a failure. It's very much not a failure case, and it is very much intentional.

It's different from NULL exactly *because* it's successful, and exactly so that you can write

     ptr = kmalloc(size);
     if (!ptr)
          return -ENOMEM;

without having to worry about the "size is zero" case.

The standard user-space "malloc()" library is misdesigned. Surprise surprise. The kernel isn't.

Signature · 2 lines
With Best Regards,
Andy Shevchenko