Skip to contentSkip to conversation

staging: android: Remove BUG/BUG_ONs

PATCH Superseded Tomer Samara 2 participants 5 messages Aug 19, 2020 – Aug 21, 2020 Staging

v3 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

v3 cover staging: android: Remove BUG/BUG_ONs

Remove BUG/BUG_ONs from androind/ion allocator and add error handling to calling functions

Tomer Samara (2):
staging: android: Remove BUG_ON from ion_page_pool.c
staging: android: Remove BUG from ion_system_heap.c

 drivers/staging/android/ion/ion_page_pool.c   | 14 ++++++++++----
 drivers/staging/android/ion/ion_system_heap.c | 15 ++++++++++++---
 2 files changed, 22 insertions(+), 7 deletions(-)
Signature · 1 line
2.25.1
#1 lore raw

PATCH v3 1/2 staging: android: Remove BUG_ON from ion_page_pool.c

BUG_ON() is removed at ion_page_pool.c and add error handleing to ion_page_pool_shrink

Fixes the following issue:
Avoid crashing the kernel - try using WARN_ON & recovery code ratherthan BUG() or BUG_ON().

---
 drivers/staging/android/ion/ion_page_pool.c | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)
drivers/staging/android/ion/ion_page_pool.c +10 -4
index 0198b886d906..ae2bc57bcbe8 100644
@@ -46,11 +46,13 @@ static struct page *ion_page_pool_remove(struct ion_page_pool *pool, bool high)
 	struct page *page;
 
 	if (high) {
-		BUG_ON(!pool->high_count);
+		if (!pool->high_count)
+			return NULL;
 		page = list_first_entry(&pool->high_items, struct page, lru);
 		pool->high_count--;
 	} else {
-		BUG_ON(!pool->low_count);
+		if (!pool->low_count)
+			return NULL;
 		page = list_first_entry(&pool->low_items, struct page, lru);
 		pool->low_count--;
 	}
@@ -65,7 +67,8 @@ struct page *ion_page_pool_alloc(struct ion_page_pool *pool)
 {
 	struct page *page = NULL;
 
-	BUG_ON(!pool);
+	if (!pool)
+		return NULL;
 
 	mutex_lock(&pool->mutex);
 	if (pool->high_count)
@@ -82,7 +85,8 @@ struct page *ion_page_pool_alloc(struct ion_page_pool *pool)
 
 void ion_page_pool_free(struct ion_page_pool *pool, struct page *page)
 {
-	BUG_ON(pool->order != compound_order(page));
+	if (pool->order != compound_order(page))
+		return;
 
 	ion_page_pool_add(pool, page);
 }
@@ -124,6 +128,8 @@ int ion_page_pool_shrink(struct ion_page_pool *pool, gfp_t gfp_mask,
 			break;
 		}
 		mutex_unlock(&pool->mutex);
+		if (!page)
+			break;
 		ion_page_pool_free_pages(pool, page);
 		freed += (1 << pool->order);
 	}
Signature · 1 line
2.25.1
#3 lore raw

PATCH v3 2/2 staging: android: Remove BUG from ion_system_heap.c

In reply to Tomer Samara

Remove BUG() at ion_sytem_heap.c and error handling to:
- free_buffer_page
- alloc_buffer_page
this fix the following checkpatch issue:
Avoid crashing the kernel - try using WARN_ON & recovery code ratherthan BUG() or BUG_ON().

---
 drivers/staging/android/ion/ion_system_heap.c | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)
drivers/staging/android/ion/ion_system_heap.c +12 -3
index eac0632ab4e8..56d53268b82c 100644
@@ -30,7 +30,7 @@ static int order_to_index(unsigned int order)
 	for (i = 0; i < NUM_ORDERS; i++)
 		if (order == orders[i])
 			return i;
-	BUG();
+
 	return -1;
 }
 
@@ -48,8 +48,13 @@ static struct page *alloc_buffer_page(struct ion_system_heap *heap,
 				      struct ion_buffer *buffer,
 				      unsigned long order)
 {
-	struct ion_page_pool *pool = heap->pools[order_to_index(order)];
+	struct ion_page_pool *pool;
+	int index = order_to_index(order);
 
+	if (index < 0)
+		return NULL;
+
+	pool = heap->pools[index];
 	return ion_page_pool_alloc(pool);
 }
 
@@ -58,6 +63,7 @@ static void free_buffer_page(struct ion_system_heap *heap,
 {
 	struct ion_page_pool *pool;
 	unsigned int order = compound_order(page);
+	int index;
 
 	/* go to system */
 	if (buffer->private_flags & ION_PRIV_FLAG_SHRINKER_FREE) {
@@ -65,8 +71,11 @@ static void free_buffer_page(struct ion_system_heap *heap,
 		return;
 	}
 
-	pool = heap->pools[order_to_index(order)];
+	index = order_to_index(order);
+	if (index < 0)
+		return;
 
+	pool = heap->pools[index];
 	ion_page_pool_free(pool, page);
 }
 
Signature · 1 line
2.25.1
#2 lore raw

Re: [PATCH v3 1/2] staging: android: Remove BUG_ON from ion_page_pool.c

In reply to Tomer Samara
Quoted 16 lines · Tomer Samara

BUG_ON() is removed at ion_page_pool.c and add error handleing to ion_page_pool_shrink

Fixes the following issue:
Avoid crashing the kernel - try using WARN_ON & recovery code ratherthan BUG() or BUG_ON().

---
 drivers/staging/android/ion/ion_page_pool.c | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)
drivers/staging/android/ion/ion_page_pool.c +0 -0
index 0198b886d906..ae2bc57bcbe8 100644

drivers/staging/android/ion/ion_page_pool.c static struct page *ion_page_pool_remove(struct ion_page_pool *pool, bool high) · line 50

Quoted 6 lines
drivers/staging/android/ion/ion_page_pool.c +2 -1
@@ -46,11 +46,13 @@ static struct page *ion_page_pool_remove(struct ion_page_pool *pool, bool high)
 	struct page *page;
 
 	if (high) {
-		BUG_ON(!pool->high_count);
+		if (!pool->high_count)
+			return NULL;

I looked at the callers and it's trivial to verify that these conditions are impossible. Just delete the BUG_ON() checks.

Quoted 10 lines
drivers/staging/android/ion/ion_page_pool.c +2 -1
 		page = list_first_entry(&pool->high_items, struct page, lru);
 		pool->high_count--;
 	} else {
-		BUG_ON(!pool->low_count);
+		if (!pool->low_count)
+			return NULL;
 		page = list_first_entry(&pool->low_items, struct page, lru);
 		pool->low_count--;
 	}

drivers/staging/android/ion/ion_page_pool.c struct page *ion_page_pool_alloc(struct ion_page_pool *pool) · line 71

Quoted 6 lines
drivers/staging/android/ion/ion_page_pool.c +2 -1
@@ -65,7 +67,8 @@ struct page *ion_page_pool_alloc(struct ion_page_pool *pool)
 {
 	struct page *page = NULL;
 
-	BUG_ON(!pool);
+	if (!pool)
+		return NULL;

This one is slightly harder to verify... But really I would prefer that we just deleted it as well. If we had a NULL dereference here then that would give a pretty straight forward stack trace to debug.

drivers/staging/android/ion/ion_page_pool.c struct page *ion_page_pool_alloc(struct ion_page_pool *pool) · line 89

Quoted 10 lines
drivers/staging/android/ion/ion_page_pool.c +2 -1
 	mutex_lock(&pool->mutex);
 	if (pool->high_count)
@@ -82,7 +85,8 @@ struct page *ion_page_pool_alloc(struct ion_page_pool *pool)
 
 void ion_page_pool_free(struct ion_page_pool *pool, struct page *page)
 {
-	BUG_ON(pool->order != compound_order(page));
+	if (pool->order != compound_order(page))
+		return;

Is returning really the correct way to handle this bug? I suggest, just change BUG_ON() to a WARN_ON().

drivers/staging/android/ion/ion_page_pool.c int ion_page_pool_shrink(struct ion_page_pool *pool, gfp_t gfp_mask, · line 132

Quoted 9 lines
drivers/staging/android/ion/ion_page_pool.c +2 -0
 	ion_page_pool_add(pool, page);
 }
@@ -124,6 +128,8 @@ int ion_page_pool_shrink(struct ion_page_pool *pool, gfp_t gfp_mask,
 			break;
 		}
 		mutex_unlock(&pool->mutex);
+		if (!page)
+			break;

This change is no longer required if we delete the changes earlier as I suggest. This change illustrates how when we start handling impossible conditions then we just have to keep on imagining more and more impossible conditions. When we start trying to write code for situations which we know are impossible that is an unending task.

drivers/staging/android/ion/ion_page_pool.c int ion_page_pool_shrink(struct ion_page_pool *pool, gfp_t gfp_mask, · line 135

Quoted 3 lines
drivers/staging/android/ion/ion_page_pool.c +0 -0
 		ion_page_pool_free_pages(pool, page);
 		freed += (1 << pool->order);
 	}

regards,
dan carpenter

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

#4 lore raw

Re: [PATCH v3 2/2] staging: android: Remove BUG from ion_system_heap.c

In reply to Tomer Samara
Quoted 17 lines · Tomer Samara

Remove BUG() at ion_sytem_heap.c and error handling to:
- free_buffer_page
- alloc_buffer_page
this fix the following checkpatch issue:
Avoid crashing the kernel - try using WARN_ON & recovery code ratherthan BUG() or BUG_ON().

---
 drivers/staging/android/ion/ion_system_heap.c | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)
drivers/staging/android/ion/ion_system_heap.c +0 -0
index eac0632ab4e8..56d53268b82c 100644

drivers/staging/android/ion/ion_system_heap.c static int order_to_index(unsigned int order) · line 35

Quoted 7 lines
drivers/staging/android/ion/ion_system_heap.c +1 -1
@@ -30,7 +30,7 @@ static int order_to_index(unsigned int order)
 	for (i = 0; i < NUM_ORDERS; i++)
 		if (order == orders[i])
 			return i;
-	BUG();
+
 	return -1;
 }

Just delete the BUG() and put a comment that /* This is impossible. */ so that reviewers know that we never return -1.

I suspect that there are some static analysis tools which might complain about this -1 return. But those tools are pretty crap. Never change code just to make the tools happy.

regards,
dan carpenter

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel