Script to check for undefined Kconfig symbols - v2
Quoted 23 lines · On Fri, 24 Aug 2007 Randy Dunlap wrote:
Quoted 21 lines · On Fri, 24 Aug 2007 16:56:49 +0200 Paolo 'Blaisorblade' Giarrusso wrote:
In this version, I've updated the scripts to search for "\<$symb_bare\>" instead of $symb_bare in
Kconfigfiles. Please ignore my previous message.To avoid to look manually for used but undefined
Kconfigvariables, I've written a script which tries do this efficiently, in case all other attention fail. It accounts for_MODULEsuffix and forUML_prefixes toKconfigvariable, but otherwise looks for exact matches (i.e. \<CONFIG_; this is done to exclude macros likeMMCONFIG_).Undefined
Kconfigvariables should be not be removed without care, but for instancearch/i386/boot/uses a bunch of undefinedKconfigvars:$ scripts/checkunknowndefines.sh arch/i386/boot/ arch/i386/boot/video.h uses undefined symbol VIDEO_400_HACK arch/i386/boot/video-vga.c uses undefined symbol VIDEO_400_HACK arch/i386/boot/video.c uses undefined symbol VIDEO_RETAIN arch/i386/boot/video.h uses undefined symbol VIDEO_RETAIN arch/i386/boot/video.h uses undefined symbol VIDEO_SVGA arch/i386/boot/video.h uses undefined symbol VIDEO_VESA arch/i386/boot/video-vesa.c uses undefined symbol VIDEO_VESA
Quoted 5 lines
Quoted 3 lines
Hope you can merge this in -mm and use it frequently (probably, a script to look for regressions in its output is useful). It should also be mentioned in SubmittingPatches if you agree.
or added to
Documentation/SubmitChecklist.
Indeed - that's what I should have written, but I had forgot the exact file name.
Quoted 5 lines
How does this script compare to
http://www.fsdev.net/wiki/index.php?title=Misspelled_CONFIG_variables
and
http://www.fsdev.net/wiki/index.php?title=Dead_CONFIG_variables
?
They are the same, but they do not identify the files containing the dead var. It may be worth to just "grep back" in kernel sources for the dead symbol to readd this feature, but it may be slower that way.
The difference is that since I find symbols together with file name, I cannot use uniq but I must use that awk script.
Anyway, do we agree that a script for this should be probably merged in kernel sources?
Thanks for your answer.
Quoted 68 lines
Quoted 68 lines
Signed-off-by Paolo 'Blaisorblade' Giarrusso <[email protected]>---
scripts/checkunknowndefines.sh | 59 ++++++++++++++++++++++++++++++++++++++++ 1 files changed, 59 insertions(+), 0 deletions(-)scripts/checkunknowndefines.sh new file +56
-0@@ -0,0 +1,59 @@ +#!/bin/sh +# Find Kconfig variables used in source code but never defined in Kconfig +# Copyright (C) 2007, Paolo 'Blaisorblade' Giarrusso <[email protected]> + +# Tested with dash. +paths="$@" +[ -z "$paths" ] && paths=. + +# Doing this once at the beginning saves a lot of time, on a cache-hot tree. +Kconfigs="`find . -name 'Kconfig' -o -name 'Kconfig*[^~]'`" + +echo "File list \tundefined symbol used" +find $paths -name '*.[chS]' -o -name 'Makefile' -o -name 'Makefile*[^~]'| while read i +do + # Output the bare Kconfig variable and the filename; the _MODULE part at + # the end is not removed here (would need perl an not-hungry regexp for that). + sed -ne 's!^.*\<\(UML_\)\?CONFIG_\([0-9A-Z_]\+\).*!\2 '$i'!p' < $i +done | \ +# Smart "sort|uniq" implemented in awk and tuned to collect the names of all +# files which use a given symbol +awk '{map[$1, count[$1]++] = $2; } +END { + for (combIdx in map) { + split(combIdx, separate, SUBSEP); + # The value may have been removed. + if (! ( (separate[1], separate[2]) in map ) ) + continue; + symb=separate[1]; + printf "%s ", symb; + #Use gawk extension to delete the names vector + delete names; + #Portably delete the names vector + #split("", names); + for (i=0; i < count[symb]; i++) { + names[map[symb, i]] = 1; + # Unfortunately, we may still encounter symb, i in the + # outside iteration. + delete map[symb, i]; + } + i=0; + for (name in names) { + if (i > 0) + printf ", %s", name; + else + printf "%s", name; + i++; + } + printf "\n"; + } +}' | +while read symb files; do + # Remove the _MODULE suffix when checking the variable name. This should + # be done only on tristate symbols, actually, but Kconfig parsing is + # beyond the purpose of this script. + symb_bare=`echo $symb | sed -e 's/_MODULE//'` + if ! grep -q "\<$symb_bare\>" $Kconfigs; then
Quoted 8 lines
scripts/checkunknowndefines.sh line 59
Quoted 3 lines
scripts/checkunknowndefines.sh new file +3
-0+ echo "$files: \t$symb" + fi +done|sort---
~Randy
*** Remember to useDocumentation/SubmitChecklistwhen testing your code ***
___________________________________
L'email della prossima generazione? Puoi averla con la nuova Yahoo! Mail: http://it.docs.yahoo.com/nowyoucan.html
Quoted 41 lines · Paolo Giarrusso
Quoted 23 lines · On Fri, 24 Aug 2007 Randy Dunlap wrote:
Quoted 21 lines · On Fri, 24 Aug 2007 16:56:49 +0200 Paolo 'Blaisorblade' Giarrusso wrote:
In this version, I've updated the scripts to search for "\<$symb_bare\>" instead of $symb_bare in
Kconfigfiles. Please ignore my previous message.To avoid to look manually for used but undefined
Kconfigvariables, I've written a script which tries do this efficiently, in case all other attention fail. It accounts for_MODULEsuffix and forUML_prefixes toKconfigvariable, but otherwise looks for exact matches (i.e. \<CONFIG_; this is done to exclude macros likeMMCONFIG_).Undefined
Kconfigvariables should be not be removed without care, but for instancearch/i386/boot/uses a bunch of undefinedKconfigvars:$ scripts/checkunknowndefines.sh arch/i386/boot/ arch/i386/boot/video.h uses undefined symbol VIDEO_400_HACK arch/i386/boot/video-vga.c uses undefined symbol VIDEO_400_HACK arch/i386/boot/video.c uses undefined symbol VIDEO_RETAIN arch/i386/boot/video.h uses undefined symbol VIDEO_RETAIN arch/i386/boot/video.h uses undefined symbol VIDEO_SVGA arch/i386/boot/video.h uses undefined symbol VIDEO_VESA arch/i386/boot/video-vesa.c uses undefined symbol VIDEO_VESAQuoted 4 lines
Quoted 3 lines
Hope you can merge this in -mm and use it frequently (probably, a script to look for regressions in its output is useful). It should also be mentioned in SubmittingPatches if you agree.
or added to
Documentation/SubmitChecklist.Indeed - that's what I should have written, but I had forgot the exact file name.
Quoted 5 lines
How does this script compare to
http://www.fsdev.net/wiki/index.php?title=Misspelled_CONFIG_variables
and
http://www.fsdev.net/wiki/index.php?title=Dead_CONFIG_variables
?They are the same, but they do not identify the files containing the dead var. It may be worth to just "grep back" in kernel sources for the dead symbol to readd this feature, but it may be slower that way.
Quoted 7 lines
The difference is that since I find symbols together with file name, I cannot use uniq but I must use that awk script.
Anyway, do we agree that a script for this should be probably merged in kernel sources?
Thanks for your answer.
Yes, I agree that it's useful and more convenient to be in linux/scripts/.
Signature · 2 lines
~Randy *** Remember to use Documentation/SubmitChecklist when testing your code ***