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