Skip to contentSkip to conversation

qla2xxx: Fix a NULL pointer dereference in an error path

PATCH In review Bart Van Assche 4 participants 8 messages Jan 12, 2020 – Jan 15, 2020

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

PATCH 1/1 qla2xxx: Fix a NULL pointer dereference in an error path

This patch fixes the following Coverity complaint:

FORWARD_NULL

qla_init.c: 5275 in qla2x00_configure_local_loop() 5269

5270     		if (fcport->scan_state == QLA_FCPORT_FOUND)
5271     			qla24xx_fcport_handle_login(vha, fcport);
5272     	}

5273
5274 cleanup_allocation:

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 353340: (FORWARD_NULL)
Passing null pointer "new_fcport" to "qla2x00_free_fcport", which dereferences it.

5275 qla2x00_free_fcport(new_fcport);
5276

5277     	if (rval != QLA_SUCCESS) {
5278     		ql_dbg(ql_dbg_disc, vha, 0x2098,
5279     		    "Configure local loop error exit: rval=%x.\n", rval);
5280     	}
qla_init.c: 5275 in qla2x00_configure_local_loop()
5269
5270     		if (fcport->scan_state == QLA_FCPORT_FOUND)
5271     			qla24xx_fcport_handle_login(vha, fcport);
5272     	}

5273
5274 cleanup_allocation:

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 353340: (FORWARD_NULL)
Passing null pointer "new_fcport" to "qla2x00_free_fcport", which dereferences it.

5275 qla2x00_free_fcport(new_fcport);
5276

5277     	if (rval != QLA_SUCCESS) {
5278     		ql_dbg(ql_dbg_disc, vha, 0x2098,
5279     		    "Configure local loop error exit: rval=%x.\n", rval);
5280     	}
Cc Himanshu Madhani <[email protected]>
Cc Quinn Tran <[email protected]>
Cc Martin Wilck <[email protected]>
Cc Daniel Wagner <[email protected]>
Cc Roman Bolshakov <[email protected]>
Fixes 3dae220595ba ("scsi: qla2xxx: Use common routine to free fcport struct")
---
 drivers/scsi/qla2xxx/qla_init.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/scsi/qla2xxx/qla_init.c +2 -0
index c4e087217484..6560908ed50e 100644
@@ -4895,6 +4895,8 @@ qla2x00_alloc_fcport(scsi_qla_host_t *vha, gfp_t flags)
 void
 qla2x00_free_fcport(fc_port_t *fcport)
 {
+	if (!fcport)
+		return;
 	if (fcport->ct_desc.ct_sns) {
 		dma_free_coherent(&fcport->vha->hw->pdev->dev,
 			sizeof(struct ct_sns_pkt), fcport->ct_desc.ct_sns,
Reviewed-by on v1 1/1
#1 lore raw

Hi,

Quoted 26 lines · Bart Van Assche

This patch fixes the following Coverity complaint:

FORWARD_NULL

qla_init.c: 5275 in qla2x00_configure_local_loop() 5269

5270     		if (fcport->scan_state == QLA_FCPORT_FOUND)
5271     			qla24xx_fcport_handle_login(vha, fcport);
5272     	}

5273
5274 cleanup_allocation:

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 353340: (FORWARD_NULL)
Passing null pointer "new_fcport" to "qla2x00_free_fcport", which dereferences it.

5275 qla2x00_free_fcport(new_fcport);
5276

5277     	if (rval != QLA_SUCCESS) {
5278     		ql_dbg(ql_dbg_disc, vha, 0x2098,
5279     		    "Configure local loop error exit: rval=%x.\n", rval);
5280     	}
qla_init.c: 5275 in qla2x00_configure_local_loop()
5269
5270     		if (fcport->scan_state == QLA_FCPORT_FOUND)
5271     			qla24xx_fcport_handle_login(vha, fcport);
5272     	}

5273
5274 cleanup_allocation:

Quoted 8 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 353340: (FORWARD_NULL)
Passing null pointer "new_fcport" to "qla2x00_free_fcport", which dereferences it.

5275 qla2x00_free_fcport(new_fcport);
5276

5277     	if (rval != QLA_SUCCESS) {
5278     		ql_dbg(ql_dbg_disc, vha, 0x2098,
5279     		    "Configure local loop error exit: rval=%x.\n", rval);
5280     	}

nitpick: one copy of the coverity report is enough.

Quoted 7 lines
Cc Himanshu Madhani <[email protected]>
Cc Quinn Tran <[email protected]>
Cc Martin Wilck <[email protected]>
Cc Daniel Wagner <[email protected]>
Cc Roman Bolshakov <[email protected]>
Fixes 3dae220595ba ("scsi: qla2xxx: Use common routine to free fcport struct")

Thanks,
Daniel

Reviewed-by on v1 1/1
#2 lore raw
In reply to Bart Van Assche
Quoted 54 lines · Bart Van Assche

This patch fixes the following Coverity complaint:

FORWARD_NULL

qla_init.c: 5275 in qla2x00_configure_local_loop() 5269

5270     		if (fcport->scan_state == QLA_FCPORT_FOUND)
5271     			qla24xx_fcport_handle_login(vha, fcport);
5272     	}

5273
5274 cleanup_allocation:

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 353340: (FORWARD_NULL)
Passing null pointer "new_fcport" to "qla2x00_free_fcport", which dereferences it.

5275 qla2x00_free_fcport(new_fcport);
5276

5277     	if (rval != QLA_SUCCESS) {
5278     		ql_dbg(ql_dbg_disc, vha, 0x2098,
5279     		    "Configure local loop error exit: rval=%x.\n", rval);
5280     	}
qla_init.c: 5275 in qla2x00_configure_local_loop()
5269
5270     		if (fcport->scan_state == QLA_FCPORT_FOUND)
5271     			qla24xx_fcport_handle_login(vha, fcport);
5272     	}

5273
5274 cleanup_allocation:

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 353340: (FORWARD_NULL)
Passing null pointer "new_fcport" to "qla2x00_free_fcport", which dereferences it.

5275 qla2x00_free_fcport(new_fcport);
5276

5277     	if (rval != QLA_SUCCESS) {
5278     		ql_dbg(ql_dbg_disc, vha, 0x2098,
5279     		    "Configure local loop error exit: rval=%x.\n", rval);
5280     	}
Cc Himanshu Madhani <[email protected]>
Cc Quinn Tran <[email protected]>
Cc Martin Wilck <[email protected]>
Cc Daniel Wagner <[email protected]>
Cc Roman Bolshakov <[email protected]>
Fixes 3dae220595ba ("scsi: qla2xxx: Use common routine to free fcport struct")
---
 drivers/scsi/qla2xxx/qla_init.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/scsi/qla2xxx/qla_init.c +0 -0
index c4e087217484..6560908ed50e 100644

drivers/scsi/qla2xxx/qla_init.c qla2x00_alloc_fcport(scsi_qla_host_t *vha, gfp_t flags) · line 4902

Quoted 8 lines
drivers/scsi/qla2xxx/qla_init.c +2 -0
@@ -4895,6 +4895,8 @@ qla2x00_alloc_fcport(scsi_qla_host_t *vha, gfp_t flags)
 void
 qla2x00_free_fcport(fc_port_t *fcport)
 {
+	if (!fcport)
+		return;
 	if (fcport->ct_desc.ct_sns) {
 		dma_free_coherent(&fcport->vha->hw->pdev->dev,
 			sizeof(struct ct_sns_pkt), fcport->ct_desc.ct_sns,

I would have fixed this by moving the label to be after the qla2x00_free_fcport() call in qla2x00_configure_local_loop(), which Coverity complained about. And called it something different. (The code could probably be simplified by only making a call to qla2x00_alloc_fcport() in one place, something to think about...)

I also notice that there is duplicate code in qla2x00_alloc_fcport() that tests for:

        if (!fcport->ct_desc.ct_sns)

But, this should fix the Coverity issue.

#3 lore raw
Quoted 12 lines · Ewan D. Milne
Quoted 11 lines · Bart Van Assche
drivers/scsi/qla2xxx/qla_init.c +2 -0
index c4e087217484..6560908ed50e 100644
@@ -4895,6 +4895,8 @@ qla2x00_alloc_fcport(scsi_qla_host_t *vha, gfp_t flags)
  void
  qla2x00_free_fcport(fc_port_t *fcport)
  {
+	if (!fcport)
+		return;
  	if (fcport->ct_desc.ct_sns) {
Quoted 8 lines

drivers/scsi/qla2xxx/qla_init.c qla2x00_alloc_fcport(scsi_qla_host_t *vha, gfp_t flags) · line 4902

Quoted 3 lines
drivers/scsi/qla2xxx/qla_init.c +0 -0
  		dma_free_coherent(&fcport->vha->hw->pdev->dev,
  			sizeof(struct ct_sns_pkt), fcport->ct_desc.ct_sns,

I would have fixed this by moving the label to be after the qla2x00_free_fcport() call in qla2x00_configure_local_loop(), which Coverity complained about. And called it something different. (The code could probably be simplified by only making a call to qla2x00_alloc_fcport() in one place, something to think about...)

Hi Ewan,

I have considered the solution that you proposed. The solution shown above was chosen because I did not want to introduce any memory leaks in qla2x00_configure_local_loop(). There is a "goto cleanup_allocation" statement in that function that occurs after the "new_fcport = qla2x00_alloc_fcport(vha, GFP_KERNEL)" assignment. That is hard to notice because the qla2x00_configure_local_loop() function is so long.

Thanks,

Bart.

#4 lore raw
Quoted 22 lines · Bart Van Assche
Quoted 12 lines · Ewan D. Milne
Quoted 11 lines · Bart Van Assche
drivers/scsi/qla2xxx/qla_init.c +2 -0
index c4e087217484..6560908ed50e 100644
@@ -4895,6 +4895,8 @@ qla2x00_alloc_fcport(scsi_qla_host_t *vha, gfp_t flags)
  void
  qla2x00_free_fcport(fc_port_t *fcport)
  {
+	if (!fcport)
+		return;
  	if (fcport->ct_desc.ct_sns) {
Quoted 8 lines

drivers/scsi/qla2xxx/qla_init.c qla2x00_alloc_fcport(scsi_qla_host_t *vha, gfp_t flags) · line 4902

Quoted 3 lines
drivers/scsi/qla2xxx/qla_init.c +0 -0
  		dma_free_coherent(&fcport->vha->hw->pdev->dev,
  			sizeof(struct ct_sns_pkt), fcport->ct_desc.ct_sns,

I would have fixed this by moving the label to be after the qla2x00_free_fcport() call in qla2x00_configure_local_loop(), which Coverity complained about. And called it something different. (The code could probably be simplified by only making a call to qla2x00_alloc_fcport() in one place, something to think about...)

Quoted 9 lines

Hi Ewan,

I have considered the solution that you proposed. The solution shown above was chosen because I did not want to introduce any memory leaks in qla2x00_configure_local_loop(). There is a "goto cleanup_allocation" statement in that function that occurs after the "new_fcport = qla2x00_alloc_fcport(vha, GFP_KERNEL)" assignment. That is hard to notice because the qla2x00_configure_local_loop() function is so long.

Yes, but isn't that after "if (new_fcport == NULL)" where the code has put the previously allocated fcport into the &vha->vp_fcports list and was unable to allocate another one?

-Ewan

#5 lore raw
Quoted 3 lines · Ewan D. Milne

Yes, but isn't that after "if (new_fcport == NULL)" where the code has put the previously allocated fcport into the &vha->vp_fcports list and was unable to allocate another one?

How about the (untested) patch below?

Thanks,

Bart.

From 436e1552f79b3a3b7d3f3b1dea1df27c33bd0d49 Mon Sep 17 00:00:00 2001
From: Bart Van Assche <[email protected]>
Date: Sun, 12 Jan 2020 09:17:37 -0800
Subject: [PATCH v2] qla2xxx: Fix a NULL pointer dereference in an error path

This patch fixes the following Coverity complaint:

FORWARD_NULL

qla_init.c: 5275 in qla2x00_configure_local_loop() 5269

5270     		if (fcport->scan_state == QLA_FCPORT_FOUND)
5271     			qla24xx_fcport_handle_login(vha, fcport);
5272     	}

5273
5274 cleanup_allocation:

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 353340: (FORWARD_NULL)
Passing null pointer "new_fcport" to "qla2x00_free_fcport", which dereferences it.

5275 qla2x00_free_fcport(new_fcport);
5276

5277     	if (rval != QLA_SUCCESS) {
5278     		ql_dbg(ql_dbg_disc, vha, 0x2098,
5279     		    "Configure local loop error exit: rval=%x.\n", rval);
5280     	}
qla_init.c: 5275 in qla2x00_configure_local_loop()
5269
5270     		if (fcport->scan_state == QLA_FCPORT_FOUND)
5271     			qla24xx_fcport_handle_login(vha, fcport);
5272     	}

5273
5274 cleanup_allocation:

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 353340: (FORWARD_NULL)
Passing null pointer "new_fcport" to "qla2x00_free_fcport", which dereferences it.

5275 qla2x00_free_fcport(new_fcport);
5276

5277     	if (rval != QLA_SUCCESS) {
5278     		ql_dbg(ql_dbg_disc, vha, 0x2098,
5279     		    "Configure local loop error exit: rval=%x.\n", rval);
5280     	}
Cc Himanshu Madhani <[email protected]>
Cc Quinn Tran <[email protected]>
Cc Martin Wilck <[email protected]>
Cc Daniel Wagner <[email protected]>
Cc Roman Bolshakov <[email protected]>
Fixes 3dae220595ba ("scsi: qla2xxx: Use common routine to free fcport struct")
---
 drivers/scsi/qla2xxx/qla_init.c | 17 ++++++++---------
 1 file changed, 8 insertions(+), 9 deletions(-)
drivers/scsi/qla2xxx/qla_init.c +8 -9
index c4e087217484..62df78258269 100644
@@ -5109,7 +5109,7 @@ qla2x00_configure_local_loop(scsi_qla_host_t *vha)
 	rval = qla2x00_get_id_list(vha, ha->gid_list, ha->gid_list_dma,
 	    &entries);
 	if (rval != QLA_SUCCESS)
-		goto cleanup_allocation;
+		goto err;
 
 	ql_dbg(ql_dbg_disc, vha, 0x2011,
 	    "Entries in ID list (%d).\n", entries);
@@ -5139,7 +5139,7 @@ qla2x00_configure_local_loop(scsi_qla_host_t *vha)
 		ql_log(ql_log_warn, vha, 0x2012,
 		    "Memory allocation failed for fcport.\n");
 		rval = QLA_MEMORY_ALLOC_FAILED;
-		goto cleanup_allocation;
+		goto err;
 	}
 	new_fcport->flags &= ~FCF_FABRIC_DEVICE;
 
@@ -5229,7 +5229,7 @@ qla2x00_configure_local_loop(scsi_qla_host_t *vha)
 				ql_log(ql_log_warn, vha, 0xd031,
 				    "Failed to allocate memory for fcport.\n");
 				rval = QLA_MEMORY_ALLOC_FAILED;
-				goto cleanup_allocation;
+				goto err;
 			}
 			spin_lock_irqsave(&vha->hw->tgt.sess_lock, flags);
 			new_fcport->flags &= ~FCF_FABRIC_DEVICE;
@@ -5272,15 +5272,14 @@ qla2x00_configure_local_loop(scsi_qla_host_t *vha)
 			qla24xx_fcport_handle_login(vha, fcport);
 	}
 
-cleanup_allocation:
 	qla2x00_free_fcport(new_fcport);
 
-	if (rval != QLA_SUCCESS) {
-		ql_dbg(ql_dbg_disc, vha, 0x2098,
-		    "Configure local loop error exit: rval=%x.\n", rval);
-	}
+	return rval;
 
-	return (rval);
+err:
+	ql_dbg(ql_dbg_disc, vha, 0x2098,
+	       "Configure local loop error exit: rval=%x.\n", rval);
+	return rval;
 }
 
 static void
Reviewed-by
#6 lore raw
Quoted 108 lines · Bart Van Assche
Quoted 3 lines · Ewan D. Milne

Yes, but isn't that after "if (new_fcport == NULL)" where the code has put the previously allocated fcport into the &vha->vp_fcports list and was unable to allocate another one?

How about the (untested) patch below?

Thanks,

Bart.

From 436e1552f79b3a3b7d3f3b1dea1df27c33bd0d49 Mon Sep 17 00:00:00 2001
From: Bart Van Assche <[email protected]>
Date: Sun, 12 Jan 2020 09:17:37 -0800
Subject: [PATCH v2] qla2xxx: Fix a NULL pointer dereference in an error path

This patch fixes the following Coverity complaint:

FORWARD_NULL

qla_init.c: 5275 in qla2x00_configure_local_loop() 5269

5270     		if (fcport->scan_state == QLA_FCPORT_FOUND)
5271     			qla24xx_fcport_handle_login(vha, fcport);
5272     	}

5273
5274 cleanup_allocation:

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 353340: (FORWARD_NULL)
Passing null pointer "new_fcport" to "qla2x00_free_fcport", which dereferences it.

5275 qla2x00_free_fcport(new_fcport);
5276

5277     	if (rval != QLA_SUCCESS) {
5278     		ql_dbg(ql_dbg_disc, vha, 0x2098,
5279     		    "Configure local loop error exit: rval=%x.\n", rval);
5280     	}
qla_init.c: 5275 in qla2x00_configure_local_loop()
5269
5270     		if (fcport->scan_state == QLA_FCPORT_FOUND)
5271     			qla24xx_fcport_handle_login(vha, fcport);
5272     	}

5273
5274 cleanup_allocation:

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 353340: (FORWARD_NULL)
Passing null pointer "new_fcport" to "qla2x00_free_fcport", which dereferences it.

5275 qla2x00_free_fcport(new_fcport);
5276

5277     	if (rval != QLA_SUCCESS) {
5278     		ql_dbg(ql_dbg_disc, vha, 0x2098,
5279     		    "Configure local loop error exit: rval=%x.\n", rval);
5280     	}
Cc Himanshu Madhani <[email protected]>
Cc Quinn Tran <[email protected]>
Cc Martin Wilck <[email protected]>
Cc Daniel Wagner <[email protected]>
Cc Roman Bolshakov <[email protected]>
Fixes 3dae220595ba ("scsi: qla2xxx: Use common routine to free fcport struct")
---
 drivers/scsi/qla2xxx/qla_init.c | 17 ++++++++---------
 1 file changed, 8 insertions(+), 9 deletions(-)
drivers/scsi/qla2xxx/qla_init.c +3 -8
index c4e087217484..62df78258269 100644
@@ -5109,7 +5109,7 @@ qla2x00_configure_local_loop(scsi_qla_host_t *vha)
 	rval = qla2x00_get_id_list(vha, ha->gid_list, ha->gid_list_dma,
 	    &entries);
 	if (rval != QLA_SUCCESS)
-		goto cleanup_allocation;
+		goto err;
 
 	ql_dbg(ql_dbg_disc, vha, 0x2011,
 	    "Entries in ID list (%d).\n", entries);
@@ -5139,7 +5139,7 @@ qla2x00_configure_local_loop(scsi_qla_host_t *vha)
 		ql_log(ql_log_warn, vha, 0x2012,
 		    "Memory allocation failed for fcport.\n");
 		rval = QLA_MEMORY_ALLOC_FAILED;
-		goto cleanup_allocation;
+		goto err;
 	}
 	new_fcport->flags &= ~FCF_FABRIC_DEVICE;
 
@@ -5229,7 +5229,7 @@ qla2x00_configure_local_loop(scsi_qla_host_t *vha)
 				ql_log(ql_log_warn, vha, 0xd031,
 				    "Failed to allocate memory for fcport.\n");
 				rval = QLA_MEMORY_ALLOC_FAILED;
-				goto cleanup_allocation;
+				goto err;
 			}
 			spin_lock_irqsave(&vha->hw->tgt.sess_lock, flags);
 			new_fcport->flags &= ~FCF_FABRIC_DEVICE;
@@ -5272,15 +5272,14 @@ qla2x00_configure_local_loop(scsi_qla_host_t *vha)
 			qla24xx_fcport_handle_login(vha, fcport);
 	}
 
-cleanup_allocation:
 	qla2x00_free_fcport(new_fcport);
 
-	if (rval != QLA_SUCCESS) {
-		ql_dbg(ql_dbg_disc, vha, 0x2098,
-		    "Configure local loop error exit: rval=%x.\n", rval);
-	}

drivers/scsi/qla2xxx/qla_init.c qla2x00_configure_local_loop(scsi_qla_host_t *vha) · line 5285

Quoted 10 lines
drivers/scsi/qla2xxx/qla_init.c +5 -1
+	return rval;
 
-	return (rval);
+err:
+	ql_dbg(ql_dbg_disc, vha, 0x2098,
+	       "Configure local loop error exit: rval=%x.\n", rval);
+	return rval;
 }
 
 static void

That looks fine. Thanks.

Reviewed-by on v1 1/1
#7 lore raw
In reply to Bart Van Assche
Quoted 29 lines · Bart Van Assche

This patch fixes the following Coverity complaint:

FORWARD_NULL

qla_init.c: 5275 in qla2x00_configure_local_loop() 5269

5270     		if (fcport->scan_state == QLA_FCPORT_FOUND)
5271     			qla24xx_fcport_handle_login(vha, fcport);
5272     	}

5273
5274 cleanup_allocation:

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 353340: (FORWARD_NULL)
Passing null pointer "new_fcport" to "qla2x00_free_fcport", which dereferences it.

5275 qla2x00_free_fcport(new_fcport);
5276

5277     	if (rval != QLA_SUCCESS) {
5278     		ql_dbg(ql_dbg_disc, vha, 0x2098,
5279     		    "Configure local loop error exit: rval=%x.\n", rval);
5280     	}
---
 drivers/scsi/qla2xxx/qla_init.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/scsi/qla2xxx/qla_init.c +0 -0
index c4e087217484..6560908ed50e 100644

drivers/scsi/qla2xxx/qla_init.c qla2x00_alloc_fcport(scsi_qla_host_t *vha, gfp_t flags) · line 4902

Quoted 8 lines
drivers/scsi/qla2xxx/qla_init.c +2 -0
@@ -4895,6 +4895,8 @@ qla2x00_alloc_fcport(scsi_qla_host_t *vha, gfp_t flags)
 void
 qla2x00_free_fcport(fc_port_t *fcport)
 {
+	if (!fcport)
+		return;
 	if (fcport->ct_desc.ct_sns) {
 		dma_free_coherent(&fcport->vha->hw->pdev->dev,
 			sizeof(struct ct_sns_pkt), fcport->ct_desc.ct_sns,

Hi Bart,

There was another attempt to fix the issue a week ago:
https://patchwork.kernel.org/patch/11319315/

CC'ing Colin.

Thanks,
Roman