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