scripts/coccinelle/api/vma_pages.cocci

File Facts

System

Linux kernel

Corpus path

scripts/coccinelle/api/vma_pages.cocci

Extension

.cocci

Size

1519 bytes

Lines

62

Domain

Support Tooling And Documentation

Bucket

scripts

Inferred role

Support Tooling And Documentation: scripts

Status

atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

• Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.
• Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.

Dependency Surface

• No C-style include directives detected by the generator.

Detected Declarations

• No top-level syscall, struct, function, initcall, or export declaration detected by the generator.

Annotated Snippet

// SPDX-License-Identifier: GPL-2.0
///
/// 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
//----------------------------------------------------------

@r_context depends on context && !patch && !org && !report@
struct vm_area_struct *vma;
@@

* (vma->vm_end - vma->vm_start) >> PAGE_SHIFT

//----------------------------------------------------------
//  For patch mode
//----------------------------------------------------------

@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
//----------------------------------------------------------

@r_org depends on !context && !patch && (org || report)@
struct vm_area_struct *vma;
position p;
@@

  (vma->vm_end@p - vma->vm_start) >> PAGE_SHIFT

@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)

Annotation

• Atlas domain: Support Tooling And Documentation / scripts.
• Implementation status: atlas-only.

Implementation Notes

• This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
• Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
• Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.