clk: fix invalid usage of list_for_each_entry cursor
PATCH 1/1 clk: fix invalid usage of list_for_each_entry cursor
Fix invalid usage of list_for_each_entry cursor. When list is empty then list cursor does not point to a valid entry and therefore should not be used.
The issue was dicovered when running 5.12-rc1 kernel on x86_64 with KASAN enabled:
BUG: KASAN: global-out-of-bounds in clk_notifier_register+0xab/0x230
Read of size 8 at addr ffffffffa0d10588 by task swapper/0/1
CPU: 1 PID: 1 Comm: swapper/0 Not tainted 5.12.0-rc1 #1
Hardware name: Google Caroline/Caroline,
BIOS Google_Caroline.7820.430.0 07/20/2018
Call Trace:
dump_stack+0xee/0x15c
print_address_description+0x1e/0x2dc
kasan_report+0x188/0x1ce
? clk_notifier_register+0xab/0x230
? clk_prepare_lock+0x15/0x7b
? clk_notifier_register+0xab/0x230
clk_notifier_register+0xab/0x230
dw8250_probe+0xc01/0x10d4
...
Memory state around the buggy address:
ffffffffa0d10480: 00 00 00 00 00 03 f9 f9 f9 f9 f9 f9 00 00 00 00
ffffffffa0d10500: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 f9 f9
>ffffffffa0d10580: f9 f9 f9 f9 00 00 00 00 00 00 00 00 00 00 00 00
^
ffffffffa0d10600: 00 00 00 00 00 00 f9 f9 f9 f9 f9 f9 00 00 00 00
ffffffffa0d10680: 00 00 00 00 00 00 00 00 f9 f9 f9 f9 00 00 00 00
==================================================================--- drivers/clk/clk.c | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-)
drivers/clk/clk.c +14 -6
@@ -4360,6 +4360,7 @@ int clk_notifier_register(struct clk *clk, struct notifier_block *nb) {struct clk_notifier *cn;int ret = -ENOMEM ; +bool entry_found = false;if (!clk || !nb)return -EINVAL ;
@@ -4367,12 +4368,15 @@ int clk_notifier_register(struct clk *clk, struct notifier_block *nb)clk_prepare_lock ();/* search the list of notifiers for this clk */ -list_for_each_entry (cn, &clk_notifier_list, node) -if (cn->clk == clk) +list_for_each_entry (cn, &clk_notifier_list, node) { +if (cn->clk == clk) { + entry_found = true;break ; + } + }/* if clk wasn't in the notifier list, allocate new clk_notifier */ -if (cn->clk != clk) { +if (!entry_found) { cn =kzalloc (sizeof (*cn),GFP_KERNEL );if (!cn) goto out;
@@ -4409,17 +4413,21 @@ int clk_notifier_unregister(struct clk *clk, struct notifier_block *nb) {struct clk_notifier *cn =NULL ;int ret = -EINVAL ; +bool entry_found = false;if (!clk || !nb)return -EINVAL ;clk_prepare_lock (); -list_for_each_entry (cn, &clk_notifier_list, node) -if (cn->clk == clk) +list_for_each_entry (cn, &clk_notifier_list, node) { +if (cn->clk == clk) { + entry_found = true;break ; + } + } -if (cn->clk == clk) { +if (entry_found) { ret =srcu_notifier_chain_unregister (&cn->notifier_head, nb); clk->core->notifier_count--;
Signature · 1 line
2.17.1
Stephen Boyd
maintainerQuoting Lukasz Bartosik (2021-03-05 11:13:07)
Quoted 31 lines
Fix invalid usage of
list_for_each_entrycursor. When list is empty then list cursor does not point to a valid entry and therefore should not be used.The issue was dicovered when running 5.12-rc1 kernel on
x86_64with KASAN enabled:BUG: KASAN: global-out-of-bounds in clk_notifier_register+0xab/0x230 Read of size 8 at addr ffffffffa0d10588 by task swapper/0/1 CPU: 1 PID: 1 Comm: swapper/0 Not tainted 5.12.0-rc1 #1 Hardware name: Google Caroline/Caroline, BIOS Google_Caroline.7820.430.0 07/20/2018 Call Trace: dump_stack+0xee/0x15c print_address_description+0x1e/0x2dc kasan_report+0x188/0x1ce ? clk_notifier_register+0xab/0x230 ? clk_prepare_lock+0x15/0x7b ? clk_notifier_register+0xab/0x230 clk_notifier_register+0xab/0x230 dw8250_probe+0xc01/0x10d4 ... Memory state around the buggy address: ffffffffa0d10480: 00 00 00 00 00 03 f9 f9 f9 f9 f9 f9 00 00 00 00 ffffffffa0d10500: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 f9 f9 >ffffffffa0d10580: f9 f9 f9 f9 00 00 00 00 00 00 00 00 00 00 00 00 ^ ffffffffa0d10600: 00 00 00 00 00 00 f9 f9 f9 f9 f9 f9 00 00 00 00 ffffffffa0d10680: 00 00 00 00 00 00 00 00 f9 f9 f9 f9 00 00 00 00 ==================================================================
Quoted 1 line
Fixes (b2476490ef11 clk: introduce the common clock framework)
This fixes format is wrong. Use pretty format of 'Fixes: %h "%s"'
Quoted 1 line
And this newline shouldn't be here.
Quoted 27 lines
Reported-by Lukasz Majczak <[email protected]>Signed-off-by Lukasz Bartosik <[email protected]>--- drivers/clk/clk.c | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-)drivers/clk/clk.c +4
-2@@ -4360,6 +4360,7 @@ int clk_notifier_register(struct clk *clk, struct notifier_block *nb) {struct clk_notifier *cn;int ret = -ENOMEM ; +bool entry_found = false;if (!clk || !nb)return -EINVAL ;@@ -4367,12 +4368,15 @@ int clk_notifier_register(struct clk *clk, struct notifier_block *nb)clk_prepare_lock ();/* search the list of notifiers for this clk */ -list_for_each_entry (cn, &clk_notifier_list, node) -if (cn->clk == clk) +list_for_each_entry (cn, &clk_notifier_list, node) { +if (cn->clk == clk) { + entry_found = true;
drivers/clk/clk.c int clk_notifier_register(struct clk *clk, struct notifier_block *nb) · line 4382
Quoted 10 lines
drivers/clk/clk.c +3
-1break ; + } + }/* if clk wasn't in the notifier list, allocate new clk_notifier */ -if (cn->clk != clk) { +if (!entry_found) { cn =kzalloc (sizeof (*cn),GFP_KERNEL );if (!cn) goto out;
How about using list_empty()?
if (list_empty() || cn->clk != clk)
Then the diff is very small.
Quoted 28 lines
Quoting Lukasz Bartosik (2021-03-05 11:13:07)
Quoted 26 lines
Fix invalid usage of
list_for_each_entrycursor. When list is empty then list cursor does not point to a valid entry and therefore should not be used.The issue was dicovered when running 5.12-rc1 kernel on
x86_64with KASAN enabled:BUG: KASAN: global-out-of-bounds in clk_notifier_register+0xab/0x230 Read of size 8 at addr ffffffffa0d10588 by task swapper/0/1 CPU: 1 PID: 1 Comm: swapper/0 Not tainted 5.12.0-rc1 #1 Hardware name: Google Caroline/Caroline, BIOS Google_Caroline.7820.430.0 07/20/2018 Call Trace: dump_stack+0xee/0x15c print_address_description+0x1e/0x2dc kasan_report+0x188/0x1ce ? clk_notifier_register+0xab/0x230 ? clk_prepare_lock+0x15/0x7b ? clk_notifier_register+0xab/0x230 clk_notifier_register+0xab/0x230 dw8250_probe+0xc01/0x10d4 ... Memory state around the buggy address: ffffffffa0d10480: 00 00 00 00 00 03 f9 f9 f9 f9 f9 f9 00 00 00 00 ffffffffa0d10500: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 f9 f9 >ffffffffa0d10580: f9 f9 f9 f9 00 00 00 00 00 00 00 00 00 00 00 00
Quoted 9 lines
Quoted 6 lines
^
ffffffffa0d10600: 00 00 00 00 00 00 f9 f9 f9 f9 f9 f9 00 00 00 00
ffffffffa0d10680: 00 00 00 00 00 00 00 00 f9 f9 f9 f9 00 00 00 00
==================================================================Fixes (b2476490ef11 clk: introduce the common clock framework)This fixes format is wrong. Use pretty format of 'Fixes: %h "%s"'
Just to clarify. Shouldn't the format be 'Fixes: %h (\"%s\")' as described in https://www.kernel.org/doc/html/v5.11/process/submitting-patches.html
?
Quoted 4 lines
Quoted 1 line
And this newline shouldn't be here.
I will remove the newline.
Quoted 40 lines
Quoted 27 lines
Reported-by Lukasz Majczak <[email protected]>Signed-off-by Lukasz Bartosik <[email protected]>--- drivers/clk/clk.c | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-)drivers/clk/clk.c +4
-2@@ -4360,6 +4360,7 @@ int clk_notifier_register(struct clk *clk, struct notifier_block *nb) {struct clk_notifier *cn;int ret = -ENOMEM ; +bool entry_found = false;if (!clk || !nb)return -EINVAL ;@@ -4367,12 +4368,15 @@ int clk_notifier_register(struct clk *clk, struct notifier_block *nb)clk_prepare_lock ();/* search the list of notifiers for this clk */ -list_for_each_entry (cn, &clk_notifier_list, node) -if (cn->clk == clk) +list_for_each_entry (cn, &clk_notifier_list, node) { +if (cn->clk == clk) { + entry_found = true;drivers/clk/clk.c int clk_notifier_register(struct clk *clk, struct notifier_block *nb) · line 4382
Quoted 10 lines
drivers/clk/clk.c +3
-1break ; + } + }/* if clk wasn't in the notifier list, allocate new clk_notifier */ -if (cn->clk != clk) { +if (!entry_found) { cn =kzalloc (sizeof (*cn),GFP_KERNEL );if (!cn) goto out;How about using
list_empty()?
Quoted 3 lines
if (list_empty() || cn->clk != clk)Then the diff is very small.
Good point. I will use list_empty(). Thanks
Quoted 90 lines
Quoted 29 lines
Quoting Lukasz Bartosik (2021-03-05 11:13:07)
Quoted 26 lines
Fix invalid usage of
list_for_each_entrycursor. When list is empty then list cursor does not point to a valid entry and therefore should not be used.The issue was dicovered when running 5.12-rc1 kernel on
x86_64with KASAN enabled:BUG: KASAN: global-out-of-bounds in clk_notifier_register+0xab/0x230 Read of size 8 at addr ffffffffa0d10588 by task swapper/0/1 CPU: 1 PID: 1 Comm: swapper/0 Not tainted 5.12.0-rc1 #1 Hardware name: Google Caroline/Caroline, BIOS Google_Caroline.7820.430.0 07/20/2018 Call Trace: dump_stack+0xee/0x15c print_address_description+0x1e/0x2dc kasan_report+0x188/0x1ce ? clk_notifier_register+0xab/0x230 ? clk_prepare_lock+0x15/0x7b ? clk_notifier_register+0xab/0x230 clk_notifier_register+0xab/0x230 dw8250_probe+0xc01/0x10d4 ... Memory state around the buggy address: ffffffffa0d10480: 00 00 00 00 00 03 f9 f9 f9 f9 f9 f9 00 00 00 00 ffffffffa0d10500: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 f9 f9 >ffffffffa0d10580: f9 f9 f9 f9 00 00 00 00 00 00 00 00 00 00 00 00Quoted 9 lines
Quoted 6 lines
^
ffffffffa0d10600: 00 00 00 00 00 00 f9 f9 f9 f9 f9 f9 00 00 00 00
ffffffffa0d10680: 00 00 00 00 00 00 00 00 f9 f9 f9 f9 00 00 00 00
==================================================================Fixes (b2476490ef11 clk: introduce the common clock framework)This fixes format is wrong. Use pretty format of 'Fixes: %h "%s"'
Just to clarify. Shouldn't the format be 'Fixes: %h (\"%s\")' as described in https://www.kernel.org/doc/html/v5.11/process/submitting-patches.html
?Quoted 4 lines
Quoted 1 line
And this newline shouldn't be here.
I will remove the newline.
Quoted 40 lines
Quoted 27 lines
Reported-by Lukasz Majczak <[email protected]>Signed-off-by Lukasz Bartosik <[email protected]>--- drivers/clk/clk.c | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-)drivers/clk/clk.c +4
-2@@ -4360,6 +4360,7 @@ int clk_notifier_register(struct clk *clk, struct notifier_block *nb) {struct clk_notifier *cn;int ret = -ENOMEM ; +bool entry_found = false;if (!clk || !nb)return -EINVAL ;@@ -4367,12 +4368,15 @@ int clk_notifier_register(struct clk *clk, struct notifier_block *nb)clk_prepare_lock ();/* search the list of notifiers for this clk */ -list_for_each_entry (cn, &clk_notifier_list, node) -if (cn->clk == clk) +list_for_each_entry (cn, &clk_notifier_list, node) { +if (cn->clk == clk) { + entry_found = true;drivers/clk/clk.c int clk_notifier_register(struct clk *clk, struct notifier_block *nb) · line 4382
Quoted 10 lines
drivers/clk/clk.c +3
-1break ; + } + }/* if clk wasn't in the notifier list, allocate new clk_notifier */ -if (cn->clk != clk) { +if (!entry_found) { cn =kzalloc (sizeof (*cn),GFP_KERNEL );if (!cn) goto out;How about using
list_empty()?
Quoted 5 lines
Quoted 3 lines
if (list_empty() || cn->clk != clk)Then the diff is very small.
Good point. I will use
list_empty(). Thanks
Although your comment was appealing to make the diff neat and small I realized it won't work after making the changes.
Looking at the original code:
/* search the list of notifiers for this clk */
list_for_each_entry(cn, &clk_notifier_list, node)
if (cn->clk == clk)
break;
/* if clk wasn't in the notifier list, allocate new clk_notifier */
if (cn->clk != clk) {The list cursor (cn) in the comparison above will not be pointing to a valid entry not only when the clk_notifier_list is empty but also in the case when clk_notifier_list list was completely traversed without breaking from the list_for_each_entry loop on one of the entries. Therefore making the comparison
if (list_empty() || cn->clk != clk) {will not help because if the list is not empty and there was no match cn will not point to a valid entry. I have not noticed that before. Based on that I propose to stay with my original fix.
Stephen Boyd
maintainerQuoted 26 lines
Quoted 8 lines
Quoted 6 lines
How about using
list_empty()?if (list_empty() || cn->clk != clk)Then the diff is very small.
Good point. I will use
list_empty(). ThanksAlthough your comment was appealing to make the diff neat and small I realized it won't work after making the changes.
Looking at the original code:/* search the list of notifiers for this clk */ list_for_each_entry(cn, &clk_notifier_list, node) if (cn->clk == clk) break; /* if clk wasn't in the notifier list, allocate new clk_notifier */ if (cn->clk != clk) {The list cursor (cn) in the comparison above will not be pointing to a valid entry not only when the
clk_notifier_listis empty but also in the case whenclk_notifier_listlist was completely traversed without breaking from thelist_for_each_entryloop on one of the entries. Therefore making the comparison
Quoted 5 lines
if (list_empty() || cn->clk != clk) {will not help because if the list is not empty and there was no match cn will not point to a valid entry. I have not noticed that before. Based on that I propose to stay with my original fix.
Ok, so then use 'goto found' approach?
----8<----
drivers/clk/clk.c +8 -9
@@ -4357,20 +4357,19 @@ int clk_notifier_register(struct clk *clk, struct notifier_block *nb)/* search the list of notifiers for this clk */ list_for_each_entry (cn, &clk_notifier_list, node)if (cn->clk == clk) -break ; + goto found;/* if clk wasn't in the notifier list, allocate new clk_notifier */ -if (cn->clk != clk) { - cn =kzalloc (sizeof (*cn),GFP_KERNEL ); -if (!cn) - goto out; + cn =kzalloc (sizeof (*cn),GFP_KERNEL ); +if (!cn) + goto out; - cn->clk = clk; -srcu_init_notifier_head (&cn->notifier_head); + cn->clk = clk; +srcu_init_notifier_head (&cn->notifier_head); -list_add (&cn->node, &clk_notifier_list); - } +list_add (&cn->node, &clk_notifier_list); +found: ret =srcu_notifier_chain_register (&cn->notifier_head, nb); clk->core->notifier_count++;
Quoted 27 lines
Quoted 27 lines
Quoted 9 lines
Quoted 7 lines
How about using
list_empty()?if (list_empty() || cn->clk != clk)Then the diff is very small.
Good point. I will use
list_empty(). ThanksAlthough your comment was appealing to make the diff neat and small I realized it won't work after making the changes.
Looking at the original code:/* search the list of notifiers for this clk */ list_for_each_entry(cn, &clk_notifier_list, node) if (cn->clk == clk) break; /* if clk wasn't in the notifier list, allocate new clk_notifier */ if (cn->clk != clk) {The list cursor (cn) in the comparison above will not be pointing to a valid entry not only when the
clk_notifier_listis empty but also in the case whenclk_notifier_listlist was completely traversed without breaking from thelist_for_each_entryloop on one of the entries. Therefore making the comparison
Quoted 8 lines
Quoted 5 lines
if (list_empty() || cn->clk != clk) {will not help because if the list is not empty and there was no match cn will not point to a valid entry. I have not noticed that before. Based on that I propose to stay with my original fix.
Ok, so then use 'goto found' approach?
I will use goto approach and send v3 patch.
Quoted 34 lines
----8<----
drivers/clk/clk.c +8
-9@@ -4357,20 +4357,19 @@ int clk_notifier_register(struct clk *clk, struct notifier_block *nb)/* search the list of notifiers for this clk */ list_for_each_entry (cn, &clk_notifier_list, node)if (cn->clk == clk) -break ; + goto found;/* if clk wasn't in the notifier list, allocate new clk_notifier */ -if (cn->clk != clk) { - cn =kzalloc (sizeof (*cn),GFP_KERNEL ); -if (!cn) - goto out; + cn =kzalloc (sizeof (*cn),GFP_KERNEL ); +if (!cn) + goto out; - cn->clk = clk; -srcu_init_notifier_head (&cn->notifier_head); + cn->clk = clk; +srcu_init_notifier_head (&cn->notifier_head); -list_add (&cn->node, &clk_notifier_list); - } +list_add (&cn->node, &clk_notifier_list); +found: ret =srcu_notifier_chain_register (&cn->notifier_head, nb); clk->core->notifier_count++;
PATCH v2 1/1 clk: fix invalid usage of a list_for_each_entry cursor
In reply to Lukasz BartosikFix invalid usage of a list_for_each_entry cursor. When list is empty or if the list is completely traversed (without breaking from the loop on one of the entries) then the list cursor does not point to a valid entry and therefore should not be used.
The issue was dicovered when running 5.12-rc1 kernel on x86_64 with KASAN enabled:
BUG: KASAN: global-out-of-bounds in clk_notifier_register+0xab/0x230
Read of size 8 at addr ffffffffa0d10588 by task swapper/0/1
CPU: 1 PID: 1 Comm: swapper/0 Not tainted 5.12.0-rc1 #1
Hardware name: Google Caroline/Caroline,
BIOS Google_Caroline.7820.430.0 07/20/2018
Call Trace:
dump_stack+0xee/0x15c
print_address_description+0x1e/0x2dc
kasan_report+0x188/0x1ce
? clk_notifier_register+0xab/0x230
? clk_prepare_lock+0x15/0x7b
? clk_notifier_register+0xab/0x230
clk_notifier_register+0xab/0x230
dw8250_probe+0xc01/0x10d4
...
Memory state around the buggy address:
ffffffffa0d10480: 00 00 00 00 00 03 f9 f9 f9 f9 f9 f9 00 00 00 00
ffffffffa0d10500: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 f9 f9
>ffffffffa0d10580: f9 f9 f9 f9 00 00 00 00 00 00 00 00 00 00 00 00
^
ffffffffa0d10600: 00 00 00 00 00 00 f9 f9 f9 f9 f9 f9 00 00 00 00
ffffffffa0d10680: 00 00 00 00 00 00 00 00 f9 f9 f9 f9 00 00 00 00
==================================================================--- drivers/clk/clk.c | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-)
drivers/clk/clk.c +14 -6
@@ -4336,6 +4336,7 @@ int clk_notifier_register(struct clk *clk, struct notifier_block *nb) {struct clk_notifier *cn;int ret = -ENOMEM ; +bool entry_found = false;if (!clk || !nb)return -EINVAL ;
@@ -4343,12 +4344,15 @@ int clk_notifier_register(struct clk *clk, struct notifier_block *nb)clk_prepare_lock ();/* search the list of notifiers for this clk */ -list_for_each_entry (cn, &clk_notifier_list, node) -if (cn->clk == clk) +list_for_each_entry (cn, &clk_notifier_list, node) { +if (cn->clk == clk) { + entry_found = true;break ; + } + }/* if clk wasn't in the notifier list, allocate new clk_notifier */ -if (cn->clk != clk) { +if (!entry_found) { cn =kzalloc (sizeof (*cn),GFP_KERNEL );if (!cn) goto out;
@@ -4385,17 +4389,21 @@ int clk_notifier_unregister(struct clk *clk, struct notifier_block *nb) {struct clk_notifier *cn =NULL ;int ret = -EINVAL ; +bool entry_found = false;if (!clk || !nb)return -EINVAL ;clk_prepare_lock (); -list_for_each_entry (cn, &clk_notifier_list, node) -if (cn->clk == clk) +list_for_each_entry (cn, &clk_notifier_list, node) { +if (cn->clk == clk) { + entry_found = true;break ; + } + } -if (cn->clk == clk) { +if (entry_found) { ret =srcu_notifier_chain_unregister (&cn->notifier_head, nb); clk->core->notifier_count--;
Signature · 1 line
2.17.1
PATCH v3 1/1 clk: fix invalid usage of a list_for_each_entry cursor
Fix invalid usage of a list_for_each_entry cursor. When list is empty or if the list is completely traversed (without breaking from the loop on one of the entries) then the list cursor does not point to a valid entry and therefore should not be used.
The issue was dicovered when running 5.12-rc1 kernel on x86_64 with KASAN enabled:
BUG: KASAN: global-out-of-bounds in clk_notifier_register+0xab/0x230
Read of size 8 at addr ffffffffa0d10588 by task swapper/0/1
CPU: 1 PID: 1 Comm: swapper/0 Not tainted 5.12.0-rc1 #1
Hardware name: Google Caroline/Caroline,
BIOS Google_Caroline.7820.430.0 07/20/2018
Call Trace:
dump_stack+0xee/0x15c
print_address_description+0x1e/0x2dc
kasan_report+0x188/0x1ce
? clk_notifier_register+0xab/0x230
? clk_prepare_lock+0x15/0x7b
? clk_notifier_register+0xab/0x230
clk_notifier_register+0xab/0x230
dw8250_probe+0xc01/0x10d4
...
Memory state around the buggy address:
ffffffffa0d10480: 00 00 00 00 00 03 f9 f9 f9 f9 f9 f9 00 00 00 00
ffffffffa0d10500: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 f9 f9
>ffffffffa0d10580: f9 f9 f9 f9 00 00 00 00 00 00 00 00 00 00 00 00
^
ffffffffa0d10600: 00 00 00 00 00 00 f9 f9 f9 f9 f9 f9 00 00 00 00
ffffffffa0d10680: 00 00 00 00 00 00 00 00 f9 f9 f9 f9 00 00 00 00
==================================================================--- drivers/clk/clk.c | 41 ++++++++++++++++++++--------------------- 1 file changed, 20 insertions(+), 21 deletions(-)
drivers/clk/clk.c +20 -21
@@ -4345,20 +4345,19 @@ int clk_notifier_register(struct clk *clk, struct notifier_block *nb)/* search the list of notifiers for this clk */ list_for_each_entry (cn, &clk_notifier_list, node)if (cn->clk == clk) -break ; + goto found;/* if clk wasn't in the notifier list, allocate new clk_notifier */ -if (cn->clk != clk) { - cn =kzalloc (sizeof (*cn),GFP_KERNEL ); -if (!cn) - goto out; + cn =kzalloc (sizeof (*cn),GFP_KERNEL ); +if (!cn) + goto out; - cn->clk = clk; -srcu_init_notifier_head (&cn->notifier_head); + cn->clk = clk; +srcu_init_notifier_head (&cn->notifier_head); -list_add (&cn->node, &clk_notifier_list); - } +list_add (&cn->node, &clk_notifier_list); +found: ret =srcu_notifier_chain_register (&cn->notifier_head, nb); clk->core->notifier_count++;
@@ -4393,24 +4392,24 @@ int clk_notifier_unregister(struct clk *clk, struct notifier_block *nb)list_for_each_entry (cn, &clk_notifier_list, node)if (cn->clk == clk) -break ; + goto found; -if (cn->clk == clk) { - ret =srcu_notifier_chain_unregister (&cn->notifier_head, nb); + ret = -ENOENT ; + goto out; - clk->core->notifier_count--; +found: + ret =srcu_notifier_chain_unregister (&cn->notifier_head, nb); -/* XXX the notifier code should handle this better */ -if (!cn->notifier_head.head) { -srcu_cleanup_notifier_head (&cn->notifier_head); -list_del (&cn->node); -kfree (cn); - } + clk->core->notifier_count--; - }else { - ret = -ENOENT ; +/* XXX the notifier code should handle this better */ +if (!cn->notifier_head.head) { +srcu_cleanup_notifier_head (&cn->notifier_head); +list_del (&cn->node); +kfree (cn); } +out:clk_prepare_unlock ();return ret;
Signature · 1 line
2.17.1
Stephen Boyd
maintainerRe: [PATCH v3] clk: fix invalid usage of a list_for_each_entry cursor
Quoting Lukasz Bartosik (2021-03-31 08:58:22)
Quoted 33 lines
Fix invalid usage of a
list_for_each_entrycursor. When list is empty or if the list is completely traversed (without breaking from the loop on one of the entries) then the list cursor does not point to a valid entry and therefore should not be used.The issue was dicovered when running 5.12-rc1 kernel on
x86_64with KASAN enabled:BUG: KASAN: global-out-of-bounds in clk_notifier_register+0xab/0x230 Read of size 8 at addr ffffffffa0d10588 by task swapper/0/1 CPU: 1 PID: 1 Comm: swapper/0 Not tainted 5.12.0-rc1 #1 Hardware name: Google Caroline/Caroline, BIOS Google_Caroline.7820.430.0 07/20/2018 Call Trace: dump_stack+0xee/0x15c print_address_description+0x1e/0x2dc kasan_report+0x188/0x1ce ? clk_notifier_register+0xab/0x230 ? clk_prepare_lock+0x15/0x7b ? clk_notifier_register+0xab/0x230 clk_notifier_register+0xab/0x230 dw8250_probe+0xc01/0x10d4 ... Memory state around the buggy address: ffffffffa0d10480: 00 00 00 00 00 03 f9 f9 f9 f9 f9 f9 00 00 00 00 ffffffffa0d10500: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 f9 f9 >ffffffffa0d10580: f9 f9 f9 f9 00 00 00 00 00 00 00 00 00 00 00 00 ^ ffffffffa0d10600: 00 00 00 00 00 00 f9 f9 f9 f9 f9 f9 00 00 00 00 ffffffffa0d10680: 00 00 00 00 00 00 00 00 f9 f9 f9 f9 00 00 00 00 ==================================================================
Quoted 4 lines
Fixes b2476490ef11 ("clk: introduce the common clock framework")Reported-by Lukasz Majczak <[email protected]>Signed-off-by Lukasz Bartosik <[email protected]>---
Please stop sending these as replies to previous versions.
Quoted 26 lines
drivers/clk/clk.c | 41 ++++++++++++++++++++--------------------- 1 file changed, 20 insertions(+), 21 deletions(-)drivers/clk/clk.c +5
-7@@ -4345,20 +4345,19 @@ int clk_notifier_register(struct clk *clk, struct notifier_block *nb)/* search the list of notifiers for this clk */ list_for_each_entry (cn, &clk_notifier_list, node)if (cn->clk == clk) -break ; + goto found;/* if clk wasn't in the notifier list, allocate new clk_notifier */ -if (cn->clk != clk) { - cn =kzalloc (sizeof (*cn),GFP_KERNEL ); -if (!cn) - goto out; + cn =kzalloc (sizeof (*cn),GFP_KERNEL ); +if (!cn) + goto out; - cn->clk = clk; -srcu_init_notifier_head (&cn->notifier_head); + cn->clk = clk;
drivers/clk/clk.c int clk_notifier_register(struct clk *clk, struct notifier_block *nb) · line 4363
Quoted 10 lines
drivers/clk/clk.c +3
-2+srcu_init_notifier_head (&cn->notifier_head); -list_add (&cn->node, &clk_notifier_list); - } +list_add (&cn->node, &clk_notifier_list); +found: ret =srcu_notifier_chain_register (&cn->notifier_head, nb); clk->core->notifier_count++;
This part looks good.
Quoted 5 lines
drivers/clk/clk.c +0
-1@@ -4393,24 +4392,24 @@ int clk_notifier_unregister(struct clk *clk, struct notifier_block *nb)list_for_each_entry (cn, &clk_notifier_list, node)if (cn->clk == clk) -break ;
drivers/clk/clk.c int clk_notifier_unregister(struct clk *clk, struct notifier_block *nb) · line 4401
Quoted 10 lines
drivers/clk/clk.c +5
-3+ goto found; -if (cn->clk == clk) { - ret =srcu_notifier_chain_unregister (&cn->notifier_head, nb); + ret = -ENOENT ; + goto out; - clk->core->notifier_count--; +found: + ret =srcu_notifier_chain_unregister (&cn->notifier_head, nb);
But then this part looks awful!
Quoted 12 lines
drivers/clk/clk.c +2
-8-/* XXX the notifier code should handle this better */ -if (!cn->notifier_head.head) { -srcu_cleanup_notifier_head (&cn->notifier_head); -list_del (&cn->node); -kfree (cn); - } + clk->core->notifier_count--; - }else { - ret = -ENOENT ; +/* XXX the notifier code should handle this better */
drivers/clk/clk.c int clk_notifier_unregister(struct clk *clk, struct notifier_block *nb) · line 4414
Quoted 10 lines
drivers/clk/clk.c +5
-0+if (!cn->notifier_head.head) { +srcu_cleanup_notifier_head (&cn->notifier_head); +list_del (&cn->node); +kfree (cn); } +out:clk_prepare_unlock ();return ret;
Can we do this? Also, please split this part to a different patch that we don't need to send back to stable trees. Presumably drivers aren't calling the unregister function on an empty list or one that doesn't contain the clk they're interested in because something should be registered already by the register function.
Of course, the kernel-doc comment is also incorrect. We need to get rid of this notifier code. Sigh.
---8<---
drivers/clk/clk.c +13 -17
@@ -4395,32 +4395,28 @@ EXPORT_SYMBOL_GPL(clk_notifier_register);*/ int clk_notifier_unregister (struct clk *clk,struct notifier_block *nb) { -struct clk_notifier *cn =NULL ; -int ret = -EINVAL ; +struct clk_notifier *cn; +int ret = -ENOENT ;if (!clk || !nb)return -EINVAL ;clk_prepare_lock (); -list_for_each_entry (cn, &clk_notifier_list, node) -if (cn->clk == clk) -break ; - -if (cn->clk == clk) { - ret =srcu_notifier_chain_unregister (&cn->notifier_head, nb); +list_for_each_entry (cn, &clk_notifier_list, node) { +if (cn->clk == clk) { + ret =srcu_notifier_chain_unregister (&cn->notifier_head, nb); - clk->core->notifier_count--; + clk->core->notifier_count--; -/* XXX the notifier code should handle this better */ -if (!cn->notifier_head.head) { -srcu_cleanup_notifier_head (&cn->notifier_head); -list_del (&cn->node); -kfree (cn); +/* XXX the notifier code should handle this better */ +if (!cn->notifier_head.head) { +srcu_cleanup_notifier_head (&cn->notifier_head); +list_del (&cn->node); +kfree (cn); + } +break ; } - - }else { - ret = -ENOENT ; }clk_prepare_unlock ();