Add a target to use the Coccinelle checker
A 'coccicheck' target is added. It can be called with four different modes. Each one generates a different kind of output, i.e. context, patch, org, report, according to the corresponding mode to be activated. The new target calls the 'coccicheck' front-end in the 'scripts' directory with the MODE argument. Every SmPL file in the subdirectories of 'scripts/coccinelle' is then given to the front-end and applied to the entire source tree. The four modes behave as follows: 'report' generates a list in the following format: file:line:column-column: message 'patch' proposes a fix, when possible. 'context' highlights lines of interest and their context in a diff-like style. Lines of interest are indicated with '-'. 'org' generates a report in the Org mode format of Emacs. Signed-off-by: Nicolas Palix <npalix@diku.dk> Signed-off-by: Julia Lawall <julia@diku.dk> Acked-by: Sam Ravnborg <sam@ravnborg.org> Acked-by: Joerg Roedel <joerg.roedel@amd.com> Signed-off-by: Michal Marek <mmarek@suse.cz>
This commit is contained in:
		
							parent
							
								
									64ffc9ff42
								
							
						
					
					
						commit
						74425eee71
					
				
							
								
								
									
										10
									
								
								MAINTAINERS
									
									
									
									
									
								
							
							
						
						
									
										10
									
								
								MAINTAINERS
									
									
									
									
									
								
							| @ -1476,6 +1476,16 @@ M:	Daniel Oliveira Nascimento <don@syst.com.br> | ||||
| S:	Supported | ||||
| F:	drivers/platform/x86/classmate-laptop.c | ||||
| 
 | ||||
| COCCINELLE/Semantic Patches (SmPL) | ||||
| M:	Julia Lawall <julia@diku.dk> | ||||
| M:	Gilles Muller <Gilles.Muller@lip6.fr> | ||||
| M:	Nicolas Palix <npalix@diku.dk> | ||||
| L:	cocci@diku.dk (moderated for non-subscribers) | ||||
| W:	http://coccinelle.lip6.fr/ | ||||
| S:	Supported | ||||
| F:	scripts/coccinelle/ | ||||
| F:	scripts/coccicheck | ||||
| 
 | ||||
| CODA FILE SYSTEM | ||||
| M:	Jan Harkes <jaharkes@cs.cmu.edu> | ||||
| M:	coda@cs.cmu.edu | ||||
|  | ||||
							
								
								
									
										10
									
								
								Makefile
									
									
									
									
									
								
							
							
						
						
									
										10
									
								
								Makefile
									
									
									
									
									
								
							| @ -412,7 +412,7 @@ endif | ||||
| # of make so .config is not included in this case either (for *config).
 | ||||
| 
 | ||||
| no-dot-config-targets := clean mrproper distclean \
 | ||||
| 			 cscope TAGS tags help %docs check% \
 | ||||
| 			 cscope TAGS tags help %docs check% coccicheck \
 | ||||
| 			 include/linux/version.h headers_% \
 | ||||
| 			 kernelrelease kernelversion | ||||
| 
 | ||||
| @ -1279,8 +1279,9 @@ help: | ||||
| 	@echo  '  includecheck    - Check for duplicate included header files' | ||||
| 	@echo  '  export_report   - List the usages of all exported symbols' | ||||
| 	@echo  '  headers_check   - Sanity check on exported headers' | ||||
| 	@echo  '  headerdep       - Detect inclusion cycles in headers'; \
 | ||||
| 	 echo  '' | ||||
| 	@echo  '  headerdep       - Detect inclusion cycles in headers' | ||||
| 	@$(MAKE) -f $(srctree)/scripts/Makefile.help checker-help | ||||
| 	@echo  '' | ||||
| 	@echo  'Kernel packaging:' | ||||
| 	@$(MAKE) $(build)=$(package-dir) help | ||||
| 	@echo  '' | ||||
| @ -1439,6 +1440,9 @@ versioncheck: | ||||
| 		-name '*.[hcS]' -type f -print | sort \
 | ||||
| 		| xargs $(PERL) -w $(srctree)/scripts/checkversion.pl | ||||
| 
 | ||||
| coccicheck: | ||||
| 	$(Q)$(CONFIG_SHELL) $(srctree)/scripts/$@ | ||||
| 
 | ||||
| namespacecheck: | ||||
| 	$(PERL) $(srctree)/scripts/namespace.pl | ||||
| 
 | ||||
|  | ||||
							
								
								
									
										3
									
								
								scripts/Makefile.help
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										3
									
								
								scripts/Makefile.help
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,3 @@ | ||||
| 
 | ||||
| checker-help: | ||||
| 	@echo  '  coccicheck      - Check with Coccinelle.' | ||||
							
								
								
									
										54
									
								
								scripts/coccicheck
									
									
									
									
									
										Executable file
									
								
							
							
						
						
									
										54
									
								
								scripts/coccicheck
									
									
									
									
									
										Executable file
									
								
							| @ -0,0 +1,54 @@ | ||||
| #!/bin/sh | ||||
| 
 | ||||
| SPATCH="`which ${SPATCH:=spatch}`" | ||||
| 
 | ||||
| if [ ! -x "$SPATCH" ]; then | ||||
|     echo 'spatch is part of the Coccinelle project and is available at http://coccinelle.lip6.fr/' | ||||
|     exit 1 | ||||
| fi | ||||
| 
 | ||||
| if [ "$MODE" = "" ] ; then | ||||
|     echo 'You have not explicitly specify the mode to use. Fallback to "report".' | ||||
|     echo 'You can specify the mode with "make coccicheck MODE=<mode>"' | ||||
|     echo 'Available modes are: report, patch, context, org' | ||||
|     MODE="report" | ||||
| fi | ||||
| 
 | ||||
| echo '' | ||||
| echo 'Please check for false positives in the output before submitting a patch.' | ||||
| echo 'When using "patch" mode, carefully review the patch before submitting it.' | ||||
| echo '' | ||||
| 
 | ||||
| function coccinelle { | ||||
|     COCCI="$1" | ||||
|     DIR="$2" | ||||
| 
 | ||||
|     OPT=`grep "Option" $COCCI | cut -d':' -f2` | ||||
|     FILE=`echo $COCCI | sed "s|$DIR/||"` | ||||
| 
 | ||||
|     echo "Processing `basename $COCCI` with option(s) \"$OPT\"" | ||||
|     echo 'Message example to submit a patch:' | ||||
| 
 | ||||
|     sed -e '/\/\/\//!d' -e 's|^///||' $COCCI | ||||
| 
 | ||||
|     echo ' The semantic patch that makes this change is available' | ||||
|     echo " in $FILE." | ||||
|     echo '' | ||||
|     echo ' More information about semantic patching is available at' | ||||
|     echo ' http://coccinelle.lip6.fr/' | ||||
|     echo '' | ||||
| 
 | ||||
| #   The option '-parse_cocci' can be used to syntaxically check the SmPL files. | ||||
| # | ||||
| #    $SPATCH -D $MODE -very_quiet -parse_cocci $COCCI $OPT > /dev/null | ||||
| 
 | ||||
|     $SPATCH -D $MODE -very_quiet -sp_file $COCCI $OPT -dir $DIR | ||||
| } | ||||
| 
 | ||||
| if [ "$COCCI" = "" ] ; then | ||||
|     for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do | ||||
| 	coccinelle $f $srctree; | ||||
|     done | ||||
| else | ||||
|     coccinelle $COCCI $srctree | ||||
| fi | ||||
		Loading…
	
		Reference in New Issue
	
	Block a user