coccinelle: misc: Add field_modify script
Subsystems (2)
PATCH v7 1/1 coccinelle: misc: Add field_modify script
Find and suggest conversions of opencoded field modify patterns with the wrapper FIELD_MODIFY() API defined in include/linux/bitfield.h for catching the possible parameter type error in the compile time.
---
Add the helper FIELD_MODIFY() to the FIELD_XXX family of bitfield macros. It is functionally similar as xxx_replace_bits(), but adds the compile time checking to catch incorrect parameter type errors.
This series also converts the four instances of opencoded FIELD_MODIFY() that are found in the core kernel files, to instead use the new FIELD_MODIFY() macro. This is achieved with Coccinelle, by adding the script field_modify.cocci.
The changes are validated on IPQ9574 SoC which uses ARM64 architecture.
---
Changes in v7:
- Use a formatted string literal as the function parameter for the
report mode.
- Link to v6: https://lore.kernel.org/r/[email protected]
Changes in v6:
- Adopt the suggested code variant for the org mode.
- Link to v5: https://lore.kernel.org/r/[email protected]
Changes in v5:
- Remove ARM64 patches based on the discussion in v3 and v4 versions of
this series.
- Simplify the condition selections in coccinelle script.
- Link to v4: https://lore.kernel.org/r/[email protected]
Changes in v4:
- Add org, report and context mode for coccinelle script.
- Fix other comments on coccinelle script patch.
- Remove the FIELD_MODIFY patch as it is merged.
- Link to v3: https://lore.kernel.org/r/[email protected]
Changes in v3:
- Correct the order of header files included.
- Add the Coccinelle script field_modify.cocci..
- Convert the opencoded FIELD_MODIFY() variants inside arm64 directory, identified by field_modify.cocci.
- Link to v2: https://lore.kernel.org/all/[email protected]/
Changes in v2:
- Update the documented example for FIELD_MODIFY().
- Improve the commit message to describe the need for the change.
- Link to v1: https://lore.kernel.org/all/[email protected]/
--- scripts/coccinelle/misc/field_modify.cocci | 59 ++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+)
scripts/coccinelle/misc/field_modify.cocci new file +59 -0
@@ -0,0 +1,59 @@ +// SPDX-License-Identifier: GPL-2.0-only +/// Replace below code with the wrapper FIELD_MODIFY(MASK, ®, val) +/// - reg &= ~MASK; +/// - reg |= FIELD_PREP(MASK, val); +// +// Confidence: High +// Author: Luo Jie <[email protected]> +// Copyright: (C) 2025 Qualcomm Innovation Center, Inc. +// Keywords: FIELD_PREP, FIELD_MODIFY +// Options: --include-headers + +virtual context +virtual patch +virtual org +virtual report + +@depends on context@ +identifier reg, val; +constant mask; +symbol FIELD_PREP; +@@ + +*reg &= ~mask; +*reg |= FIELD_PREP(mask, val); + +@depends on patch@ +identifier reg, val; +constant mask; +symbol FIELD_PREP, FIELD_MODIFY; +@@ + +-reg &= ~mask; +-reg |= FIELD_PREP(mask, val); ++FIELD_MODIFY(mask, ®, val); + +@r depends on org || report@ +identifier reg, val; +constant mask; +symbol FIELD_PREP; +position p; +@@ + +reg &= ~mask; +reg |= FIELD_PREP@p(mask, val); + +@script:python depends on report@ +p << r.p; +x << r.reg; +@@ + +coccilib.report.print_report(p[0], f"WARNING: Consider using FIELD_MODIFY helper on {x}") + +@script:python depends on org@ +p << r.p; +x << r.reg; +@@ + +msg = f"WARNING: Consider using FIELD_MODIFY helper on {x}" +coccilib.org.print_todo(p[0], msg.replace("[","@(").replace("]",")"))
---
base-commit: 0bb71d301869446810a0b13d3da290bd455d7c78
change-id: 20250612-field_modify-27139f673881
Best regards,
Signature · 1 line
Luo Jie <[email protected]>