Skip to contentSkip to conversation

coccinelle: api: add vma_pages.cocci

PATCH Superseded Dmitry Kalinkin 3 participants 6 messages May 17, 2015 – May 21, 2015 Coccinelle/Semantic Patches (SmPL)

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 coccinelle: api: add vma_pages.cocci

This semantic patch replaces explicit computations of vma page count with explicit function call.

---
 scripts/coccinelle/api/vma_pages.cocci | 66 ++++++++++++++++++++++++++++++++++
 1 file changed, 66 insertions(+)
 create mode 100644 scripts/coccinelle/api/vma_pages.cocci
scripts/coccinelle/api/vma_pages.cocci new file +66 -0
new file mode 100644
index 0000000..2b7a748
@@ -0,0 +1,66 @@
+/// Use vma_pages function on vma object instead of explicit computation.
+//  Confidence: High
+//  Keywords: vma_pages vma
+
+//  Based on resource_size.cocci
+
+virtual context
+virtual patch
+virtual org
+virtual report
+
+//----------------------------------------------------------
+//  For context mode
+//----------------------------------------------------------
+
+ at r_context depends on context && !patch && !org@
+struct vm_area_struct *vma;
+@@
+
+* (vma->vm_end - vma->vm_start) >> PAGE_SHIFT
+
+//----------------------------------------------------------
+//  For patch mode
+//----------------------------------------------------------
+
+ at r_patch1 depends on !context && patch && !org@
+struct vm_area_struct *vma;
+@@
+
+- ((vma->vm_end - vma->vm_start) >> PAGE_SHIFT)
++ vma_pages(vma)
+
+ at r_patch2 depends on !context && patch && !org@
+struct vm_area_struct *vma;
+@@
+
+- (vma->vm_end - vma->vm_start) >> PAGE_SHIFT
++ vma_pages(vma)
+
+//----------------------------------------------------------
+//  For org mode
+//----------------------------------------------------------
+
+ at r_org depends on !context && !patch && (org || report)@
+struct vm_area_struct *vma;
+position p;
+@@
+
+  (vma->vm_end at p - vma->vm_start) >> PAGE_SHIFT
+
+ at script:python depends on report@
+p << r_org.p;
+x << r_org.vma;
+@@
+
+msg="ERROR: Missing vma_pages with %s" % (x)
+coccilib.report.print_report(p[0], msg)
+
+@script:python depends on org@
+p << r_org.p;
+x << r_org.vma;
+@@
+
+msg="ERROR with %s" % (x)
+msg_safe=msg.replace("[","@(").replace("]",")")
+coccilib.org.print_todo(p[0], msg_safe)
Signature · 1 line
1.8.3.1
#1 lore raw
Quoted 2 lines · Dmitry Kalinkin

This semantic patch replaces explicit computations of vma page count with explicit function call.

Thanks!

scripts/coccinelle/api/vma_pages.cocci line 1

Quoted 13 lines
---
 scripts/coccinelle/api/vma_pages.cocci | 66 ++++++++++++++++++++++++++++++++++
 1 file changed, 66 insertions(+)
 create mode 100644 scripts/coccinelle/api/vma_pages.cocci
scripts/coccinelle/api/vma_pages.cocci new file +1 -0
new file mode 100644
index 0000000..2b7a748
@@ -0,0 +1,66 @@
+/// Use vma_pages function on vma object instead of explicit computation.

Add an extra /// here.

Quoted 5 lines
scripts/coccinelle/api/vma_pages.cocci new file +5 -0
+//  Confidence: High
+//  Keywords: vma_pages vma
+
+//  Based on resource_size.cocci
+

scripts/coccinelle/api/vma_pages.cocci line 16

Quoted 10 lines
scripts/coccinelle/api/vma_pages.cocci new file +10 -0
+virtual context
+virtual patch
+virtual org
+virtual report
+
+//----------------------------------------------------------
+//  For context mode
+//----------------------------------------------------------
+
+ at r_context depends on context && !patch && !org@

Add && !report here

scripts/coccinelle/api/vma_pages.cocci line 26

Quoted 10 lines
scripts/coccinelle/api/vma_pages.cocci new file +10 -0
+struct vm_area_struct *vma;
+@@
+
+* (vma->vm_end - vma->vm_start) >> PAGE_SHIFT
+
+//----------------------------------------------------------
+//  For patch mode
+//----------------------------------------------------------
+
+ at r_patch1 depends on !context && patch && !org@

Add && !report here

scripts/coccinelle/api/vma_pages.cocci line 38

Quoted 12 lines
scripts/coccinelle/api/vma_pages.cocci new file +12 -0
+struct vm_area_struct *vma;
+@@
+
+- ((vma->vm_end - vma->vm_start) >> PAGE_SHIFT)
++ vma_pages(vma)
+
+ at r_patch2 depends on !context && patch && !org@
+struct vm_area_struct *vma;
+@@
+
+- (vma->vm_end - vma->vm_start) >> PAGE_SHIFT
++ vma_pages(vma)

This rule is not needed. An isomorphism will allow tha case with () around the whole thing to match the case where those parentheses are absent.

Quoted 7 lines
scripts/coccinelle/api/vma_pages.cocci new file +7 -0
+//----------------------------------------------------------
+//  For org mode
+//----------------------------------------------------------
+
+ at r_org depends on !context && !patch && (org || report)@
+struct vm_area_struct *vma;
+position p;

scripts/coccinelle/api/vma_pages.cocci line 56

Quoted 10 lines
scripts/coccinelle/api/vma_pages.cocci new file +10 -0
+@@
+
+  (vma->vm_end at p - vma->vm_start) >> PAGE_SHIFT
+
+ at script:python depends on report@
+p << r_org.p;
+x << r_org.vma;
+@@
+
+msg="ERROR: Missing vma_pages with %s" % (x)

I think that the message is a bit misleading. Something like Use vma_pages would be better.

scripts/coccinelle/api/vma_pages.cocci line 66

Quoted 10 lines
scripts/coccinelle/api/vma_pages.cocci new file +10 -0
+coccilib.report.print_report(p[0], msg)
+
+ at script:python depends on org@
+p << r_org.p;
+x << r_org.vma;
+@@
+
+msg="ERROR with %s" % (x)
+msg_safe=msg.replace("[","@(").replace("]",")")
+coccilib.org.print_todo(p[0], msg_safe)

The message could be the same in this case as in the previous one.

It may be good to put below the keywords:

// Comments:
// Options: --all-includes

This rule relies on type information, ie knowing whether something has type struct vm_area_struct *, so having more include files available may make that more apparent. On the other hand, if you think the referenced thing will always be a local variable (as opposed to a structure field), then just using the current C file should be good enough, and it will be faster without the --all-includes option.

I tried the rule replacing struct vm_area_struct *vma; by expression vma and got a couple of results on other types. One could wonder if that code could be improved in some way.

julia

#2 lore raw
Quoted 10 lines · Julia Lawall

scripts/coccinelle/api/vma_pages.cocci line 38

Quoted 6 lines

+ at r_patch2 depends on !context && patch && !org@

scripts/coccinelle/api/vma_pages.cocci new file +5 -0
+struct vm_area_struct *vma;
+@@
+
+- (vma->vm_end - vma->vm_start) >> PAGE_SHIFT
++ vma_pages(vma)

This rule is not needed. An isomorphism will allow tha case with () around the whole thing to match the case where those parentheses are absent.

So coccinelle is a real semantic tool and sees the difference between (vma->vm_end - vma->vm_start) >> PAGE_SHIFT + 3
and
(vma->vm_end - vma->vm_start) >> PAGE_SHIFT & 3
Cool. Didn't realize that.

Quoted 11 lines

It may be good to put below the keywords:

// Comments:
// Options: --all-includes

This rule relies on type information, ie knowing whether something has type struct vm_area_struct *, so having more include files available may make that more apparent. On the other hand, if you think the referenced thing will always be a local variable (as opposed to a structure field), then just using the current C file should be good enough, and it will be faster without the --all-includes option.

There probably won't be any benefit in doing that. The statement is long enough already long enough as it is. So it is unlikely that any code like (dev->priv->vma->vm_end at p - dev->priv->vma->vm_start) >> PAGE_SHIFT is to appear.
I also just checked and saw that using --all-includes doesn't produce additional triggers anywhere on the current code (except for false fire on mm.h at vma_pages() itself).

Quoted 4 lines

I tried the rule replacing struct vm_area_struct *vma; by expression vma and got a couple of results on other types. One could wonder if that code could be improved in some way.

Indeed, there are such cases. I checked a couple manually and they turned out to be some different third party structures having fields called vm_end and vm_start used for vma-related accounting. These may or may not be a justifiable uses. We could report them, but not propose an automatic patch

Kind regards,
Dmitry

#3 lore raw

PATCH v2 1/1 coccinelle: api: add vma_pages.cocci

In reply to Julia Lawall

This semantic patch replaces explicit computations of vma page count with explicit function call.

---
 scripts/coccinelle/api/vma_pages.cocci | 60 ++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 scripts/coccinelle/api/vma_pages.cocci
scripts/coccinelle/api/vma_pages.cocci new file +60 -0
new file mode 100644
index 0000000..3e52e11
@@ -0,0 +1,60 @@
+///
+/// Use vma_pages function on vma object instead of explicit computation.
+///
+//  Confidence: High
+//  Keywords: vma_pages vma
+//  Comment: Based on resource_size.cocci
+
+virtual context
+virtual patch
+virtual org
+virtual report
+
+//----------------------------------------------------------
+//  For context mode
+//----------------------------------------------------------
+
+ at r_context depends on context && !patch && !org && !report@
+struct vm_area_struct *vma;
+@@
+
+* (vma->vm_end - vma->vm_start) >> PAGE_SHIFT
+
+//----------------------------------------------------------
+//  For patch mode
+//----------------------------------------------------------
+
+ at r_patch depends on !context && patch && !org && !report@
+struct vm_area_struct *vma;
+@@
+
+- ((vma->vm_end - vma->vm_start) >> PAGE_SHIFT)
++ vma_pages(vma)
+
+//----------------------------------------------------------
+//  For org mode
+//----------------------------------------------------------
+
+ at r_org depends on !context && !patch && (org || report)@
+struct vm_area_struct *vma;
+position p;
+@@
+
+  (vma->vm_end at p - vma->vm_start) >> PAGE_SHIFT
+
+ at script:python depends on report@
+p << r_org.p;
+x << r_org.vma;
+@@
+
+msg="WARNING: Consider using vma_pages helper on %s" % (x)
+coccilib.report.print_report(p[0], msg)
+
+@script:python depends on org@
+p << r_org.p;
+x << r_org.vma;
+@@
+
+msg="WARNING: Consider using vma_pages helper on %s" % (x)
+msg_safe=msg.replace("[","@(").replace("]",")")
+coccilib.org.print_todo(p[0], msg_safe)
Signature · 1 line
1.8.3.1
Acked-by on v2 1/1
#4 lore raw

Thanks!

Quoted 79 lines · Dmitry Kalinkin

This semantic patch replaces explicit computations of vma page count with explicit function call.

---
 scripts/coccinelle/api/vma_pages.cocci | 60 ++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 scripts/coccinelle/api/vma_pages.cocci
scripts/coccinelle/api/vma_pages.cocci new file +60 -0
new file mode 100644
index 0000000..3e52e11
@@ -0,0 +1,60 @@
+///
+/// Use vma_pages function on vma object instead of explicit computation.
+///
+//  Confidence: High
+//  Keywords: vma_pages vma
+//  Comment: Based on resource_size.cocci
+
+virtual context
+virtual patch
+virtual org
+virtual report
+
+//----------------------------------------------------------
+//  For context mode
+//----------------------------------------------------------
+
+ at r_context depends on context && !patch && !org && !report@
+struct vm_area_struct *vma;
+@@
+
+* (vma->vm_end - vma->vm_start) >> PAGE_SHIFT
+
+//----------------------------------------------------------
+//  For patch mode
+//----------------------------------------------------------
+
+ at r_patch depends on !context && patch && !org && !report@
+struct vm_area_struct *vma;
+@@
+
+- ((vma->vm_end - vma->vm_start) >> PAGE_SHIFT)
++ vma_pages(vma)
+
+//----------------------------------------------------------
+//  For org mode
+//----------------------------------------------------------
+
+ at r_org depends on !context && !patch && (org || report)@
+struct vm_area_struct *vma;
+position p;
+@@
+
+  (vma->vm_end at p - vma->vm_start) >> PAGE_SHIFT
+
+ at script:python depends on report@
+p << r_org.p;
+x << r_org.vma;
+@@
+
+msg="WARNING: Consider using vma_pages helper on %s" % (x)
+coccilib.report.print_report(p[0], msg)
+
+ at script:python depends on org@
+p << r_org.p;
+x << r_org.vma;
+@@
+
+msg="WARNING: Consider using vma_pages helper on %s" % (x)
+msg_safe=msg.replace("[","@(").replace("]",")")
+coccilib.org.print_todo(p[0], msg_safe)
Signature · 1 line
1.8.3.1