staging/rdma/hfi1: Fix a possible null pointer dereference
Subsystems (3)
PATCH 1/1 staging/rdma/hfi1: Fix a possible null pointer dereference
From: Easwar Hariharan <[email protected]>
A code inspection pointed out that kmalloc_array may return NULL and memset doesn't check the input pointer for NULL, resulting in a possible NULL dereference. This patch fixes this.
--- drivers/staging/rdma/hfi1/chip.c | 2 ++ 1 file changed, 2 insertions(+)
drivers/staging/rdma/hfi1/chip.c +2 -0
@@ -10129,6 +10129,8 @@ static void init_qos(struct hfi1_devdata *dd, u32 first_ctxt)if (num_vls * qpns_per_vl > dd->chip_rcv_contexts) goto bail; rsmmap =kmalloc_array (NUM_MAP_REGS ,sizeof (u64),GFP_KERNEL ); +if (!rsmmap) + goto bail;memset (rsmmap, rxcontext,NUM_MAP_REGS *sizeof (u64));/* init the local copy of the table */ for (i =0 , ctxt = first_ctxt; i < num_vls; i++) {
PATCH 1/1 staging/rdma/hfi1: Fix a possible null pointer dereference
Quoted 17 lines · Mike Marciniszyn
From: Easwar Hariharan <[email protected]>
A code inspection pointed out that
kmalloc_arraymay return NULL and memset doesn't check the input pointer for NULL, resulting in a possible NULL dereference. This patch fixes this.Reviewed-by Mike Marciniszyn <[email protected]>Signed-off-by Easwar Hariharan <[email protected]>--- drivers/staging/rdma/hfi1/chip.c | 2 ++ 1 file changed, 2 insertions(+)drivers/staging/rdma/hfi1/chip.c +0
-0
drivers/staging/rdma/hfi1/chip.c static void init_qos(struct hfi1_devdata *dd, u32 first_ctxt)
Quoted 10 lines
drivers/staging/rdma/hfi1/chip.c +2
-1@@ -10129,6 +10129,8 @@ static void init_qos(struct hfi1_devdata *dd, u32 first_ctxt)if (num_vls * qpns_per_vl > dd->chip_rcv_contexts) goto bail; rsmmap =kmalloc_array (NUM_MAP_REGS ,sizeof (u64),GFP_KERNEL ); +if (!rsmmap) + goto bail;memset (rsmmap, rxcontext,NUM_MAP_REGS *sizeof (u64));/* init the local copy of the table */ for (i =0 , ctxt = first_ctxt; i < num_vls; i++) { --
Based on this report a generalization of unchecked use turned up one more case in the current kernel (patch sent). Probably the when block needs some cleanup, but findings like this definitely are a case for coccinelle scanners.
<snip>
/// check for missing NULL check before use
//
// missing check in: // ./drivers/staging/rdma/hfi1/chip.c:10131 unchecked allocation // in -next-20151214 // reported-by Mike Marciniszyn <[email protected]>
//
// after generalization this also found:
// ./drivers/clk/shmobile/clk-div6.c:197 unchecked allocation
virtual context
virtual org
virtual report
@badmemset@
expression mem;
position p;
statement S;
@@
<+...
*mem = kmalloc_array@p(...);
... when != if (!mem || ...) S
when != if (... && !mem) S
when != if (mem == NULL || ...) S
when != if (... && mem == NULL) S
when != if (unlikely(mem == NULL)) S
when != if (unlikely(!mem)) S
when != if (likely(!mem)) S
when != if (likely(mem == NULL)) S return;
...+>
@script:python@
p << badmemset.p;
@@
print "%s:%s unchecked allocation" % (p[0].file,p[0].line)
<snip>
thx!
hofrat
PATCH 1/1 staging/rdma/hfi1: Fix a possible null pointer dereference
Quoted 68 lines · Nicholas Mc Guire
Quoted 17 lines · Mike Marciniszyn
From: Easwar Hariharan <[email protected]>
A code inspection pointed out that
kmalloc_arraymay return NULL and memset doesn't check the input pointer for NULL, resulting in a possible NULL dereference. This patch fixes this.Reviewed-by Mike Marciniszyn <[email protected]>Signed-off-by Easwar Hariharan <[email protected]>--- drivers/staging/rdma/hfi1/chip.c | 2 ++ 1 file changed, 2 insertions(+)drivers/staging/rdma/hfi1/chip.c +0
-0drivers/staging/rdma/hfi1/chip.c static void init_qos(struct hfi1_devdata *dd, u32 first_ctxt)
Quoted 10 lines
drivers/staging/rdma/hfi1/chip.c +2
-1@@ -10129,6 +10129,8 @@ static void init_qos(struct hfi1_devdata *dd, u32 first_ctxt)if (num_vls * qpns_per_vl > dd->chip_rcv_contexts) goto bail; rsmmap =kmalloc_array (NUM_MAP_REGS ,sizeof (u64),GFP_KERNEL ); +if (!rsmmap) + goto bail;memset (rsmmap, rxcontext,NUM_MAP_REGS *sizeof (u64));/* init the local copy of the table */ for (i =0 , ctxt = first_ctxt; i < num_vls; i++) { --Based on this report a generalization of unchecked use turned up one more case in the current kernel (patch sent). Probably the when block needs some cleanup, but findings like this definitely are a case for coccinelle scanners.
<snip>
/// check for missing NULL check before use
//// missing check in: // ./drivers/staging/rdma/hfi1/chip.c:10131 unchecked allocation // in -next-20151214 // reported-by Mike Marciniszyn <[email protected]>//
// after generalization this also found:
//./drivers/clk/shmobile/clk-div6.c:197unchecked allocationvirtual context
virtual org
virtual report@badmemset@
expression mem;
position p;
statement S;
@@<+...
*mem =kmalloc_arrayat p(...);
... when != if (!mem || ...) Swhen != if (... && !mem) S when != if (mem == NULL || ...) S when != if (... && mem == NULL) S when != if (unlikely(mem == NULL)) S when != if (unlikely(!mem)) S when != if (likely(!mem)) S when != if (likely(mem == NULL)) Sreturn;
...+>
Quoted 7 lines
@script:python@
p << badmemset.p;
@@print "%s:%s unchecked allocation" % (p[0].file,p[0].line)
<snip>
How about the following? I got two hits with this, in drivers/clk/shmobile/clk-div6.c and drivers/staging/rdma/hfi1/chip.c.
@@
expression mem;
identifier f;
@@
*mem = kmalloc_array(...);
... when != mem == NULL
when != mem != NULL
(f(...,mem,...)
|mem->f
|
mem[...]
)
There is a semantic patch in the kernel called kmerr that goes in this direction, but it seems to be overly restrictive and it doesn't address this function:
/// This semantic patch looks for kmalloc etc that are not followed by a /// NULL check. It only gives a report in the case where there is some /// error handling code later in the function, which may be helpful /// in determining what the error handling code for the call to kmalloc etc /// should be.
Probably there are a lot of other functions that should be considered.
julia
PATCH 1/1 staging/rdma/hfi1: Fix a possible null pointer dereference
Quoted 88 lines · Julia Lawall
Quoted 68 lines · Nicholas Mc Guire
Quoted 17 lines · Mike Marciniszyn
From: Easwar Hariharan <[email protected]>
A code inspection pointed out that
kmalloc_arraymay return NULL and memset doesn't check the input pointer for NULL, resulting in a possible NULL dereference. This patch fixes this.Reviewed-by Mike Marciniszyn <[email protected]>Signed-off-by Easwar Hariharan <[email protected]>--- drivers/staging/rdma/hfi1/chip.c | 2 ++ 1 file changed, 2 insertions(+)drivers/staging/rdma/hfi1/chip.c +0
-0drivers/staging/rdma/hfi1/chip.c static void init_qos(struct hfi1_devdata *dd, u32 first_ctxt)
Quoted 10 lines
drivers/staging/rdma/hfi1/chip.c +2
-1@@ -10129,6 +10129,8 @@ static void init_qos(struct hfi1_devdata *dd, u32 first_ctxt)if (num_vls * qpns_per_vl > dd->chip_rcv_contexts) goto bail; rsmmap =kmalloc_array (NUM_MAP_REGS ,sizeof (u64),GFP_KERNEL ); +if (!rsmmap) + goto bail;memset (rsmmap, rxcontext,NUM_MAP_REGS *sizeof (u64));/* init the local copy of the table */ for (i =0 , ctxt = first_ctxt; i < num_vls; i++) { --Based on this report a generalization of unchecked use turned up one more case in the current kernel (patch sent). Probably the when block needs some cleanup, but findings like this definitely are a case for coccinelle scanners.
<snip>
/// check for missing NULL check before use
//// missing check in: // ./drivers/staging/rdma/hfi1/chip.c:10131 unchecked allocation // in -next-20151214 // reported-by Mike Marciniszyn <[email protected]>//
// after generalization this also found:
//./drivers/clk/shmobile/clk-div6.c:197unchecked allocationvirtual context
virtual org
virtual report@badmemset@
expression mem;
position p;
statement S;
@@<+...
*mem =kmalloc_arrayat p(...);
... when != if (!mem || ...) Swhen != if (... && !mem) S when != if (mem == NULL || ...) S when != if (... && mem == NULL) S when != if (unlikely(mem == NULL)) S when != if (unlikely(!mem)) S when != if (likely(!mem)) S when != if (likely(mem == NULL)) Sreturn;
...+>Quoted 7 lines
@script:python@
p << badmemset.p;
@@print "%s:%s unchecked allocation" % (p[0].file,p[0].line)
<snip>
How about the following? I got two hits with this, in
drivers/clk/shmobile/clk-div6.canddrivers/staging/rdma/hfi1/chip.c.@@
expression mem;
identifier f;
@@
Quoted 4 lines
*mem =
kmalloc_array(...);
... when != mem == NULLwhen != mem != NULL(
works perfectly for this case - thanks
I actually initially used the "template" from api/alloc/kzalloc-simple.cocci but that did not catch all cases for the kmalloc_array scanner. Poping your proposal into kzalloc-simple.cocci seems to be finding quite a few additional cases will review them to see if there are any false positives - but a first scan did show that most of the reported cases seem to be valid.
thx!
hofrat
PATCH 1/1 staging/rdma/hfi1: Fix a possible null pointer dereference
Here is my proposition for finding missing NULL tests. I tried to limit it to generic kmalloc like functions. There are of course many other NULL returning functions, but maybe they could be in an other rule,
julia
---
/// Look for kmalloc etc that are not followed by a NULL check. //# May give a false positive when the dereference is an argument of sizeof, or //# when the value is passed to another function that returns an error code. ///
// Confidence: Moderate
// Copyright: (C) 2015 Julia Lawall, Inria. GPLv2.
// URL: http://coccinelle.lip6.fr/
// Options: --no-includes --include-headers
virtual context
virtual org
virtual report
@ok forall@
expression x;
position p;
statement S1,S2;
@@
(
x =@p \(vmalloc\|kmalloc\|kzalloc\|kcalloc\|kmem_cache_alloc\|krealloc\|
kmemdup\|kstrdup\|devm_kzalloc\|devm_kmalloc\|devm_kcalloc\|
devm_kasprintf\|devm_kstrdup\|kmalloc_array\)
(...,<+... __GFP_NOFAIL ...+>,...);
|
x =@p \(vmalloc\|kmalloc\|kzalloc\|kcalloc\|kmem_cache_alloc\|krealloc\|
kmemdup\|kstrdup\|devm_kzalloc\|devm_kmalloc\|devm_kcalloc\|
devm_kasprintf\|devm_kstrdup\|kmalloc_array\)(...)... when != x
(
if (x || ...) S1 else S2
|
(x) == NULL
|
(x) != NULL
|
(x) == 0
|
(x) != 0
)
)
// ----------------------------------------------------------------------------
@err depends on context || org || report exists@
identifier fld;
position p != ok.p;
expression x, y;
position j0, j1, j2;
@@
* x at j0 =@p \(vmalloc at j1\|kmalloc at j1\|kzalloc at j1\|kcalloc at j1\| kmem_cache_alloc at j1\|krealloc at j1\|kmemdup at j1\|kstrdup at j1\| devm_kzalloc at j1\|devm_kmalloc at j1\|devm_kcalloc at j1\| devm_kasprintf at j1\|devm_kstrdup at j1\|kmalloc_array at j1\)(...); ... when != (x) == NULL
when != (x) != NULL
when != (x) == 0
when != (x) != 0
when != x = y(
x at j2->fld
|
*x at j2
|
x at j2[...]
)
// ----------------------------------------------------------------------------
@script:python err_org depends on org@
j0 << err.j0;
j1 << err.j1;
j2 << err.j2;
@@
msg = "NULL test needed."coccilib.org.print_todo(j0[0], msg)coccilib.org.print_link(j1[0], "")coccilib.org.print_link(j2[0], "")
// ----------------------------------------------------------------------------
@script:python err_report depends on report@
j0 << err.j0;
j1 << err.j1;
j2 << err.j2;
@@
msg = "NULL test needed, around lines %s,%s." % (j1[0].line,j2[0].line) coccilib.report.print_report(j0[0], msg)