Skip to contentSkip to conversation

mm/vmalloc: replace BUG_ON to a simple if statement

PATCH Superseded Hyunmin Lee 2 participants 3 messages Feb 1, 2023

Subsystems (2)

v3 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 mm/vmalloc: replace BUG_ON to a simple if statement

As per the coding standards, in the event of an abnormal condition that should not occur under normal circumstances, the kernel should attempt recovery and proceed with execution, rather than halting the machine.

Specifically, in the alloc_vmap_area() function, use a simple if() instead of using BUG_ON() halting the machine.

---
v1->v2 : Add commit description
v2->v3 : Change WARN_ON() to if()

---
 mm/vmalloc.c | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)
mm/vmalloc.c +8 -3
index 74afa2208558..52a346bc02a1 100644
@@ -1587,9 +1587,14 @@ static struct vmap_area *alloc_vmap_area(unsigned long size,
 	int purged = 0;
 	int ret;
 
-	BUG_ON(!size);
-	BUG_ON(offset_in_page(size));
-	BUG_ON(!is_power_of_2(align));
+	if (unlikely(!size))
+		return ERR_PTR(-EINVAL);
+
+	if (unlikely(offset_in_page(size)))
+		return ERR_PTR(-EINVAL);
+
+	if (unlikely(!is_power_of_2(align)))
+		return ERR_PTR(-EINVAL);
 
 	if (unlikely(!vmap_initialized))
 		return ERR_PTR(-EBUSY);
Signature · 1 line
2.25.1
#1 lore raw

Le 01/02/2023 à 11:11, Hyunmin Lee a écrit :

Quoted 33 lines

[Vous ne recevez pas souvent de courriers de [email protected]. D?couvrez pourquoi ceci est important ? https://aka.ms/LearnAboutSenderIdentification ]

As per the coding standards, in the event of an abnormal condition that should not occur under normal circumstances, the kernel should attempt recovery and proceed with execution, rather than halting the machine.

Specifically, in the alloc_vmap_area() function, use a simple if() instead of using BUG_ON() halting the machine.

---
v1->v2 : Add commit description
v2->v3 : Change WARN_ON() to if()

---
  mm/vmalloc.c | 11 ++++++++---
  1 file changed, 8 insertions(+), 3 deletions(-)
mm/vmalloc.c +0 -1
index 74afa2208558..52a346bc02a1 100644
@@ -1587,9 +1587,14 @@ static struct vmap_area *alloc_vmap_area(unsigned long size,
         int purged = 0;
         int ret;
 
-       BUG_ON(!size);

mm/vmalloc.c static struct vmap_area *alloc_vmap_area(unsigned long size, · line 1597

Quoted 10 lines
mm/vmalloc.c +8 -2
-       BUG_ON(offset_in_page(size));
-       BUG_ON(!is_power_of_2(align));
+       if (unlikely(!size))
+               return ERR_PTR(-EINVAL);
+
+       if (unlikely(offset_in_page(size)))
+               return ERR_PTR(-EINVAL);
+
+       if (unlikely(!is_power_of_2(align)))
+               return ERR_PTR(-EINVAL);

I would have written it more compact. When using BUG_ON or WARN_ON it is interesting to have three separate lines because you get the line number in the Oops message, but here you are just returning the exact same error code, so it could be:

	if (unlikely(!size || offset_in_page(size) || !is_power_of_2(align)))
		return ERR_PTR(-EINVAL);
Quoted 7 lines
mm/vmalloc.c +0 -1
         if (unlikely(!vmap_initialized))
                 return ERR_PTR(-EBUSY);
--

2.25.1

#2 lore raw
Quoted 52 lines · Christophe Leroy

Le 01/02/2023 à 11:11, Hyunmin Lee a écrit :

Quoted 33 lines

[Vous ne recevez pas souvent de courriers de [email protected]. D?couvrez pourquoi ceci est important ? https://aka.ms/LearnAboutSenderIdentification ]

As per the coding standards, in the event of an abnormal condition that should not occur under normal circumstances, the kernel should attempt recovery and proceed with execution, rather than halting the machine.

Specifically, in the alloc_vmap_area() function, use a simple if() instead of using BUG_ON() halting the machine.

---
v1->v2 : Add commit description
v2->v3 : Change WARN_ON() to if()

---
  mm/vmalloc.c | 11 ++++++++---
  1 file changed, 8 insertions(+), 3 deletions(-)
mm/vmalloc.c +0 -1
index 74afa2208558..52a346bc02a1 100644
@@ -1587,9 +1587,14 @@ static struct vmap_area *alloc_vmap_area(unsigned long size,
         int purged = 0;
         int ret;
 
-       BUG_ON(!size);

mm/vmalloc.c static struct vmap_area *alloc_vmap_area(unsigned long size, · line 1597

Quoted 10 lines
mm/vmalloc.c +8 -2
-       BUG_ON(offset_in_page(size));
-       BUG_ON(!is_power_of_2(align));
+       if (unlikely(!size))
+               return ERR_PTR(-EINVAL);
+
+       if (unlikely(offset_in_page(size)))
+               return ERR_PTR(-EINVAL);
+
+       if (unlikely(!is_power_of_2(align)))
+               return ERR_PTR(-EINVAL);

I would have written it more compact. When using BUG_ON or WARN_ON it is interesting to have three separate lines because you get the line number in the Oops message, but here you are just returning the exact same error code, so it could be:

Quoted 10 lines
	if (unlikely(!size || offset_in_page(size) || !is_power_of_2(align)))
		return ERR_PTR(-EINVAL);
Quoted 7 lines
mm/vmalloc.c +0 -1
         if (unlikely(!vmap_initialized))
                 return ERR_PTR(-EBUSY);
--

2.25.1

Hi Christophe,

Thanks for your comment.
I will send new patch.

Best,
Min