checkpatch: extend attributes check to handle more patterns
PATCH v4 1/1 checkpatch: extend attributes check to handle more patterns
It is generally preferred that the macros from include/linux/compiler_attributes.h are used, unless there is a reason not to.
checkpatch currently checks __attribute__ for each of packed, aligned, printf, scanf, and weak. Other declarations in compiler_attributes.h are not handled.
Add a generic test to check the presence of such attributes. Some attributes require more specific handling and are kept separate.
New attributes which are now handled are:
__alias__(#symbol)__always_inline____assume_aligned__(a, ## __VA_ARGS__)__cold____const____copy__(symbol)__designated_init____externally_visible____gnu_inline____malloc____mode__(x)__no_caller_saved_registers____noclone____noinline____nonstring____noreturn____pure____unused____used__
Also add fixes for the generic attributes check.
--- scripts/checkpatch.pl | 107 ++++++++++++++++++++++++++++-------------- 1 file changed, 71 insertions(+), 36 deletions(-)
scripts/checkpatch.pl +71 -36
@@ -6155,50 +6155,85 @@ sub process { } } -# Check for __attribute__ packed, prefer __packed +# Check for compiler attributes if ($realfile !~ m@\binclude/uapi/@ && - $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { - WARN("PREFER_PACKED", - "__packed is preferred over __attribute__((packed))\n" . $herecurr); - } + $rawline =~ /\b__attribute__\s*\(\s*($balanced_parens)\s*\)/) { + my $attr = $1; + $attr =~ s/\s*\(\s*(.*)\)\s*/$1/; + + my %attr_list = ( + "alias" => "__alias", + "aligned" => "__aligned", + "always_inline" => "__always_inline", + "assume_aligned" => "__assume_aligned", + "cold" => "__cold", + "const" => "__const", + "copy" => "__copy", + "designated_init" => "__designated_init", + "externally_visible" => "__visible", + "gnu_inline" => "__gnu_inline", + "malloc" => "__malloc", + "mode" => "__mode", + "no_caller_saved_registers" => "__no_caller_saved_registers", + "noclone" => "__noclone", + "noinline" => "noinline", + "nonstring" => "__nonstring", + "noreturn" => "__noreturn", + "packed" => "__packed", + "pure" => "__pure", + "used" => "__used" + ); + + if ($attr =~ /^(\w+)\s*(${balanced_parens})?/) { + my $curr_attr = $1; + my $params = ''; + $params = $2 if defined($2); + $curr_attr =~ s/^[\s_]+|[\s_]+$//g; + + if (exists($attr_list{$curr_attr})) { + my $new = $attr_list{$curr_attr}; + if (WARN("PREFER_DEFINED_ATTRIBUTE_MACRO", + "$new$params is preferred over __attribute__(($attr))\n" . $herecurr) && + $fix) { + $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*\Q$attr\E\s*\)\s*\)/$new$params/; + } + } + } -# Check for __attribute__ aligned, prefer __aligned - if ($realfile !~ m@\binclude/uapi/@ && - $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { - WARN("PREFER_ALIGNED", - "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); - } + # Check for __attribute__ format(printf, prefer __printf + if ($attr =~ /^_*format_*\s*\(\s*printf/) { + if (WARN("PREFER_DEFINED_ATTRIBUTE_MACRO", + "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && + $fix) { + $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*format_*\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; -# Check for __attribute__ section, prefer __section - if ($realfile !~ m@\binclude/uapi/@ && - $line =~ /\b__attribute__\s*\(\s*\(.*_*section_*\s*\(\s*("[^"]*")/) { - my $old = substr($rawline, $-[1], $+[1] - $-[1]); - my $new = substr($old, 1, -1); - if (WARN("PREFER_SECTION", - "__section($new) is preferred over __attribute__((section($old)))\n" . $herecurr) && - $fix) { - $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/; + } } - } -# Check for __attribute__ format(printf, prefer __printf - if ($realfile !~ m@\binclude/uapi/@ && - $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { - if (WARN("PREFER_PRINTF", - "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && - $fix) { - $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; + # Check for __attribute__ format(scanf, prefer __scanf + if ($attr =~ /^_*format_*\s*\(\s*scanf\b/) { + if (WARN("PREFER_DEFINED_ATTRIBUTE_MACRO", + "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && + $fix) { + $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*format_*\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; + } + } + # Check for __attribute__ section, prefer __section + if ($attr =~ /^_*section_*\s*\(\s*("[^"]*")/) { + my $old = substr($attr, $-[1], $+[1] - $-[1]); + my $new = substr($old, 1, -1); + if (WARN("PREFER_DEFINED_ATTRIBUTE_MACRO", + "__section($new) is preferred over __attribute__((section($old)))\n" . $herecurr) && + $fix) { + $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/; + } } - } -# Check for __attribute__ format(scanf, prefer __scanf - if ($realfile !~ m@\binclude/uapi/@ && - $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { - if (WARN("PREFER_SCANF", - "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && - $fix) { - $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; + # Check for __attribute__ unused, prefer __always_unused or __maybe_unused + if ($attr =~ /^_*unused/) { + WARN("PREFER_DEFINED_ATTRIBUTE_MACRO", + "__always_unused or __maybe_unused is preferred over __attribute__((__unused__))\n" . $herecurr); } }
Signature · 6 lines
2.27.0 _______________________________________________ Linux-kernel-mentees mailing list [email protected] https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
Joe Perches
maintainerQuoted 11 lines · Dwaipayan Ray
It is generally preferred that the macros from
include/linux/compiler_attributes.hare used, unless there is a reason not to.checkpatch currently checks
__attribute__for each of packed, aligned, printf, scanf, and weak. Other declarations incompiler_attributes.hare not handled.Add a generic test to check the presence of such attributes. Some attributes require more specific handling and are kept separate.
[]
Quoted 1 line
Also add fixes for the generic attributes check.
[]
scripts/checkpatch.pl
Quoted 1 line
scripts/checkpatch.pl +0
-0
[]
scripts/checkpatch.pl sub process { · line 6198
Quoted 6 lines
scripts/checkpatch.pl +6
-0+ if (exists($attr_list{$curr_attr})) { + my $new = $attr_list{$curr_attr}; + if (WARN("PREFER_DEFINED_ATTRIBUTE_MACRO", + "$new$params is preferred over __attribute__(($attr))\n" . $herecurr) && + $fix) { + $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*\Q$attr\E\s*\)\s*\)/$new$params/;
Thanks.
This fix would only work for the single conversions and would not work for multiple attributes like:
__attribute__((aligned(4), packed))
It would be nice to be able to convert this to
__aligned(4) __packed
One mechanism to do that might be to:
create an empty array
for each attr
push(@array, conversion)
s/__attribute__(...)/join(' ', @array)/
if all attrs were converted.
Quoted 36 lines · Joe Perches
Quoted 11 lines · Dwaipayan Ray
It is generally preferred that the macros from
include/linux/compiler_attributes.hare used, unless there is a reason not to.checkpatch currently checks
__attribute__for each of packed, aligned, printf, scanf, and weak. Other declarations incompiler_attributes.hare not handled.Add a generic test to check the presence of such attributes. Some attributes require more specific handling and are kept separate.
[]
Quoted 1 line
Also add fixes for the generic attributes check.
[]
scripts/checkpatch.pl
Quoted 1 line
scripts/checkpatch.pl +0
-0[]
scripts/checkpatch.pl sub process { · line 6198
Quoted 6 lines
scripts/checkpatch.pl +6
-0+ if (exists($attr_list{$curr_attr})) { + my $new = $attr_list{$curr_attr}; + if (WARN("PREFER_DEFINED_ATTRIBUTE_MACRO", + "$new$params is preferred over __attribute__(($attr))\n" . $herecurr) && + $fix) { + $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*\Q$attr\E\s*\)\s*\)/$new$params/;Thanks.
This fix would only work for the single conversions and would not work for multiple attributes like:
__attribute__((aligned(4), packed))It would be nice to be able to convert this to
__aligned(4) __packed
Quoted 9 lines
One mechanism to do that might be to:
create an empty array
for each attr
push(@array, conversion)
s/__attribute__(...)/join(' ', @array)/if all attrs were converted.
Okay sure I will try doing that.
I think I need to also change the test to correctly display the warning for those having multiple attributes too. Because now only single attributes are reported.
And also do you think there should be a separate check for __alias__(#symbol)? I think it expects a string and that should be trimmed in the fix.
Thanks,
Dwaipayan.
Joe Perches
maintainerQuoted 3 lines · Dwaipayan Ray
And also do you think there should be a separate check for
__alias__(#symbol)? I think it expects a string and that should be trimmed in the fix.
For now, I think you should avoid both alias and section.
There are patches to convert both of these macros to remove the stringify.
Quoted 12 lines · Joe Perches
Quoted 3 lines · Dwaipayan Ray
And also do you think there should be a separate check for
__alias__(#symbol)? I think it expects a string and that should be trimmed in the fix.For now, I think you should avoid both alias and section.
There are patches to convert both of these macros to remove the stringify.
Okay I will do that.
And another quick question please.
Suppose we have non handled attributes in one such multi attribute macro. (not present in our hash)
Like __attribute__((__packed, __something_not_handled))
For this case, do I skip the warning totally? Or something else?
Thanks,
Dwaipayan.
Joe Perches
maintainerQuoted 6 lines · Dwaipayan Ray
Suppose we have non handled attributes in one such multi attribute macro. (not present in our hash)
Like
__attribute__((__packed, __something_not_handled))For this case, do I skip the warning totally? Or something else?
Emit the warning, skip the fix unless all converted.