Skip to contentSkip to conversation

media: atomisp: Fix smatch warnings caused by atomisp custom assert() usage

PATCH In review Hans de Goede 3 participants 5 messages Jul 30, 2023 – Aug 1, 2023

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

PATCH v2 1/2 media: atomisp: Fix smatch warnings caused by atomisp custom assert() usage

The atomisp code base has a custom assert() macro, a couple of functions use this in a construction like the following:

   assert(pipe);
   assert(pipe->stream);
   if ((!pipe) || (!pipe->stream)) {
           ia_css_debug_dtrace(IA_CSS_DEBUG_TRACE_PRIVATE,
                               "allocate_mipi_frames(%p) exit: ...\n",
                               pipe);
           return -EINVAL;
   }

The second assert is seen by smatch as dereferencing "pipe" in the above example (and dereferencing "dvs_6axis_config" in the other case).

Following by the dereferenced variable being checked (a second time) in the following if () statement.

This triggers the following smatch warnings:
drivers/staging/media/atomisp/pci/sh_css_mipi.c:356 allocate_mipi_frames() warn: variable dereferenced before check 'pipe' (see line 355) drivers/staging/media/atomisp/pci/sh_css_mipi.c:562 send_mipi_frames() warn: variable dereferenced before check 'pipe' (see line 561) drivers/staging/media/atomisp/pci/sh_css_param_dvs.c:208 free_dvs_6axis_table() warn: variable dereferenced before check 'dvs_6axis_config' (see line 206)

The custom assert() macro actually expands to a BUG() call and BUG() calls should not be used in the kernel.

Remove the assert() calls to fix the smatch warnings and in case of [allocate|send]_mipi_frames() also remove the if () return -EINVAL block since these functions are never called with a NULL pipe.

---
Note:
1. No Closes: tag since Hans Verkuil reported this in an offlist email.
2. All the other assert() calls really should also be removed. I've put this on my todo list.
---
Changes in v2:
- Drop the sh_css_sp.c bits, just dropping the assert() calls is not enough there

---
 drivers/staging/media/atomisp/pci/sh_css_mipi.c  | 16 ----------------
 .../staging/media/atomisp/pci/sh_css_param_dvs.c |  3 ---
 2 files changed, 19 deletions(-)
drivers/staging/media/atomisp/pci/sh_css_mipi.c +0 -16
index b20acaab0595..ced21dedf7ac 100644
@@ -351,15 +351,6 @@ allocate_mipi_frames(struct ia_css_pipe *pipe,
 	ia_css_debug_dtrace(IA_CSS_DEBUG_TRACE_PRIVATE,
 			    "allocate_mipi_frames(%p) enter:\n", pipe);
 
-	assert(pipe);
-	assert(pipe->stream);
-	if ((!pipe) || (!pipe->stream)) {
-		ia_css_debug_dtrace(IA_CSS_DEBUG_TRACE_PRIVATE,
-				    "allocate_mipi_frames(%p) exit: pipe or stream is null.\n",
-				    pipe);
-		return -EINVAL;
-	}
-
 	if (IS_ISP2401 && pipe->stream->config.online) {
 		ia_css_debug_dtrace(IA_CSS_DEBUG_TRACE_PRIVATE,
 				    "allocate_mipi_frames(%p) exit: no buffers needed for 2401 pipe mode.\n",
@@ -557,13 +548,6 @@ send_mipi_frames(struct ia_css_pipe *pipe)
 
 	IA_CSS_ENTER_PRIVATE("pipe=%p", pipe);
 
-	assert(pipe);
-	assert(pipe->stream);
-	if (!pipe || !pipe->stream) {
-		IA_CSS_ERROR("pipe or stream is null");
-		return -EINVAL;
-	}
-
 	/* multi stream video needs mipi buffers */
 	/* nothing to be done in other cases. */
 	if (pipe->stream->config.mode != IA_CSS_INPUT_MODE_BUFFERED_SENSOR) {
drivers/staging/media/atomisp/pci/sh_css_param_dvs.c +0 -3
index ff0082d02af3..5174bc210ae1 100644
@@ -202,9 +202,6 @@ generate_dvs_6axis_table_from_config(struct ia_css_dvs_6axis_config
 void
 free_dvs_6axis_table(struct ia_css_dvs_6axis_config  **dvs_6axis_config)
 {
-	assert(dvs_6axis_config);
-	assert(*dvs_6axis_config);
-
 	if ((dvs_6axis_config) && (*dvs_6axis_config)) {
 		IA_CSS_ENTER_PRIVATE("dvs_6axis_config %p", (*dvs_6axis_config));
 		if ((*dvs_6axis_config)->xcoords_y) {
Signature · 1 line
2.41.0
#1 lore raw

PATCH v2 2/2 media: atomisp: Fix me->stages error checking in sh_css_sp_init_pipeline()

The current error-checking of me->stages in sh_css_sp_init_pipeline() has some issues / weirdness:

1. It is checked at the top of the function, but only using the atomisp custom assert() macro which e.g. smatch does not recognize

2. It is first dereferenced in "first_binary = me->stages->binary", but outside of the assert it is checked much later, triggering the following smatch warning:

drivers/staging/media/atomisp/pci/sh_css_sp.c:1255 sh_css_sp_init_pipeline()
warn: variable dereferenced before check 'me->stages' (see line 1224)

Drop the custom assert() calls (note 'me' is never NULL) and instead add a regular check for me->stages not being set.

---
 drivers/staging/media/atomisp/pci/sh_css_sp.c | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)
drivers/staging/media/atomisp/pci/sh_css_sp.c +8 -6
index 4ef1c9e61ea8..eba70d4800a1 100644
@@ -51,6 +51,7 @@
 #include "ia_css_event.h"
 #include "mmu_device.h"
 #include "ia_css_spctrl.h"
+#include "atomisp_internal.h"
 
 #ifndef offsetof
 #define offsetof(T, x) ((unsigned int)&(((T *)0)->x))
@@ -1210,14 +1211,15 @@ sh_css_sp_init_pipeline(struct ia_css_pipeline *me,
 	struct ia_css_binary	     *first_binary = NULL;
 	struct ia_css_pipe *pipe = NULL;
 	unsigned int num;
-
 	enum ia_css_pipe_id pipe_id = id;
 	unsigned int thread_id;
 	u8 if_config_index, tmp_if_config_index;
 
-	assert(me);
-
-	assert(me->stages);
+	if (!me->stages) {
+		dev_err(atomisp_dev, "%s called on a pipeline without stages\n",
+			__func__);
+		return; /* FIXME should be able to return an error */
+	}
 
 	first_binary = me->stages->binary;
 
@@ -1250,8 +1252,8 @@ sh_css_sp_init_pipeline(struct ia_css_pipeline *me,
 	} /* if (first_binary != NULL) */
 
 	/* Signal the host immediately after start for SP_ISYS_COPY only */
-	if ((me->num_stages == 1) && me->stages &&
-	    (me->stages->sp_func == IA_CSS_PIPELINE_ISYS_COPY))
+	if (me->num_stages == 1 &&
+	    me->stages->sp_func == IA_CSS_PIPELINE_ISYS_COPY)
 		sh_css_sp_group.config.no_isp_sync = true;
 
 	/* Init stage data */
Signature · 1 line
2.41.0
Reviewed-by on v2 2/2
#2 lore raw

Re: [PATCH v2 2/2] media: atomisp: Fix me->stages error checking in sh_css_sp_init_pipeline()

Hi Hans,

Quoted 42 lines · Hans de Goede

The current error-checking of me->stages in sh_css_sp_init_pipeline() has some issues / weirdness:

1. It is checked at the top of the function, but only using the atomisp custom assert() macro which e.g. smatch does not recognize

2. It is first dereferenced in "first_binary = me->stages->binary", but outside of the assert it is checked much later, triggering the following smatch warning:

drivers/staging/media/atomisp/pci/sh_css_sp.c:1255 sh_css_sp_init_pipeline()
warn: variable dereferenced before check 'me->stages' (see line 1224)

Drop the custom assert() calls (note 'me' is never NULL) and instead add a regular check for me->stages not being set.

---
 drivers/staging/media/atomisp/pci/sh_css_sp.c | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)
drivers/staging/media/atomisp/pci/sh_css_sp.c +1 -1
index 4ef1c9e61ea8..eba70d4800a1 100644
@@ -51,6 +51,7 @@
 #include "ia_css_event.h"
 #include "mmu_device.h"
 #include "ia_css_spctrl.h"
+#include "atomisp_internal.h"
 
 #ifndef offsetof
 #define offsetof(T, x) ((unsigned int)&(((T *)0)->x))
@@ -1210,14 +1211,15 @@ sh_css_sp_init_pipeline(struct ia_css_pipeline *me,
        struct ia_css_binary         *first_binary = NULL;
        struct ia_css_pipe *pipe = NULL;
        unsigned int num;
-
        enum ia_css_pipe_id pipe_id = id;

drivers/staging/media/atomisp/pci/sh_css_sp.c sh_css_sp_init_pipeline(struct ia_css_pipeline *me, · line 1221

Quoted 10 lines
drivers/staging/media/atomisp/pci/sh_css_sp.c +4 -3
        unsigned int thread_id;
        u8 if_config_index, tmp_if_config_index;
 
-       assert(me);
-
-       assert(me->stages);
+       if (!me->stages) {
+               dev_err(atomisp_dev, "%s called on a pipeline without stages\n",
+                       __func__);
+               return; /* FIXME should be able to return an error */

Agree, an error handling is needed for the caller.

Quoted 16 lines
drivers/staging/media/atomisp/pci/sh_css_sp.c +3 -3
+       }
 
        first_binary = me->stages->binary;
 
@@ -1250,8 +1252,8 @@ sh_css_sp_init_pipeline(struct ia_css_pipeline *me,
        } /* if (first_binary != NULL) */
 
        /* Signal the host immediately after start for SP_ISYS_COPY only */
-       if ((me->num_stages == 1) && me->stages &&
-           (me->stages->sp_func == IA_CSS_PIPELINE_ISYS_COPY))
+       if (me->num_stages == 1 &&
+           me->stages->sp_func == IA_CSS_PIPELINE_ISYS_COPY)
                sh_css_sp_group.config.no_isp_sync = true;
 
        /* Init stage data */
--
Quoted 2 lines

2.41.0

It is good for me.

--
BR,
Kate

#3 lore raw
In reply to Hans de Goede

Hi Hans,

Quoted 53 lines · Hans de Goede

The atomisp code base has a custom assert() macro, a couple of functions use this in a construction like the following:

   assert(pipe);
   assert(pipe->stream);
   if ((!pipe) || (!pipe->stream)) {
           ia_css_debug_dtrace(IA_CSS_DEBUG_TRACE_PRIVATE,
                               "allocate_mipi_frames(%p) exit: ...\n",
                               pipe);
           return -EINVAL;
   }

The second assert is seen by smatch as dereferencing "pipe" in the above example (and dereferencing "dvs_6axis_config" in the other case).

Following by the dereferenced variable being checked (a second time) in the following if () statement.

This triggers the following smatch warnings:
drivers/staging/media/atomisp/pci/sh_css_mipi.c:356 allocate_mipi_frames() warn: variable dereferenced before check 'pipe' (see line 355) drivers/staging/media/atomisp/pci/sh_css_mipi.c:562 send_mipi_frames() warn: variable dereferenced before check 'pipe' (see line 561) drivers/staging/media/atomisp/pci/sh_css_param_dvs.c:208 free_dvs_6axis_table() warn: variable dereferenced before check 'dvs_6axis_config' (see line 206)

The custom assert() macro actually expands to a BUG() call and BUG() calls should not be used in the kernel.

Remove the assert() calls to fix the smatch warnings and in case of [allocate|send]_mipi_frames() also remove the if () return -EINVAL block since these functions are never called with a NULL pipe.

---
Note:
1. No Closes: tag since Hans Verkuil reported this in an offlist email.
2. All the other assert() calls really should also be removed. I've put this on my todo list.
---
Changes in v2:
- Drop the sh_css_sp.c bits, just dropping the assert() calls is not enough there

---
 drivers/staging/media/atomisp/pci/sh_css_mipi.c  | 16 ----------------
 .../staging/media/atomisp/pci/sh_css_param_dvs.c |  3 ---
 2 files changed, 19 deletions(-)
drivers/staging/media/atomisp/pci/sh_css_mipi.c +0 -0
index b20acaab0595..ced21dedf7ac 100644
@@ -351,15 +351,6 @@ allocate_mipi_frames(struct ia_css_pipe *pipe,
        ia_css_debug_dtrace(IA_CSS_DEBUG_TRACE_PRIVATE,

drivers/staging/media/atomisp/pci/sh_css_mipi.c allocate_mipi_frames(struct ia_css_pipe *pipe, · line 361

Quoted 10 lines
drivers/staging/media/atomisp/pci/sh_css_mipi.c +0 -8
                            "allocate_mipi_frames(%p) enter:\n", pipe);
 
-       assert(pipe);
-       assert(pipe->stream);
-       if ((!pipe) || (!pipe->stream)) {
-               ia_css_debug_dtrace(IA_CSS_DEBUG_TRACE_PRIVATE,
-                                   "allocate_mipi_frames(%p) exit: pipe or stream is null.\n",
-                                   pipe);
-               return -EINVAL;
-       }

Thank you for working on this.

The NULL test for pipe could be kept here since the caller only tests "stream" but not test "main_pipe" is NULL. (sh_css.c line: 1799)

The rest of the part is ok for me.

Quoted 35 lines
drivers/staging/media/atomisp/pci/sh_css_mipi.c +0 -8
-
        if (IS_ISP2401 && pipe->stream->config.online) {
                ia_css_debug_dtrace(IA_CSS_DEBUG_TRACE_PRIVATE,
                                    "allocate_mipi_frames(%p) exit: no buffers needed for 2401 pipe mode.\n",
@@ -557,13 +548,6 @@ send_mipi_frames(struct ia_css_pipe *pipe)
 
        IA_CSS_ENTER_PRIVATE("pipe=%p", pipe);
 
-       assert(pipe);
-       assert(pipe->stream);
-       if (!pipe || !pipe->stream) {
-               IA_CSS_ERROR("pipe or stream is null");
-               return -EINVAL;
-       }
-
        /* multi stream video needs mipi buffers */
        /* nothing to be done in other cases. */
        if (pipe->stream->config.mode != IA_CSS_INPUT_MODE_BUFFERED_SENSOR) {
drivers/staging/media/atomisp/pci/sh_css_param_dvs.c +0 -4
index ff0082d02af3..5174bc210ae1 100644
@@ -202,9 +202,6 @@ generate_dvs_6axis_table_from_config(struct ia_css_dvs_6axis_config
 void
 free_dvs_6axis_table(struct ia_css_dvs_6axis_config  **dvs_6axis_config)
 {
-       assert(dvs_6axis_config);
-       assert(*dvs_6axis_config);
-
        if ((dvs_6axis_config) && (*dvs_6axis_config)) {
                IA_CSS_ENTER_PRIVATE("dvs_6axis_config %p", (*dvs_6axis_config));
                if ((*dvs_6axis_config)->xcoords_y) {
--

2.41.0

Signature · 2 lines
BR,
Kate
#4 lore raw
Quoted 19 lines · Kate Hsuan
Quoted 6 lines
drivers/staging/media/atomisp/pci/sh_css_mipi.c +0 -0
index b20acaab0595..ced21dedf7ac 100644
@@ -351,15 +351,6 @@ allocate_mipi_frames(struct ia_css_pipe *pipe,
        ia_css_debug_dtrace(IA_CSS_DEBUG_TRACE_PRIVATE,

drivers/staging/media/atomisp/pci/sh_css_mipi.c allocate_mipi_frames(struct ia_css_pipe *pipe, · line 361

Quoted 10 lines
drivers/staging/media/atomisp/pci/sh_css_mipi.c +0 -8
                            "allocate_mipi_frames(%p) enter:\n", pipe);
 
-       assert(pipe);
-       assert(pipe->stream);
-       if ((!pipe) || (!pipe->stream)) {
-               ia_css_debug_dtrace(IA_CSS_DEBUG_TRACE_PRIVATE,
-                                   "allocate_mipi_frames(%p) exit: pipe or stream is null.\n",
-                                   pipe);
-               return -EINVAL;
-       }

Thank you for working on this.

Quoted 3 lines

The NULL test for pipe could be kept here since the caller only tests "stream" but not test "main_pipe" is NULL. (sh_css.c line: 1799)

It dereferences main_pipe on the next line so this check would be too late.

drivers/staging/media/atomisp/pci/sh_css.c
1799 main_pipe = stream->last_pipe;
1800 pipe_id = main_pipe->mode;

Smatch says that ->last_pipe is known to be non-NULL as well.

$ smdb.py create_host_pipeline
drivers/staging/media/atomisp/pci/sh_css.c |  ia_css_stream_start | create_host_pipeline |        PARAM_VALUE |  0 | stream->last_pipe | 4096-ptr_max

regards,
dan carpenter