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