Update memdup_user.cocci
v2 cover Update memdup_user.cocci
Add GFP_USER to the allocation flags and handle vmemdup_user(). The third patch supresses memdup_user(), vmemdup_user() functions detection. Last patch is a proof of concept for the rule selfchecking. Gives the ability to detect that an open-coded pattern in a function definition that we search for in the kernel sources changed.
Denis Efremov (4):
coccinelle: api: extend memdup_user transformation with GFP_USER
coccinelle: api: extend memdup_user rule with vmemdup_user()
coccinelle: api: filter out memdup_user definitions
coccinelle: api: add selfcheck for memdup_user rule
scripts/coccinelle/api/memdup_user.cocci | 106 ++++++++++++++++++++++- 1 file changed, 103 insertions(+), 3 deletions(-)
Signature · 1 line
2.26.2
PATCH v2 1/4 coccinelle: api: extend memdup_user transformation with GFP_USER
Match GFP_USER and optional __GFP_NOWARN allocations with memdup_user.cocci rule.
Commit 6c2c97a24f09 ("memdup_user(): switch to GFP_USER") switched memdup_user() from GFP_KERNEL to GFP_USER. In almost all cases it is still a good idea to recommend memdup_user() for GFP_KERNEL allocations. The motivation behind altering memdup_user() to GFP_USER:
https://lkml.org/lkml/2018/1/6/333
--- scripts/coccinelle/api/memdup_user.cocci | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-)
scripts/coccinelle/api/memdup_user.cocci +6 -2
@@ -20,7 +20,9 @@ expression from,to,size; identifier l1,l2; @@ -- to = \(kmalloc\|kzalloc\)(size,GFP_KERNEL); +- to = \(kmalloc\|kzalloc\) + (size,\(GFP_KERNEL\|GFP_USER\| + \(GFP_KERNEL\|GFP_USER\)|__GFP_NOWARN\)); + to = memdup_user(from,size); if ( - to==NULL
@@ -43,7 +45,9 @@ position p; statement S1,S2; @@ -* to = \(kmalloc@p\|kzalloc@p\)(size,GFP_KERNEL); +* to = \(kmalloc@p\|kzalloc@p\) + (size,\(GFP_KERNEL\|GFP_USER\| + \(GFP_KERNEL\|GFP_USER\)|__GFP_NOWARN\)); if (to==NULL || ...) S1 if (copy_from_user(to, from, size) != 0) S2
Signature · 6 lines
2.26.2 _______________________________________________ Cocci mailing list [email protected] https://systeme.lip6.fr/mailman/listinfo/cocci
Re: [Cocci] [PATCH v2 1/4] coccinelle: api: extend memdup_user transformation with GFP_USER
Quoted 9 lines · Denis Efremov
Match
GFP_USERand optional__GFP_NOWARNallocations withmemdup_user.coccirule.
Commit6c2c97a24f09("memdup_user(): switch toGFP_USER") switchedmemdup_user()fromGFP_KERNELtoGFP_USER. In almost all cases it is still a good idea to recommendmemdup_user()forGFP_KERNELallocations. The motivation behind alteringmemdup_user()toGFP_USER:
https://lkml.org/lkml/2018/1/6/333Signed-off-by Denis Efremov <[email protected]>
Applied.
Quoted 38 lines
--- scripts/coccinelle/api/memdup_user.cocci | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-)scripts/coccinelle/api/memdup_user.cocci +6
-3@@ -20,7 +20,9 @@ expression from,to,size; identifier l1,l2; @@ -- to = \(kmalloc\|kzalloc\)(size,GFP_KERNEL); +- to = \(kmalloc\|kzalloc\) + (size,\(GFP_KERNEL\|GFP_USER\| + \(GFP_KERNEL\|GFP_USER\)|__GFP_NOWARN\)); + to = memdup_user(from,size); if ( - to==NULL@@ -43,7 +45,9 @@ position p; statement S1,S2; @@ -* to = \(kmalloc@p\|kzalloc@p\)(size,GFP_KERNEL); +* to = \(kmalloc@p\|kzalloc@p\) + (size,\(GFP_KERNEL\|GFP_USER\| + \(GFP_KERNEL\|GFP_USER\)|__GFP_NOWARN\)); if (to==NULL || ...) S1 if (copy_from_user(to, from, size) != 0) S2 --2.26.2
_______________________________________________
Cocci mailing list
[email protected]
https://systeme.lip6.fr/mailman/listinfo/cocci
PATCH v2 2/4 coccinelle: api: extend memdup_user rule with vmemdup_user()
In reply to Denis EfremovAdd vmemdup_user() transformations to the memdup_user.cocci rule. Commit 50fd2f298bef ("new primitive: vmemdup_user()") introduced vmemdup_user(). The function uses kvmalloc with GPF_USER flag.
--- scripts/coccinelle/api/memdup_user.cocci | 45 ++++++++++++++++++++++++ 1 file changed, 45 insertions(+)
scripts/coccinelle/api/memdup_user.cocci +45 -0
@@ -39,6 +39,28 @@ identifier l1,l2; - ...+> - } +@depends on patch@ +expression from,to,size; +identifier l1,l2; +@@ + +- to = \(kvmalloc\|kvzalloc\)(size,\(GFP_KERNEL\|GFP_USER\)); ++ to = vmemdup_user(from,size); + if ( +- to==NULL ++ IS_ERR(to) + || ...) { + <+... when != goto l1; +- -ENOMEM ++ PTR_ERR(to) + ...+> + } +- if (copy_from_user(to, from, size) != 0) { +- <+... when != goto l2; +- -EFAULT +- ...+> +- } + @r depends on !patch@ expression from,to,size; position p;
@@ -52,6 +74,17 @@ statement S1,S2; if (copy_from_user(to, from, size) != 0) S2 +@rv depends on !patch@ +expression from,to,size; +position p; +statement S1,S2; +@@ + +* to = \(kvmalloc@p\|kvzalloc@p\)(size,\(GFP_KERNEL\|GFP_USER\)); + if (to==NULL || ...) S1 + if (copy_from_user(to, from, size) != 0) + S2 + @script:python depends on org@ p << r.p; @@
@@ -63,3 +96,15 @@ p << r.p; @@ coccilib.report.print_report(p[0], "WARNING opportunity for memdup_user") + +@script:python depends on org@ +p << rv.p; +@@ + +coccilib.org.print_todo(p[0], "WARNING opportunity for vmemdup_user") + +@script:python depends on report@ +p << rv.p; +@@ + +coccilib.report.print_report(p[0], "WARNING opportunity for vmemdup_user")
Signature · 6 lines
2.26.2 _______________________________________________ Cocci mailing list [email protected] https://systeme.lip6.fr/mailman/listinfo/cocci
PATCH v2 3/4 coccinelle: api: filter out memdup_user definitions
In reply to Denis EfremovDon't match original implementations.
--- scripts/coccinelle/api/memdup_user.cocci | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-)
scripts/coccinelle/api/memdup_user.cocci +13 -4
@@ -15,12 +15,20 @@ virtual context virtual org virtual report +@initialize:python@ +@@ +filter = frozenset(['memdup_user', 'vmemdup_user']) + +def relevant(p): + return not (filter & {el.current_element for el in p}) + @depends on patch@ expression from,to,size; identifier l1,l2; +position p : script:python() { relevant(p) }; @@ -- to = \(kmalloc\|kzalloc\) +- to = \(kmalloc@p\|kzalloc@p\) (size,\(GFP_KERNEL\|GFP_USER\| \(GFP_KERNEL\|GFP_USER\)|__GFP_NOWARN\)); + to = memdup_user(from,size);
@@ -42,9 +50,10 @@ identifier l1,l2; @depends on patch@ expression from,to,size; identifier l1,l2; +position p : script:python() { relevant(p) }; @@ -- to = \(kvmalloc\|kvzalloc\)(size,\(GFP_KERNEL\|GFP_USER\)); +- to = \(kvmalloc@p\|kvzalloc@p\)(size,\(GFP_KERNEL\|GFP_USER\)); + to = vmemdup_user(from,size); if ( - to==NULL
@@ -63,7 +72,7 @@ identifier l1,l2; @r depends on !patch@ expression from,to,size; -position p; +position p : script:python() { relevant(p) }; statement S1,S2; @@
@@ -76,7 +85,7 @@ statement S1,S2; @rv depends on !patch@ expression from,to,size; -position p; +position p : script:python() { relevant(p) }; statement S1,S2; @@
Signature · 6 lines
2.26.2 _______________________________________________ Cocci mailing list [email protected] https://systeme.lip6.fr/mailman/listinfo/cocci
PATCH v2 4/4 coccinelle: api: add selfcheck for memdup_user rule
In reply to Denis EfremovCheck that the rule matches vmemdup_user implementation. memdup_user is out of scope because we are not matching kmalloc_track_caller() function.
--- scripts/coccinelle/api/memdup_user.cocci | 46 ++++++++++++++++++++++-- 1 file changed, 44 insertions(+), 2 deletions(-)
scripts/coccinelle/api/memdup_user.cocci +44 -2
@@ -14,13 +14,24 @@ virtual patch virtual context virtual org virtual report +virtual selfcheck @initialize:python@ @@ -filter = frozenset(['memdup_user', 'vmemdup_user']) + +definitions = { + 'memdup_user': 'mm/util.c', + 'vmemdup_user': 'mm/util.c', +} + +filter = frozenset(definitions.keys()) +coccinelle.filtered = set() +coccinelle.checked_files = set() def relevant(p): - return not (filter & {el.current_element for el in p}) + found = filter & {el.current_element for el in p} + coccinelle.filtered |= found + return not found @depends on patch@ expression from,to,size;
@@ -117,3 +128,34 @@ p << rv.p; @@ coccilib.report.print_report(p[0], "WARNING opportunity for vmemdup_user") + +@script:python depends on selfcheck@ +@@ +coccinelle.checked_files |= set(definitions.values()) & set(cocci.files()) + +@finalize:python depends on selfcheck@ +filtered << merge.filtered; +checked_files << merge.checked_files; +@@ + +# Don't check memdup_user because the pattern is not capturing +# kmalloc_track_caller() calls +del definitions['memdup_user'] + +# mapping between checked files and filtered definitions +found_defns = {} +for files, funcs in zip(checked_files, filtered): + for file in files: + found_defns[file] = funcs + +# reverse mapping of definitions +expected_defns = {v : set() for v in definitions.values()} +for k, v in definitions.items(): + expected_defns[v] |= {k} + +for efile, efuncs in expected_defns.items(): + if efile in found_defns: + not_found = efuncs - found_defns[efile] + if not_found: + print('SELF-CHECK: the pattern no longer matches ' \ + 'definitions {} in file {}'.format(not_found, efile))
Signature · 6 lines
2.26.2 _______________________________________________ Cocci mailing list [email protected] https://systeme.lip6.fr/mailman/listinfo/cocci
Julia Lawall
maintainerRe: [Cocci] [PATCH v2 4/4] coccinelle: api: add selfcheck for memdup_user rule
Quoted 3 lines · Denis Efremov
Check that the rule matches
vmemdup_userimplementation.memdup_useris out of scope because we are not matchingkmalloc_track_caller()function.
Is this a bit over-enginered? More precisely, even if it is nice to check that the API definition has the expected behavior, does it make sense to do it in one case but not the other?
julia
Quoted 80 lines
Signed-off-by Denis Efremov <[email protected]>--- scripts/coccinelle/api/memdup_user.cocci | 46 ++++++++++++++++++++++-- 1 file changed, 44 insertions(+), 2 deletions(-)scripts/coccinelle/api/memdup_user.cocci +44
-3@@ -14,13 +14,24 @@ virtual patch virtual context virtual org virtual report +virtual selfcheck @initialize:python@ @@ -filter = frozenset(['memdup_user', 'vmemdup_user']) + +definitions = { + 'memdup_user': 'mm/util.c', + 'vmemdup_user': 'mm/util.c', +} + +filter = frozenset(definitions.keys()) +coccinelle.filtered = set() +coccinelle.checked_files = set() def relevant(p): - return not (filter & {el.current_element for el in p}) + found = filter & {el.current_element for el in p} + coccinelle.filtered |= found + return not found @depends on patch@ expression from,to,size;@@ -117,3 +128,34 @@ p << rv.p; @@ coccilib.report.print_report(p[0], "WARNING opportunity for vmemdup_user") + +@script:python depends on selfcheck@ +@@ +coccinelle.checked_files |= set(definitions.values()) & set(cocci.files()) + +@finalize:python depends on selfcheck@ +filtered << merge.filtered; +checked_files << merge.checked_files; +@@ + +# Don't check memdup_user because the pattern is not capturing +# kmalloc_track_caller() calls +del definitions['memdup_user'] + +# mapping between checked files and filtered definitions +found_defns = {} +for files, funcs in zip(checked_files, filtered): + for file in files: + found_defns[file] = funcs + +# reverse mapping of definitions +expected_defns = {v : set() for v in definitions.values()} +for k, v in definitions.items(): + expected_defns[v] |= {k} + +for efile, efuncs in expected_defns.items(): + if efile in found_defns: + not_found = efuncs - found_defns[efile] + if not_found: + print('SELF-CHECK: the pattern no longer matches ' \ + 'definitions {} in file {}'.format(not_found, efile)) --2.26.2
_______________________________________________
Cocci mailing list
[email protected]
https://systeme.lip6.fr/mailman/listinfo/cocci
Re: [Cocci] [PATCH v2 4/4] coccinelle: api: add selfcheck for memdup_user rule
Quoted 9 lines · Julia Lawall
Quoted 3 lines · Denis Efremov
Check that the rule matches
vmemdup_userimplementation.memdup_useris out of scope because we are not matchingkmalloc_track_caller()function.Is this a bit over-enginered?
Last patch it's just a PoC. Patches 1-3 are independent from 4.
Quoted 3 lines
More precisely, even if it is nice to check
that the API definition has the expected behavior, does it make sense to do it in one case but not the other?
Yes, I also don't like it. However, I doubt that we need to match kmalloc_track_caller.
Thanks,
Denis
Ping?
Quoted 15 lines · Denis Efremov
Add
GFP_USERto the allocation flags and handlevmemdup_user(). The third patch supressesmemdup_user(),vmemdup_user()functions detection. Last patch is a proof of concept for the rule selfchecking. Gives the ability to detect that an open-coded pattern in a function definition that we search for in the kernel sources changed.Denis Efremov (4):
coccinelle: api: extendmemdup_usertransformation withGFP_USER
coccinelle: api: extendmemdup_userrule withvmemdup_user()
coccinelle: api: filter outmemdup_userdefinitions
coccinelle: api: add selfcheck formemdup_userrulescripts/coccinelle/api/memdup_user.cocci | 106 ++++++++++++++++++++++- 1 file changed, 103 insertions(+), 3 deletions(-)