Skip to contentSkip to conversation

+ checkpatch-add-tests-for-function-pointer-style-misuses.patch added to -mm tree

PATCH [email protected] 3 participants 3 messages Dec 26, 2013 – Dec 27, 2013 Checkpatch

lore
Share & tools
lore
#0 lore raw

Subject: + checkpatch-add-tests-for-function-pointer-style-misuses.patch added to -mm tree
To: [email protected],[email protected],[email protected],[email protected]
From: [email protected]
Date: Thu, 26 Dec 2013 14:16:10 -0800

The patch titled
Subject: checkpatch: add tests for function pointer style misuses
has been added to the -mm tree. Its filename is
checkpatch-add-tests-for-function-pointer-style-misuses.patch

This patch should soon appear at
http://ozlabs.org/~akpm/mmots/broken-out/checkpatch-add-tests-for-function-pointer-style-misuses.patch
and later at
http://ozlabs.org/~akpm/mmotm/broken-out/checkpatch-add-tests-for-function-pointer-style-misuses.patch

Before you just go and hit "reply", please:
a) Consider who else should be cc'ed
b) Prefer to cc a suitable mailing list as well
c) Ideally: find the original patch on the mailing list and do a reply-to-all to that, adding suitable additional cc's

*** Remember to use Documentation/SubmitChecklist when testing your code ***

The -mm tree is included into linux-next and is updated there every 3-4 working days

------------------------------------------------------
From: Joe Perches <[email protected]>
Subject: checkpatch: add tests for function pointer style misuses

Kernel style uses function pointers in this form:

	"type (*funcptr)(args...)"

Emit warnings when this function pointer form isn't used.

Cc Josh Triplett <[email protected]>
Cc Manfred Spraul <[email protected]>
Cc Andy Whitcroft <[email protected]>

---

 scripts/checkpatch.pl |   59 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 59 insertions(+)
scripts/checkpatch.pl renamed from scripts/checkpatch.pl~checkpatch-add-tests-for-function-pointer-style-misuses +59 -0
diff -puN scripts/checkpatch.pl~checkpatch-add-tests-for-function-pointer-style-misuses scripts/checkpatch.pl
@@ -2798,6 +2798,65 @@ sub process {
 			}
 		}
 
+# Function pointer declarations
+# check spacing between type, funcptr, and args
+# canonical declaration is "type (*funcptr)(args...)"
+#
+# the $Declare variable will capture all spaces after the type
+# so check it for multiple spaces
+		if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)$Ident(\s*)\)(\s*)\(/) {
+			my $declare = $1;
+			my $pre_pointer_space = $2;
+			my $post_pointer_space = $3;
+			my $funcname = $4;
+			my $post_funcname_space = $5;
+			my $pre_args_space = $6;
+
+			if ($declare !~ /\s$/) {
+				WARN("SPACING",
+				     "missing space after return type\n" . $herecurr);
+			}
+
+# unnecessary space "type  (*funcptr)(args...)"
+			elsif ($declare =~ /\s{2,}$/) {
+				WARN("SPACING",
+				     "Multiple spaces after return type\n" . $herecurr);
+			}
+
+# unnecessary space "type ( *funcptr)(args...)"
+			if (defined $pre_pointer_space &&
+			    $pre_pointer_space =~ /^\s/) {
+				WARN("SPACING",
+				     "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
+			}
+
+# unnecessary space "type (* funcptr)(args...)"
+			if (defined $post_pointer_space &&
+			    $post_pointer_space =~ /^\s/) {
+				WARN("SPACING",
+				     "Unnecessary space before function pointer name\n" . $herecurr);
+			}
+
+# unnecessary space "type (*funcptr )(args...)"
+			if (defined $post_funcname_space &&
+			    $post_funcname_space =~ /^\s/) {
+				WARN("SPACING",
+				     "Unnecessary space after function pointer name\n" . $herecurr);
+			}
+
+# unnecessary space "type (*funcptr) (args...)"
+			if (defined $pre_args_space &&
+			    $pre_args_space =~ /^\s/) {
+				WARN("SPACING",
+				     "Unnecessary space before function pointer name\n" . $herecurr);
+			}
+
+			if (show_type("SPACING") && $fix) {
+				$fixed[$linenr - 1] =~
+				    s/^(.\s*$Declare)\(\s*\*\s*($Ident)\s*\)\s*\(/rtrim($1) . " " . "\(\*$2\)\("/ex;
+			}
+		}
+
 # check for spacing round square brackets; allowed:
 #  1. with a type on the left -- int [] a;
 #  2. at the beginning of a line for slice initialisers -- [0...10] = 5,

_

Patches currently in -mm which might be from [email protected] are

lib-parserc-add-match_wildcard-function.patch lib-parserc-put-export_symbols-in-the-conventional-place.patch dynamic_debug-add-wildcard-support-to-filter-files-functions-modules.patch dynamic-debug-howtotxt-update-since-new-wildcard-support.patch printk-cache-mark-printk_once-test-variable-__read_mostly.patch printk-cache-mark-printk_once-test-variable-__read_mostly-fix.patch vsprintf-add-%pad-extension-for-dma_addr_t-use.patch get_maintainer-add-commit-author-information-to-rolestats.patch test-add-minimal-module-for-verification-testing.patch test-check-copy_to-from_user-boundary-validation.patch test-check-copy_to-from_user-boundary-validation-fix.patch checkpatch-more-comprehensive-split-strings-warning.patch checkpatch-warn-only-on-space-before-semicolon-at-end-of-line.patch checkpatch-add-warning-of-future-__gfp_nofail-use.patch checkpatch-attempt-to-find-missing-switch-case-break.patch checkpatch-add-tests-for-function-pointer-style-misuses.patch checkpatch-add-a-fix-inplace-option.patch checkpatch-improve-space-before-tab-fix-option.patch checkpatch-check-for-ifs-with-unnecessary-parentheses.patch checkpatch-update-the-fsf-gpl-address-check.patch linux-next.patch
softirq-use-ffs-in-__do_softirq.patch softirq-convert-printks-to-pr_level.patch softirq-use-const-char-const-for-softirq_to_name-whitespace-neatening.patch checkpatchpl-check-for-function-declarations-without-arguments.patch

#1 lore raw

Re: [PATCH 1/5] checkpatch: Add tests for function pointer style misuses

Quoted 9 lines · Josh Triplett
Quoted 6 lines · Joe Perches

Kernel style uses function pointers in this form:
        "type (*funcptr)(args...)"

Emit warnings when this function pointer form isn't used.

Two comments below.

Quoted 4 lines · On Thu, Dec 26, 2013 at 02:16:10PM -0800, [email protected] wrote:

The patch titled
Subject: checkpatch: add tests for function pointer style misuses
has been added to the -mm tree. Its filename is
checkpatch-add-tests-for-function-pointer-style-misuses.patch

Here's a patch that fixes the two messages I commented about, which applies on top of the version of the patch that went into -mm.

---8<---
From: Josh Triplett <[email protected]>
Subject: [PATCH] Fix up messages from "checkpatch: Add tests for function pointer style misuses"

Fix an ambiguity in one warning message and a copy/paste problem in another.

---
 scripts/checkpatch.pl | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
scripts/checkpatch.pl +2 -2
index 2460094..b74b086 100755
@@ -2831,7 +2831,7 @@ sub process {
 			if (defined $pre_pointer_space &&
 			    $pre_pointer_space =~ /^\s/) {
 				WARN("SPACING",
-				     "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
+				     "Unnecessary space between open parenthesis and '*' in function pointer declaration\n" . $herecurr);
 			}
 
 # unnecessary space "type (* funcptr)(args...)"
@@ -2852,7 +2852,7 @@ sub process {
 			if (defined $pre_args_space &&
 			    $pre_args_space =~ /^\s/) {
 				WARN("SPACING",
-				     "Unnecessary space before function pointer name\n" . $herecurr);
+				     "Unnecessary space before function pointer argument list\n" . $herecurr);
 			}
 
 			if (show_type("SPACING") && $fix) {
Signature · 1 line
1.8.5.2
maintainer Acked-by
#2 lore raw

Re: [PATCH 1/5] checkpatch: Add tests for function pointer style misuses

Quoted 6 lines · Josh Triplett
Quoted 5 lines · Josh Triplett
Quoted 4 lines · Joe Perches

Kernel style uses function pointers in this form:

        "type (*funcptr)(args...)"

Emit warnings when this function pointer form isn't used.

[]

Quoted 2 lines

Here's a patch that fixes the two messages I commented about, which applies on top of the version of the patch that went into -mm.

thanks Josh, Joe