scripts: kzfree.cocci: Deprecate use of kzfree
PATCH 1/1 scripts: kzfree.cocci: Deprecate use of kzfree
kzfree() is effectively deprecated as of commit 453431a54934 ("mm,
treewide: rename kzfree() to kfree_sensitive()"). It is currently just a legacy alias for kfree_sensitive(), which achieves the same thing.
Update kzfree.cocci accordingly:
1) Replace instances of kzfree with kfree_sensitive
2) Merge different rules for memset/memset_explicit as kzfree and kfree_sensitive are now equivalent
3) Rename script to kfree_sensitive.cocci
In addition:
4) Move the script to the free/ subfolder, where it would seem to fit better
---
.../kfree_sensitive.cocci} | 38 +++++--------------
1 file changed, 10 insertions(+), 28 deletions(-)
rename scripts/coccinelle/{api/kzfree.cocci => free/kfree_sensitive.cocci} (59%)scripts/coccinelle/free/kfree_sensitive.cocci renamed from scripts/coccinelle/api/kzfree.cocci +10 -28
@@ -1,13 +1,13 @@ // SPDX-License-Identifier: GPL-2.0-only /// -/// Use kzfree, kvfree_sensitive rather than memset or -/// memzero_explicit followed by kfree +/// Use k{,v}free_sensitive rather than memset or memzero_explicit followed by +/// k{,v}free /// // Confidence: High // Copyright: (C) 2020 Denis Efremov ISPRAS // Options: --no-includes --include-headers // -// Keywords: kzfree, kvfree_sensitive +// Keywords: kfree_sensitive, kvfree_sensitive // virtual context
@@ -18,7 +18,7 @@ virtual report @initialize:python@ @@ # kmalloc_oob_in_memset uses memset to explicitly trigger out-of-bounds access -filter = frozenset(['kmalloc_oob_in_memset', 'kzfree', 'kvfree_sensitive']) +filter = frozenset(['kmalloc_oob_in_memset', 'kfree_sensitive', 'kvfree_sensitive']) def relevant(p): return not (filter & {el.current_element for el in p})
@@ -53,34 +53,16 @@ position m != cond.ok; type T; @@ +( - memzero_explicit@m((T)E, size); - ... when != E - when strict -// TODO: uncomment when kfree_sensitive will be merged. -// Only this case is commented out because developers -// may not like patches like this since kzfree uses memset -// internally (not memzero_explicit). -//( -//- kfree(E)@p; -//+ kfree_sensitive(E); -//| -- \(vfree\|kvfree\)(E)@p; -+ kvfree_sensitive(E, size); -//) - -@rp_memset depends on patch@ -expression E, size; -position p : script:python() { relevant(p) }; -position m != cond.ok; -type T; -@@ - +| - memset@m((T)E, 0, size); +) ... when != E when strict ( - kfree(E)@p; -+ kzfree(E); ++ kfree_sensitive(E); | - \(vfree\|kvfree\)(E)@p; + kvfree_sensitive(E, size);
@@ -91,11 +73,11 @@ p << r.p; @@ coccilib.report.print_report(p[0], - "WARNING: opportunity for kzfree/kvfree_sensitive") + "WARNING: opportunity for k{,v}free_sensitive") @script:python depends on org@ p << r.p; @@ coccilib.org.print_todo(p[0], - "WARNING: opportunity for kzfree/kvfree_sensitive") + "WARNING: opportunity for k{,v}free_sensitive")
Signature · 6 lines
2.28.0 _______________________________________________ Cocci mailing list [email protected] https://systeme.lip6.fr/mailman/listinfo/cocci
Hi,
same patch
https://lkml.org/lkml/2020/8/11/130
Julia, I've send all the patches to fix existing kfree_sensitive/kvfree_sensitive reports.
https://lkml.org/lkml/2020/8/27/168
https://lkml.org/lkml/2020/8/27/93
Thanks,
Denis
Quoted 107 lines · Alex Dewar
kzfree()is effectively deprecated as of commit453431a54934("mm,
treewide: renamekzfree()tokfree_sensitive()"). It is currently just a legacy alias forkfree_sensitive(), which achieves the same thing.Update
kzfree.cocciaccordingly:
1) Replace instances of kzfree withkfree_sensitive
2) Merge different rules for memset/memset_explicit as kzfree andkfree_sensitiveare now equivalent
3) Rename script tokfree_sensitive.cocciIn addition:
4) Move the script to the free/ subfolder, where it would seem to fit betterSigned-off-by Alex Dewar <[email protected]>--- .../kfree_sensitive.cocci} | 38 +++++-------------- 1 file changed, 10 insertions(+), 28 deletions(-) rename scripts/coccinelle/{api/kzfree.cocci => free/kfree_sensitive.cocci} (59%)scripts/coccinelle/free/kfree_sensitive.cocci renamed from scripts/coccinelle/api/kzfree.cocci +10
-28@@ -1,13 +1,13 @@ // SPDX-License-Identifier: GPL-2.0-only /// -/// Use kzfree, kvfree_sensitive rather than memset or -/// memzero_explicit followed by kfree +/// Use k{,v}free_sensitive rather than memset or memzero_explicit followed by +/// k{,v}free /// // Confidence: High // Copyright: (C) 2020 Denis Efremov ISPRAS // Options: --no-includes --include-headers // -// Keywords: kzfree, kvfree_sensitive +// Keywords: kfree_sensitive, kvfree_sensitive // virtual context@@ -18,7 +18,7 @@ virtual report @initialize:python@ @@ # kmalloc_oob_in_memset uses memset to explicitly trigger out-of-bounds access -filter = frozenset(['kmalloc_oob_in_memset', 'kzfree', 'kvfree_sensitive']) +filter = frozenset(['kmalloc_oob_in_memset', 'kfree_sensitive', 'kvfree_sensitive']) def relevant(p): return not (filter & {el.current_element for el in p})@@ -53,34 +53,16 @@ position m != cond.ok; type T; @@ +( - memzero_explicit@m((T)E, size); - ... when != E - when strict -// TODO: uncomment when kfree_sensitive will be merged. -// Only this case is commented out because developers -// may not like patches like this since kzfree uses memset -// internally (not memzero_explicit). -//( -//- kfree(E)@p; -//+ kfree_sensitive(E); -//| -- \(vfree\|kvfree\)(E)@p; -+ kvfree_sensitive(E, size); -//) - -@rp_memset depends on patch@ -expression E, size; -position p : script:python() { relevant(p) }; -position m != cond.ok; -type T; -@@ - +| - memset@m((T)E, 0, size); +) ... when != E when strict ( - kfree(E)@p; -+ kzfree(E); ++ kfree_sensitive(E); | - \(vfree\|kvfree\)(E)@p; + kvfree_sensitive(E, size);@@ -91,11 +73,11 @@ p << r.p; @@ coccilib.report.print_report(p[0], - "WARNING: opportunity for kzfree/kvfree_sensitive") + "WARNING: opportunity for k{,v}free_sensitive") @script:python depends on org@ p << r.p; @@ coccilib.org.print_todo(p[0], - "WARNING: opportunity for kzfree/kvfree_sensitive") + "WARNING: opportunity for k{,v}free_sensitive")
Quoted 5 lines · Denis Efremov
Hi,
same patch
https://lkml.org/lkml/2020/8/11/130
Quoted 7 lines
Julia, I've send all the patches to fix existing kfree_sensitive/kvfree_sensitive reports.
https://lkml.org/lkml/2020/8/27/168
https://lkml.org/lkml/2020/8/27/93Thanks,
Denis
Sorry for yet more noise!
Quoted 101 lines · Alex Dewar
Quoted 99 lines
kzfree()is effectively deprecated as of commit453431a54934("mm,
treewide: renamekzfree()tokfree_sensitive()"). It is currently just a legacy alias forkfree_sensitive(), which achieves the same thing.Update
kzfree.cocciaccordingly:
1) Replace instances of kzfree withkfree_sensitive
2) Merge different rules for memset/memset_explicit as kzfree andkfree_sensitiveare now equivalent
3) Rename script tokfree_sensitive.cocciIn addition:
4) Move the script to the free/ subfolder, where it would seem to fit betterSigned-off-by Alex Dewar <[email protected]>--- .../kfree_sensitive.cocci} | 38 +++++-------------- 1 file changed, 10 insertions(+), 28 deletions(-)rename
scripts/coccinelle/{api/kzfree.cocci=>free/kfree_sensitive.cocci} (59%)scripts/coccinelle/free/kfree_sensitive.cocci renamed from scripts/coccinelle/api/kzfree.cocci +9
-27@@ -1,13 +1,13 @@ // SPDX-License-Identifier: GPL-2.0-only /// -/// Use kzfree, kvfree_sensitive rather than memset or -/// memzero_explicit followed by kfree +/// Use k{,v}free_sensitive rather than memset or memzero_explicit followed by +/// k{,v}free /// // Confidence: High // Copyright: (C) 2020 Denis Efremov ISPRAS // Options: --no-includes --include-headers // -// Keywords: kzfree, kvfree_sensitive +// Keywords: kfree_sensitive, kvfree_sensitive // virtual context@@ -18,7 +18,7 @@ virtual report @initialize:python@ @@ # kmalloc_oob_in_memset uses memset to explicitly trigger out-of-bounds access -filter = frozenset(['kmalloc_oob_in_memset', 'kzfree', 'kvfree_sensitive']) +filter = frozenset(['kmalloc_oob_in_memset', 'kfree_sensitive', 'kvfree_sensitive']) def relevant(p): return not (filter & {el.current_element for el in p})@@ -53,34 +53,16 @@ position m != cond.ok; type T; @@ +( - memzero_explicit@m((T)E, size); - ... when != E - when strict -// TODO: uncomment when kfree_sensitive will be merged. -// Only this case is commented out because developers -// may not like patches like this since kzfree uses memset -// internally (not memzero_explicit). -//( -//- kfree(E)@p; -//+ kfree_sensitive(E); -//| -- \(vfree\|kvfree\)(E)@p; -+ kvfree_sensitive(E, size); -//) - -@rp_memset depends on patch@ -expression E, size; -position p : script:python() { relevant(p) }; -position m != cond.ok; -type T; -@@ - +| - memset@m((T)E, 0, size); +) ... when != E when strict ( - kfree(E)@p; -+ kzfree(E); ++ kfree_sensitive(E); | - \(vfree\|kvfree\)(E)@p; + kvfree_sensitive(E, size);@@ -91,11 +73,11 @@ p << r.p; @@ coccilib.report.print_report(p[0], - "WARNING: opportunity for kzfree/kvfree_sensitive") + "WARNING: opportunity for k{,v}free_sensitive")
Quoted 8 lines
scripts/coccinelle/free/kfree_sensitive.cocci p << r.p; · line 83
Quoted 8 lines
scripts/coccinelle/free/kfree_sensitive.cocci renamed from scripts/coccinelle/api/kzfree.cocci +1
-1@script:python depends on org@ p << r.p; @@ coccilib.org.print_todo(p[0], - "WARNING: opportunity for kzfree/kvfree_sensitive") + "WARNING: opportunity for k{,v}free_sensitive")
_______________________________________________
Cocci mailing list
[email protected]
https://systeme.lip6.fr/mailman/listinfo/cocci