Remove stray libavcore and _g binary references.
[libav.git] / tools / patcheck
CommitLineData
6c2dd77e
MN
1#!/bin/sh
2
09d7da86
RC
3# if no argument provided, write stdin to a file and re-run the script
4if [ $# = 0 ]; then
5 cat > patcheck.stdout
6 $0 patcheck.stdout
7 rm -f patcheck.stdout
8 exit
9fi
10
6c2dd77e
MN
11TMP=patcheck.tmp
12OPT="-nH"
13#FILES=`grep '^+++' $* | sed 's/+++ //g'`
14
15echo patCHeck 1e10.0
16echo This tool is intended to help a human check/review patches it is very far from
17echo being free of false positives and negatives, its output are just hints of what
18echo may or may not be bad. When you use it and it misses something or detects
14622ef0 19echo something wrong, fix it and send a patch to the libav-devel mailing list.
6c2dd77e
MN
20echo License:GPL Autor: Michael Niedermayer
21
22ERE_PRITYP='(unsigned *|)(char|short|long|int|long *int|short *int|void|float|double|(u|)int(8|16|32|64)_t)'
23ERE_TYPES='(const|static|av_cold|inline| *)*('$ERE_PRITYP'|[a-zA-Z][a-zA-Z0-9_]*)[* ]{1,}[a-zA-Z][a-zA-Z0-9_]*'
24ERE_FUNCS="$ERE_TYPES"' *\('
25
26hiegrep(){
27 arg="$1"
28 msg="$2"
29 shift 2
f11c9ee9 30 grep $OPT '^+' $* | grep -v ':+++'| egrep --color=always -- "$arg"> $TMP && printf "\n$msg\n"
6c2dd77e
MN
31 cat $TMP
32}
33
3d8f9025
MN
34hiegrep2(){
35 arg="$1"
36 varg="$2"
37 msg="$3"
38 shift 3
f11c9ee9 39 grep $OPT '^+' $* | grep -v ':+++' | egrep -v -- "$varg" | egrep --color=always -- "$arg" > $TMP && printf "\n$msg\n"
3d8f9025
MN
40 cat $TMP
41}
42
6c2dd77e
MN
43hiegrep '[[:space:]]$' 'trailing whitespace' $*
44hiegrep "`echo x | tr 'x' '\t'`" 'tabs' $*
45#hiegrep ':\+$' 'Empty lines' $*
46hiegrep ';;' 'double ;' $*
74892f7a 47hiegrep2 '\b_[a-zA-Z0-9_]{1,}' '__(asm|attribute)([^a-zA-Z0-9]|$)' 'reserved identifer' $*
6c2dd77e
MN
48hiegrep '//[-/<\* ]*$' 'empty comment' $*
49hiegrep '/\*[-<\* ]*\*/' 'empty comment' $*
50hiegrep 'for *\( *'"$ERE_PRITYP"' ' 'not gcc 2.95 compatible' $*
be3e68b2 51hiegrep '(static|inline|const) *\1' 'duplicate word' $*
9e793a24 52hiegrep 'INIT_VLC_USE_STATIC' 'forbidden ancient vlc type' $*
35614edb 53hiegrep '=[-+\*\&] ' 'looks like compound assignment' $*
78db142a 54hiegrep2 '/\*\* *[a-zA-Z0-9].*' '\*/' 'Inconsistently formatted doxygen comment' $*
3ea4d942 55hiegrep '; */\*\*[^<]' 'Misformatted doxygen comment' $*
6c2dd77e 56
3d8f9025 57hiegrep2 '(int|unsigned|static|void)[a-zA-Z0-9 _]*(init|end)[a-zA-Z0-9 _]*\(.*[^;]$' '(av_cold|:\+[^a-zA-Z_])' 'These functions may need av_cold, please review the whole patch for similar functions needing av_cold' $*
6c2dd77e
MN
58
59hiegrep '\+= *1 *;' 'can be simplified to ++' $*
60hiegrep '-= *1 *;' 'can be simplified to --' $*
61hiegrep '((!|=)= *(0|NULL)[^0-9a-z]|[^0-9a-z](0|NULL) *(!|=)=)' 'x==0 / x!=0 can be simplified to !x / x' $*
62
f11c9ee9 63egrep $OPT '^\+ *(const *|)static' $*| egrep --color=always '[^=]= *(0|NULL)[^0-9a-zA-Z]'> $TMP && printf '\nuseless 0 init\n'
6c2dd77e
MN
64cat $TMP
65hiegrep '# *ifdef * (HAVE|CONFIG)_' 'ifdefs that should be #if' $*
66
67hiegrep '\b(awnser|cant|dont|quantised|quantisation|teh|wont)\b' 'common typos' $*
68
69hiegrep 'av_log\( *NULL' 'Missing context in av_log' $*
70hiegrep '[^sn]printf' 'Please use av_log' $*
71hiegrep '\bmalloc' 'Please use av_malloc' $*
72hiegrep '\) *av_malloc' 'useless casts' $*
73hiegrep ':\+ *'"$ERE_PRITYP"' *inline' 'non static inline or strangely ordered inline+static' $*
74hiegrep "$ERE_FUNCS"' *\)' 'missing void' $*
75hiegrep '(sprintf|strcat|strcpy)' 'Possible security issue, make sure this is safe or use snprintf/av_strl*' $*
76hiegrep '/ *(2|4|8|16|32|64|128|256|512|1024|2048|4096|8192|16384|32768|65536)[^0-9]' 'divide by 2^x could use >> maybe' $*
77hiegrep '#(el|)if *(0|1)' 'useless #if' $*
78hiegrep 'if *\( *(0|1) *\)' 'useless if()' $*
79hiegrep '& *[a-zA-Z0-9_]* *\[ *0 *\]' 'useless & [0]' $*
80hiegrep '(\( *[0-9] *(&&|\|\|)|(&&|\|\|) *[0-9] *\))' 'overriding condition' $*
214ee5f5
MN
81hiegrep '(:\+|,|;)( *|static|\*)*'"$ERE_PRITYP"' *\*( |\*)*(src|source|input|in[^a-z])' 'missing const?' $*
82hiegrep '(:\+|,|;)( *|static|\*)*'"$ERE_PRITYP"' *(src|source|input|in)([0-9A-Z_][0-9A-Za-z_]*){1,} *\[' 'missing const (test2)?' $*
70ec53a0 83hiegrep ' *static *'"$ERE_FUNCS"'[^)]*\);' 'static prototype, maybe you should reorder your functions' $*
c4e12a9f 84hiegrep '@file: *[a-zA-Z0-9_]' 'doxy filetag with filename can in the future cause problems when forgotten during a rename' $*
6c2dd77e 85
3d8f9025 86hiegrep2 '\.long_name *=' 'NULL_IF_CONFIG_SMAL' 'missing NULL_IF_CONFIG_SMAL' $*
4a0cf686
DV
87hiegrep2 '\.pix_fmts *= *\(' 'const' 'missing const for pix_fmts array' $*
88hiegrep2 '\.sample_fmts *= *\(' 'const' 'missing const for sample_fmts array' $*
89hiegrep2 '\.supported_framerates *= *\(' 'const' 'missing const for supported_framerates array' $*
90hiegrep2 '\.channel_layouts *= *\(' 'const' 'missing const for channel_layouts array' $*
6c2dd77e 91
f11c9ee9 92#egrep $OPT '^\+.*const ' $*| grep -v 'static'> $TMP && printf '\nnon static const\n'
6c2dd77e
MN
93#cat $TMP
94
3d8f9025 95hiegrep2 "$ERE_TYPES" '(static|av_|ff_|typedef|:\+[^a-zA-Z_])' 'Non static with no ff_/av_ prefix' $*
6c2dd77e 96
0f485a9c 97hiegrep ':\+[^}#]*else' 'missing } prior to else' $*
54ce8a4c
MN
98hiegrep '(if|while|for)\(' 'missing whitespace between keyword and ( (feel free to ignore)' $*
99hiegrep '(else|do){' 'missing whitespace between keyword and { (feel free to ignore)' $*
100hiegrep '}(else|while)' 'missing whitespace between } and keyword (feel free to ignore)' $*
6c2dd77e
MN
101
102#FIXME this should print the previous statement maybe
103hiegrep ':\+ *{ *$' '{ should be on the same line as the related previous statement' $*
104
105
106rm $TMP
6c25f346 107for i in `grep -H '^+.*@param' $*| sed 's/^\([^:]*\):.*@param\(\[.*\]\|\) *\([a-zA-Z0-9_]*\) .*$/\1:\3/'` ; do
6c2dd77e
MN
108 doxpar=`echo $i | sed 's/^.*:\(.*\)$/\1/'`
109 file=`echo $i | sed 's/^\([^:]*\):.*$/\1/'`
110 grep " *$doxpar *[),]" $file | grep -v '@param' >/dev/null || grep --color=always "@param *$doxpar" $file >>$TMP
111done
112if test -e $TMP ; then
f11c9ee9 113 printf '\nmismatching doxy params\n'
6c2dd77e
MN
114 cat $TMP
115fi
116
f11c9ee9 117egrep -B2 $OPT '^(\+|) *('"$ERE_TYPES"'|# *define)' $* | egrep -A2 --color=always '(:|-)\+[^/]*/(\*([^*]|$)|/([^/]|$))' > $TMP && printf "\n Non doxy comments\n"
6c2dd77e
MN
118cat $TMP
119
120rm $TMP
121for i in \
122 `egrep -H '^\+ *'"$ERE_TYPES" $* |\
123 grep -v '(' | egrep -v '\Wgoto\W' |\
124 xargs -d '\n' -n 1 |\
125 grep -o '[* ][* ]*[a-zA-Z][0-9a-zA-Z_]* *[,;=]' |\
126 sed 's/.[* ]*\([a-zA-Z][0-9a-zA-Z_]*\) *[,;=]/\1/'` \
127 ; do
128 echo $i | grep '^NULL$' && continue
129 egrep $i' *(\+|-|\*|/|\||&|%|)=[^=]' $* >/dev/null || echo "possibly never written:"$i >> $TMP
b6c265ec 130 egrep '(=|\(|return).*'$i'(==|[^=])*$' $* >/dev/null || echo "possibly never read :"$i >> $TMP
6c2dd77e
MN
131 egrep -o $i' *((\+|-|\*|/|\||&|%|)=[^=]|\+\+|--) *(0x|)[0-9]*(;|)' $* |\
132 egrep -v $i' *= *(0x|)[0-9]{1,};'>/dev/null || echo "possibly constant :"$i >> $TMP
133done
134if test -e $TMP ; then
f11c9ee9 135 printf '\npossibly unused variables\n'
6c2dd77e
MN
136 cat $TMP
137fi
138
2543c7fb 139grep '^+++ .*Changelog' $* >/dev/null || printf "\nMissing changelog entry (ignore if minor change)\n"
6c2dd77e 140
f11c9ee9 141cat $* | tr '\n' '@' | egrep --color=always -o '(fprintf|av_log|printf)\([^)]*\)[+ ;@]*\1' >$TMP && printf "\nMergeable calls\n"
6c2dd77e
MN
142cat $TMP | tr '@' '\n'
143
f11c9ee9 144cat $* | tr '\n' '@' | egrep --color=always -o '\+ *if *\( *([A-Za-z0-9_]*) *[<>]=? *[0-9]* *\) * \1 *= *[0-9]* *;[ @\\+]*else *if *\( *\1 *[<>]=? *[0-9]* *\) *\1 *= *[0-9]* *;' >$TMP && printf "\nav_clip / av_clip_uint8 / av_clip_int16 / ...\n"
6c2dd77e
MN
145cat $TMP | tr '@' '\n'
146
f11c9ee9 147cat $* | tr '\n' '@' | egrep --color=always -o '\+ *if *\( *([A-Za-z0-9_]*) *[<>]=? *([A-Za-z0-9_]*) *\)[ @\\+]*(\1|\2) *= *(\1|\2) *;' >$TMP && printf "\nFFMIN/FFMAX\n"
6c2dd77e
MN
148cat $TMP | tr '@' '\n'
149
f11c9ee9 150cat $* | tr '\n' '@' | egrep --color=always -o '\+ *if *\( *([A-Za-z0-9_]*) *\)[ @\\+]*av_free(p|) *\( *(&|) *\1[^-.]' >$TMP && printf "\nav_free(NULL) is safe\n"
6c2dd77e
MN
151cat $TMP | tr '@' '\n'
152
f11c9ee9 153cat $* | tr '\n' '@' | egrep --color=always -o '[^a-zA-Z0-9_]([a-zA-Z0-9_]*) *= *av_malloc *\([^)]*\)[ @;\\+]*memset *\( *\1' >$TMP && printf "\nav_mallocz()\n"
6c2dd77e
MN
154cat $TMP | tr '@' '\n'
155
156
157# doesnt work
f11c9ee9 158#cat $* | tr '\n' '@' | egrep -o '[^a-zA-Z_0-9]([a-zA-Z][a-zA-Z_0-9]*) *=[^=].*\1' | egrep -o '[^a-zA-Z_0-9]([a-zA-Z][a-zA-Z_0-9]*) *=[^=].*\1 *=[^=]' >$TMP && printf "\nPossibly written 2x before read\n"
6c2dd77e
MN
159#cat $TMP | tr '@' '\n'
160
161exit
162
163TODO/idea list:
164
165for all demuxers & muxers
166 grep for "avctx->priv_data"
167
168vertical align =
169/* and * align
170arrays fitting in smaller types
171variables written to twice with no interspaced read
172memset(block, 0, 6*64*sizeof(DCTELEM)); -> clear_blocks
173check existence of long_name in AVCodec
174check that the patch does not touch codec & (de)muxer layer at the same time ->split
175
176write a regression test containing at least a line that triggers each warning once