Skip to content
Snippets Groups Projects
checkpatch.pl 88.4 KiB
Newer Older
  • Learn to ignore specific revisions
  • 		}
    
    # warn about unexpectedly long msleep's
    		if ($line =~ /\bmsleep\s*\((\d+)\);/) {
    			if ($1 < 20) {
    				WARN("MSLEEP",
    				     "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
    			}
    		}
    
    # warn about #ifdefs in C files
    #		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
    #			print "#ifdef in C files should be avoided\n";
    #			print "$herecurr";
    #			$clean = 0;
    #		}
    
    # warn about spacing in #ifdefs
    		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
    			ERROR("SPACING",
    			      "exactly one space required after that #$1\n" . $herecurr);
    		}
    
    # check for spinlock_t definitions without a comment.
    		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
    		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
    			my $which = $1;
    			if (!ctx_has_comment($first_line, $linenr)) {
    				CHK("UNCOMMENTED_DEFINITION",
    				    "$1 definition without comment\n" . $herecurr);
    			}
    		}
    # check for memory barriers without a comment.
    		if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
    			if (!ctx_has_comment($first_line, $linenr)) {
    				CHK("MEMORY_BARRIER",
    				    "memory barrier without comment\n" . $herecurr);
    			}
    		}
    # check of hardware specific defines
    		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
    			CHK("ARCH_DEFINES",
    			    "architecture specific defines should be avoided\n" .  $herecurr);
    		}
    
    # Check that the storage class is at the beginning of a declaration
    		if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
    			WARN("STORAGE_CLASS",
    			     "storage class should be at the beginning of the declaration\n" . $herecurr)
    		}
    
    # check the location of the inline attribute, that it is between
    # storage class and type.
    		if ($line =~ /\b$Type\s+$Inline\b/ ||
    		    $line =~ /\b$Inline\s+$Storage\b/) {
    			ERROR("INLINE_LOCATION",
    			      "inline keyword should sit between storage class and type\n" . $herecurr);
    		}
    
    # Check for __inline__ and __inline, prefer inline
    		if ($line =~ /\b(__inline__|__inline)\b/) {
    			WARN("INLINE",
    			     "plain inline is preferred over $1\n" . $herecurr);
    		}
    
    # Check for __attribute__ packed, prefer __packed
    		if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
    			WARN("PREFER_PACKED",
    			     "__packed is preferred over __attribute__((packed))\n" . $herecurr);
    		}
    
    # Check for __attribute__ aligned, prefer __aligned
    		if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
    			WARN("PREFER_ALIGNED",
    			     "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
    		}
    
    # check for sizeof(&)
    		if ($line =~ /\bsizeof\s*\(\s*\&/) {
    			WARN("SIZEOF_ADDRESS",
    			     "sizeof(& should be avoided\n" . $herecurr);
    		}
    
    # check for line continuations in quoted strings with odd counts of "
    		if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
    			WARN("LINE_CONTINUATIONS",
    			     "Avoid line continuations in quoted strings\n" . $herecurr);
    		}
    
    # check for new externs in .c files.
    		if ($realfile =~ /\.c$/ && defined $stat &&
    		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
    		{
    			my $function_name = $1;
    			my $paren_space = $2;
    
    			my $s = $stat;
    			if (defined $cond) {
    				substr($s, 0, length($cond), '');
    			}
    			if ($s =~ /^\s*;/ &&
    			    $function_name ne 'uninitialized_var')
    			{
    				WARN("AVOID_EXTERNS",
    				     "externs should be avoided in .c files\n" .  $herecurr);
    			}
    
    			if ($paren_space =~ /\n/) {
    				WARN("FUNCTION_ARGUMENTS",
    				     "arguments for function declarations should follow identifier\n" . $herecurr);
    			}
    
    		} elsif ($realfile =~ /\.c$/ && defined $stat &&
    		    $stat =~ /^.\s*extern\s+/)
    		{
    			WARN("AVOID_EXTERNS",
    			     "externs should be avoided in .c files\n" .  $herecurr);
    		}
    
    # checks for new __setup's
    		if ($rawline =~ /\b__setup\("([^"]*)"/) {
    			my $name = $1;
    
    			if (!grep(/$name/, @setup_docs)) {
    				CHK("UNDOCUMENTED_SETUP",
    				    "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
    			}
    		}
    
    # check for pointless casting of kmalloc return
    		if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
    			WARN("UNNECESSARY_CASTS",
    			     "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
    		}
    
    # check for multiple semicolons
    		if ($line =~ /;\s*;\s*$/) {
    		    WARN("ONE_SEMICOLON",
    			 "Statements terminations use 1 semicolon\n" . $herecurr);
    		}
    
    
    # check for whitespace before semicolon - not allowed at end-of-line
    		if ($line =~ /\s+;$/) {
    		    WARN("SPACEBEFORE_SEMICOLON",
    			 "Whitespace before semicolon\n" . $herecurr);
    		}
    
    
    # check for gcc specific __FUNCTION__
    		if ($line =~ /__FUNCTION__/) {
    			WARN("USE_FUNC",
    			     "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr);
    		}
    
    # check for semaphores initialized locked
    		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
    			WARN("CONSIDER_COMPLETION",
    			     "consider using a completion\n" . $herecurr);
    
    		}
    # recommend kstrto* over simple_strto*
    		if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
    			WARN("CONSIDER_KSTRTO",
    			     "consider using kstrto* in preference to simple_$1\n" . $herecurr);
    		}
    # check for __initcall(), use device_initcall() explicitly please
    		if ($line =~ /^.\s*__initcall\s*\(/) {
    			WARN("USE_DEVICE_INITCALL",
    			     "please use device_initcall() instead of __initcall()\n" . $herecurr);
    		}
    # check for various ops structs, ensure they are const.
    		my $struct_ops = qr{acpi_dock_ops|
    				address_space_operations|
    				backlight_ops|
    				block_device_operations|
    				dentry_operations|
    				dev_pm_ops|
    				dma_map_ops|
    				extent_io_ops|
    				file_lock_operations|
    				file_operations|
    				hv_ops|
    				ide_dma_ops|
    				intel_dvo_dev_ops|
    				item_operations|
    				iwl_ops|
    				kgdb_arch|
    				kgdb_io|
    				kset_uevent_ops|
    				lock_manager_operations|
    				microcode_ops|
    				mtrr_ops|
    				neigh_ops|
    				nlmsvc_binding|
    				pci_raw_ops|
    				pipe_buf_operations|
    				platform_hibernation_ops|
    				platform_suspend_ops|
    				proto_ops|
    				rpc_pipe_ops|
    				seq_operations|
    				snd_ac97_build_ops|
    				soc_pcmcia_socket_ops|
    				stacktrace_ops|
    				sysfs_ops|
    				tty_operations|
    				usb_mon_operations|
    				wd_ops}x;
    		if ($line !~ /\bconst\b/ &&
    		    $line =~ /\bstruct\s+($struct_ops)\b/) {
    			WARN("CONST_STRUCT",
    			     "struct $1 should normally be const\n" .
    				$herecurr);
    		}
    
    # use of NR_CPUS is usually wrong
    # ignore definitions of NR_CPUS and usage to define arrays as likely right
    		if ($line =~ /\bNR_CPUS\b/ &&
    		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
    		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
    		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
    		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
    		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
    		{
    			WARN("NR_CPUS",
    			     "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
    		}
    
    # check for %L{u,d,i} in strings
    		my $string;
    		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
    			$string = substr($rawline, $-[1], $+[1] - $-[1]);
    			$string =~ s/%%/__/g;
    			if ($string =~ /(?<!%)%L[udi]/) {
    				WARN("PRINTF_L",
    				     "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
    				last;
    			}
    		}
    
    # whine mightly about in_atomic
    		if ($line =~ /\bin_atomic\s*\(/) {
    			if ($realfile =~ m@^drivers/@) {
    				ERROR("IN_ATOMIC",
    				      "do not use in_atomic in drivers\n" . $herecurr);
    			} elsif ($realfile !~ m@^kernel/@) {
    				WARN("IN_ATOMIC",
    				     "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
    			}
    		}
    
    # check for lockdep_set_novalidate_class
    		if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
    		    $line =~ /__lockdep_no_validate__\s*\)/ ) {
    			if ($realfile !~ m@^kernel/lockdep@ &&
    			    $realfile !~ m@^include/linux/lockdep@ &&
    			    $realfile !~ m@^drivers/base/core@) {
    				ERROR("LOCKDEP",
    				      "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
    			}
    		}
    
    		if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
    		    $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
    			WARN("EXPORTED_WORLD_WRITABLE",
    			     "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
    		}
    
    		# Check for memset with swapped arguments
    		if ($line =~ /memset.*\,(\ |)(0x|)0(\ |0|)\);/) {
    			ERROR("MEMSET",
    			      "memset size is 3rd argument, not the second.\n" . $herecurr);
    		}
    	}
    
    	# If we have no input at all, then there is nothing to report on
    	# so just keep quiet.
    	if ($#rawlines == -1) {
    		exit(0);
    	}
    
    	# In mailback mode only produce a report in the negative, for
    	# things that appear to be patches.
    	if ($mailback && ($clean == 1 || !$is_patch)) {
    		exit(0);
    	}
    
    	# This is not a patch, and we are are in 'no-patch' mode so
    	# just keep quiet.
    	if (!$chk_patch && !$is_patch) {
    		exit(0);
    	}
    
    	if (!$is_patch) {
    		ERROR("NOT_UNIFIED_DIFF",
    		      "Does not appear to be a unified-diff format patch\n");
    	}
    	if ($is_patch && $chk_signoff && $signoff == 0) {
    		ERROR("MISSING_SIGN_OFF",
    		      "Missing Signed-off-by: line(s)\n");
    	}
    
    	print report_dump();
    	if ($summary && !($clean == 1 && $quiet == 1)) {
    		print "$filename " if ($summary_file);
    		print "total: $cnt_error errors, $cnt_warn warnings, " .
    			(($check)? "$cnt_chk checks, " : "") .
    			"$cnt_lines lines checked\n";
    		print "\n" if ($quiet == 0);
    	}
    
    	if ($quiet == 0) {
    		# If there were whitespace errors which cleanpatch can fix
    		# then suggest that.
    		if ($rpt_cleaners) {
    			print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
    			print "      scripts/cleanfile\n\n";
    			$rpt_cleaners = 0;
    		}
    	}
    
    	if (keys %ignore_type) {
    	    print "NOTE: Ignored message types:";
    	    foreach my $ignore (sort keys %ignore_type) {
    		print " $ignore";
    	    }
    	    print "\n";
    	    print "\n" if ($quiet == 0);
    	}
    
    	if ($clean == 1 && $quiet == 0) {
    		print "$vname has no obvious style problems and is ready for submission.\n"
    	}
    	if ($clean == 0 && $quiet == 0) {
    		print << "EOM";
    $vname has style problems, please review.
    
    If any of these errors are false positives, please report
    them to the maintainer, see CHECKPATCH in MAINTAINERS.
    EOM
    	}
    
    	return $clean;
    }