Skip to contentSkip to conversation

Documentation: power: Use kcalloc() instead of kzalloc()

PATCH Applied Erick Archer 4 participants 4 messages Jan 21, 2024 – Jan 23, 2024

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 Documentation: power: Use kcalloc() instead of kzalloc()

As noted in the "Deprecated Interfaces, Language Features, Attributes, and Conventions" documentation [1], size calculations (especially multiplication) should not be performed in memory allocator (or similar) function arguments due to the risk of them overflowing. This could lead to values wrapping around and a smaller allocation being made than the caller was expecting. Using those allocations could lead to linear overflows of heap memory and other misbehaviors.

So, in the example code use the purpose specific kcalloc() function instead of the argument size * count in the kzalloc() function.

At the same time, modify the translations accordingly.

---
Hi,

This patch is a merger of two previous ones [1] [2].
As Hu Haowen and Jonathan Corbet suggested, the translation change only makes sense if the original file is modified. So, with this v2 version the original file and the translations are modified at the same time.

[1] https://lore.kernel.org/linux-hardening/[email protected]/
[2] https://lore.kernel.org/linux-hardening/[email protected]/

Thanks,
Erick

---
 Documentation/power/opp.rst                    | 2 +-
 Documentation/translations/zh_CN/power/opp.rst | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
Documentation/power/opp.rst +1 -1
index a7c03c470980..1b7f1d854f14 100644
@@ -305,7 +305,7 @@ dev_pm_opp_get_opp_count
 	 {
 		/* Do things */
 		num_available = dev_pm_opp_get_opp_count(dev);
-		speeds = kzalloc(sizeof(u32) * num_available, GFP_KERNEL);
+		speeds = kcalloc(num_available, sizeof(u32), GFP_KERNEL);
 		/* populate the table in increasing order */
 		freq = 0;
 		while (!IS_ERR(opp = dev_pm_opp_find_freq_ceil(dev, &freq))) {
Documentation/translations/zh_CN/power/opp.rst +1 -1
index 8d6e3f6f6202..7470fa2d4c43 100644
@@ -274,7 +274,7 @@ dev_pm_opp_get_opp_count
 	 {
 		/* 做一些事情 */
 		num_available = dev_pm_opp_get_opp_count(dev);
-		speeds = kzalloc(sizeof(u32) * num_available, GFP_KERNEL);
+		speeds = kcalloc(num_available, sizeof(u32), GFP_KERNEL);
 		/* 按升序填充表 */
 		freq = 0;
 		while (!IS_ERR(opp = dev_pm_opp_find_freq_ceil(dev, &freq))) {

--
2.25.1

Reviewed-by on v2 1/1
#1 lore raw
Quoted 53 lines · Erick Archer

As noted in the "Deprecated Interfaces, Language Features, Attributes, and Conventions" documentation [1], size calculations (especially multiplication) should not be performed in memory allocator (or similar) function arguments due to the risk of them overflowing. This could lead to values wrapping around and a smaller allocation being made than the caller was expecting. Using those allocations could lead to linear overflows of heap memory and other misbehaviors.

So, in the example code use the purpose specific kcalloc() function instead of the argument size * count in the kzalloc() function.

At the same time, modify the translations accordingly.

---
Hi,

This patch is a merger of two previous ones [1] [2].
As Hu Haowen and Jonathan Corbet suggested, the translation change only makes sense if the original file is modified. So, with this v2 version the original file and the translations are modified at the same time.

[1] https://lore.kernel.org/linux-hardening/[email protected]/
[2] https://lore.kernel.org/linux-hardening/[email protected]/

Thanks,
Erick

---
  Documentation/power/opp.rst                    | 2 +-
  Documentation/translations/zh_CN/power/opp.rst | 2 +-
  2 files changed, 2 insertions(+), 2 deletions(-)
Documentation/power/opp.rst +1 -1
index a7c03c470980..1b7f1d854f14 100644
@@ -305,7 +305,7 @@ dev_pm_opp_get_opp_count
  	 {
  		/* Do things */
  		num_available = dev_pm_opp_get_opp_count(dev);
-		speeds = kzalloc(sizeof(u32) * num_available, GFP_KERNEL);
+		speeds = kcalloc(num_available, sizeof(u32), GFP_KERNEL);
  		/* populate the table in increasing order */
  		freq = 0;
  		while (!IS_ERR(opp = dev_pm_opp_find_freq_ceil(dev, &freq))) {
Documentation/translations/zh_CN/power/opp.rst +0 -0
index 8d6e3f6f6202..7470fa2d4c43 100644

Documentation/translations/zh_CN/power/opp.rst dev_pm_opp_get_opp_count · line 277

Quoted 5 lines
Documentation/translations/zh_CN/power/opp.rst +1 -1
@@ -274,7 +274,7 @@ dev_pm_opp_get_opp_count
  	 {
  		/* 做一些事情 */
  		num_available = dev_pm_opp_get_opp_count(dev);
-		speeds = kzalloc(sizeof(u32) * num_available, GFP_KERNEL);
+		speeds = kcalloc(num_available, sizeof(u32), GFP_KERNEL);

For the zh_CN translation,

Thanks,

Hu Haowen

Quoted 8 lines
Documentation/translations/zh_CN/power/opp.rst +0 -1
  		/* 按升序填充表 */
  		freq = 0;
  		while (!IS_ERR(opp = dev_pm_opp_find_freq_ceil(dev, &freq))) {
--

2.25.1

Reviewed-by
#2 lore raw
Quoted 64 lines · Hu Haowen
Quoted 53 lines · Erick Archer

As noted in the "Deprecated Interfaces, Language Features, Attributes, and Conventions" documentation [1], size calculations (especially multiplication) should not be performed in memory allocator (or similar) function arguments due to the risk of them overflowing. This could lead to values wrapping around and a smaller allocation being made than the caller was expecting. Using those allocations could lead to linear overflows of heap memory and other misbehaviors.

So, in the example code use the purpose specific kcalloc() function instead of the argument size * count in the kzalloc() function.

At the same time, modify the translations accordingly.

---
Hi,

This patch is a merger of two previous ones [1] [2].
As Hu Haowen and Jonathan Corbet suggested, the translation change only makes sense if the original file is modified. So, with this v2 version the original file and the translations are modified at the same time.

[1] https://lore.kernel.org/linux-hardening/[email protected]/
[2] https://lore.kernel.org/linux-hardening/[email protected]/

Thanks,
Erick
---
  Documentation/power/opp.rst                    | 2 +- Documentation/translations/zh_CN/power/opp.rst | 2 +-

  2 files changed, 2 insertions(+), 2 deletions(-)
Documentation/power/opp.rst +1 -1
index a7c03c470980..1b7f1d854f14 100644
@@ -305,7 +305,7 @@ dev_pm_opp_get_opp_count
        {
           /* Do things */
           num_available = dev_pm_opp_get_opp_count(dev);
-        speeds = kzalloc(sizeof(u32) * num_available, GFP_KERNEL);
+        speeds = kcalloc(num_available, sizeof(u32), GFP_KERNEL);
           /* populate the table in increasing order */
           freq = 0;
           while (!IS_ERR(opp = dev_pm_opp_find_freq_ceil(dev, &freq))) {
Documentation/translations/zh_CN/power/opp.rst +0 -0
index 8d6e3f6f6202..7470fa2d4c43 100644

Documentation/translations/zh_CN/power/opp.rst dev_pm_opp_get_opp_count · line 277

Quoted 5 lines
Documentation/translations/zh_CN/power/opp.rst +1 -1
@@ -274,7 +274,7 @@ dev_pm_opp_get_opp_count
        {
           /* 做一些事情 */
           num_available = dev_pm_opp_get_opp_count(dev);
-        speeds = kzalloc(sizeof(u32) * num_available, GFP_KERNEL);
+        speeds = kcalloc(num_available, sizeof(u32), GFP_KERNEL);

For the zh_CN translation,

Quoted 1 line

Same here,

Thanks,

Yanteng

Quoted 15 lines

Thanks,

Hu Haowen

Quoted 8 lines
Documentation/translations/zh_CN/power/opp.rst +0 -0
           /* 按升序填充表 */
           freq = 0;
           while (!IS_ERR(opp = dev_pm_opp_find_freq_ceil(dev, &freq))) {
Signature · 1 line
2.25.1
Applied
#3 lore raw
In reply to Erick Archer
Quoted 8 lines · Erick Archer

As noted in the "Deprecated Interfaces, Language Features, Attributes, and Conventions" documentation [1], size calculations (especially multiplication) should not be performed in memory allocator (or similar) function arguments due to the risk of them overflowing. This could lead to values wrapping around and a smaller allocation being made than the caller was expecting. Using those allocations could lead to linear overflows of heap memory and other misbehaviors.

Quoted 8 lines

So, in the example code use the purpose specific kcalloc() function instead of the argument size * count in the kzalloc() function.

At the same time, modify the translations accordingly.

Applied. Thanks.

Signature · 1 line
viresh