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