patcheck 8.36 KB
Newer Older
Michael Niedermayer's avatar
Michael Niedermayer committed
1 2
#!/bin/sh

3 4 5 6 7 8 9 10
# if no argument provided, write stdin to a file and re-run the script
if [ $# = 0 ]; then
    cat > patcheck.stdout
    $0 patcheck.stdout
    rm -f patcheck.stdout
    exit
fi

11 12
GREP=grep
EGREP=egrep
Michael Niedermayer's avatar
Michael Niedermayer committed
13 14
TMP=patcheck.tmp
OPT="-nH"
15
#FILES=$($GREP '^+++' $* | sed 's/+++ //g')
Michael Niedermayer's avatar
Michael Niedermayer committed
16 17 18 19 20

echo patCHeck 1e10.0
echo This tool is intended to help a human check/review patches it is very far from
echo being free of false positives and negatives, its output are just hints of what
echo may or may not be bad. When you use it and it misses something or detects
21
echo something wrong, fix it and send a patch to the libav-devel mailing list.
Michael Niedermayer's avatar
Michael Niedermayer committed
22 23 24 25 26 27 28 29 30 31
echo License:GPL Autor: Michael Niedermayer

ERE_PRITYP='(unsigned *|)(char|short|long|int|long *int|short *int|void|float|double|(u|)int(8|16|32|64)_t)'
ERE_TYPES='(const|static|av_cold|inline| *)*('$ERE_PRITYP'|[a-zA-Z][a-zA-Z0-9_]*)[* ]{1,}[a-zA-Z][a-zA-Z0-9_]*'
ERE_FUNCS="$ERE_TYPES"' *\('

hiegrep(){
    arg="$1"
    msg="$2"
    shift 2
32
    $GREP $OPT '^+' $* | $GREP -v ':+++'| $EGREP --color=always -- "$arg"> $TMP && printf "\n$msg\n"
Michael Niedermayer's avatar
Michael Niedermayer committed
33 34 35
    cat $TMP
}

Michael Niedermayer's avatar
Michael Niedermayer committed
36 37 38 39 40
hiegrep2(){
    arg="$1"
    varg="$2"
    msg="$3"
    shift 3
41
    $GREP $OPT '^+' $* | $GREP -v ':+++' | $EGREP -v -- "$varg" | $EGREP --color=always -- "$arg" > $TMP && printf "\n$msg\n"
Michael Niedermayer's avatar
Michael Niedermayer committed
42 43 44
    cat $TMP
}

Michael Niedermayer's avatar
Michael Niedermayer committed
45
hiegrep '[[:space:]]$'    'trailing whitespace' $*
46
hiegrep "$(echo x | tr 'x' '\t')"         'tabs' $*
Michael Niedermayer's avatar
Michael Niedermayer committed
47 48
#hiegrep ':\+$'          'Empty lines' $*
hiegrep ';;'              'double ;' $*
49
hiegrep2 '\b_[a-zA-Z0-9_]{1,}' '__(asm|attribute)([^a-zA-Z0-9]|$)' 'reserved identifer' $*
Michael Niedermayer's avatar
Michael Niedermayer committed
50 51 52
hiegrep '//[-/<\* ]*$'    'empty comment' $*
hiegrep '/\*[-<\* ]*\*/'  'empty comment' $*
hiegrep 'for *\( *'"$ERE_PRITYP"' '  'not gcc 2.95 compatible' $*
53
hiegrep '(static|inline|const) *\1'  'duplicate word' $*
54
hiegrep 'INIT_VLC_USE_STATIC' 'forbidden ancient vlc type' $*
55
hiegrep '=[-+\*\&] ' 'looks like compound assignment' $*
56
hiegrep2 '/\*\* *[a-zA-Z0-9].*' '\*/' 'Inconsistently formatted doxygen comment' $*
57
hiegrep '; */\*\*[^<]' 'Misformatted doxygen comment' $*
58
hiegrep '//!|/\*!' 'inconsistent doxygen syntax' $*
Michael Niedermayer's avatar
Michael Niedermayer committed
59

Michael Niedermayer's avatar
Michael Niedermayer committed
60
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' $*
Michael Niedermayer's avatar
Michael Niedermayer committed
61 62 63 64 65

hiegrep '\+= *1 *;'     'can be simplified to ++' $*
hiegrep '-= *1 *;'      'can be simplified to --' $*
hiegrep '((!|=)= *(0|NULL)[^0-9a-z]|[^0-9a-z](0|NULL) *(!|=)=)' 'x==0 / x!=0 can be simplified to !x / x' $*

66
$EGREP $OPT '^\+ *(const *|)static' $*| $EGREP --color=always '[^=]= *(0|NULL)[^0-9a-zA-Z]'> $TMP && printf '\nuseless 0 init\n'
Michael Niedermayer's avatar
Michael Niedermayer committed
67 68 69
cat $TMP
hiegrep '# *ifdef * (HAVE|CONFIG)_' 'ifdefs that should be #if' $*

70
hiegrep '\b(awnser|cant|dont|wont|usefull|successfull|occured|teh|alot|wether|skiped|heigth|informations|colums|loosy|loosing|seperate|preceed|upto|paket|posible)\b' 'common typos' $*
Michael Niedermayer's avatar
Michael Niedermayer committed
71 72 73 74 75 76 77 78 79 80 81 82 83

hiegrep 'av_log\( *NULL' 'Missing context in av_log' $*
hiegrep '[^sn]printf' 'Please use av_log' $*
hiegrep '\bmalloc' 'Please use av_malloc' $*
hiegrep '\) *av_malloc' 'useless casts' $*
hiegrep ':\+ *'"$ERE_PRITYP"' *inline' 'non static inline or strangely ordered inline+static' $*
hiegrep "$ERE_FUNCS"' *\)' 'missing void' $*
hiegrep '(sprintf|strcat|strcpy)' 'Possible security issue, make sure this is safe or use snprintf/av_strl*' $*
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' $*
hiegrep '#(el|)if *(0|1)' 'useless #if' $*
hiegrep 'if *\( *(0|1) *\)' 'useless if()' $*
hiegrep '& *[a-zA-Z0-9_]* *\[ *0 *\]' 'useless & [0]' $*
hiegrep '(\( *[0-9] *(&&|\|\|)|(&&|\|\|) *[0-9] *\))' 'overriding condition' $*
84 85
hiegrep '(:\+|,|;)( *|static|\*)*'"$ERE_PRITYP"' *\*( |\*)*(src|source|input|in[^a-z])' 'missing const?' $*
hiegrep '(:\+|,|;)( *|static|\*)*'"$ERE_PRITYP"' *(src|source|input|in)([0-9A-Z_][0-9A-Za-z_]*){1,} *\[' 'missing const (test2)?' $*
86
hiegrep ' *static *'"$ERE_FUNCS"'[^)]*\);' 'static prototype, maybe you should reorder your functions' $*
87
hiegrep '@file: *[a-zA-Z0-9_]' 'doxy filetag with filename can in the future cause problems when forgotten during a rename' $*
Peter Ross's avatar
Peter Ross committed
88
hiegrep '\bassert' 'Please use av_assert0, av_assert1 or av_assert2' $*
Michael Niedermayer's avatar
Michael Niedermayer committed
89

Michael Niedermayer's avatar
Michael Niedermayer committed
90
hiegrep2 '\.long_name *=' 'NULL_IF_CONFIG_SMAL' 'missing NULL_IF_CONFIG_SMAL' $*
91 92 93 94
hiegrep2 '\.pix_fmts *= *\(' 'const' 'missing const for pix_fmts array' $*
hiegrep2 '\.sample_fmts *= *\(' 'const' 'missing const for sample_fmts array' $*
hiegrep2 '\.supported_framerates *= *\(' 'const' 'missing const for supported_framerates array' $*
hiegrep2 '\.channel_layouts *= *\(' 'const' 'missing const for channel_layouts array' $*
Michael Niedermayer's avatar
Michael Niedermayer committed
95

96
#$EGREP $OPT '^\+.*const ' $*| $GREP -v 'static'> $TMP && printf '\nnon static const\n'
Michael Niedermayer's avatar
Michael Niedermayer committed
97 98
#cat $TMP

Michael Niedermayer's avatar
Michael Niedermayer committed
99
hiegrep2 "$ERE_TYPES" '(static|av_|ff_|typedef|:\+[^a-zA-Z_])' 'Non static with no ff_/av_ prefix' $*
Michael Niedermayer's avatar
Michael Niedermayer committed
100

101
hiegrep ':\+[^}#]*else' 'missing } prior to else' $*
102 103 104
hiegrep '(if|while|for)\(' 'missing whitespace between keyword and ( (feel free to ignore)' $*
hiegrep '(else|do){'       'missing whitespace between keyword and { (feel free to ignore)' $*
hiegrep '}(else|while)'    'missing whitespace between } and keyword (feel free to ignore)' $*
Michael Niedermayer's avatar
Michael Niedermayer committed
105 106 107 108 109 110

#FIXME this should print the previous statement maybe
hiegrep ':\+  *{ *$' '{ should be on the same line as the related previous statement' $*


rm $TMP
111 112 113
for i in $($GREP -H '^+.*@param' $*| sed 's/^\([^:]*\):.*@param\(\[.*\]\|\) *\([a-zA-Z0-9_]*\) .*$/\1:\3/') ; do
    doxpar=$(echo $i | sed 's/^.*:\(.*\)$/\1/')
    file=$(echo $i | sed 's/^\([^:]*\):.*$/\1/')
114
    $GREP " *$doxpar *[),]" $file | $GREP -v '@param' >/dev/null || $GREP --color=always "@param *$doxpar" $file >>$TMP
Michael Niedermayer's avatar
Michael Niedermayer committed
115 116
done
if test -e $TMP ; then
117
    printf '\nmismatching doxy params\n'
Michael Niedermayer's avatar
Michael Niedermayer committed
118 119 120
    cat $TMP
fi

121
$EGREP -B2 $OPT '^(\+|) *('"$ERE_TYPES"'|# *define)' $* | $EGREP -A2 --color=always '(:|-)\+[^/]*/(\*([^*]|$)|/([^/]|$))' > $TMP && printf "\n Non doxy comments\n"
Michael Niedermayer's avatar
Michael Niedermayer committed
122 123 124 125
cat $TMP

rm $TMP
for i in \
126
    $($EGREP -H '^\+ *'"$ERE_TYPES" $*  |\
127
    $GREP -v '(' | $EGREP -v '\Wgoto\W' |\
Michael Niedermayer's avatar
Michael Niedermayer committed
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/') \
Michael Niedermayer's avatar
Michael Niedermayer committed
131
    ; do
132 133 134 135 136
    echo $i | $GREP '^NULL$' && continue
    $EGREP $i' *(\+|-|\*|/|\||&|%|)=[^=]' $* >/dev/null || echo "possibly never written:"$i >> $TMP
    $EGREP '(=|\(|return).*'$i'(==|[^=])*$'    $* >/dev/null || echo "possibly never read   :"$i >> $TMP
    $EGREP -o $i' *((\+|-|\*|/|\||&|%|)=[^=]|\+\+|--) *(0x|)[0-9]*(;|)'   $* |\
           $EGREP -v $i' *= *(0x|)[0-9]{1,};'>/dev/null || echo "possibly constant     :"$i >> $TMP
Michael Niedermayer's avatar
Michael Niedermayer committed
137 138
done
if test -e $TMP ; then
139
    printf '\npossibly unused variables\n'
Michael Niedermayer's avatar
Michael Niedermayer committed
140 141 142
    cat $TMP
fi

143
$GREP '^+++ .*Changelog' $* >/dev/null || printf "\nMissing changelog entry (ignore if minor change)\n"
Michael Niedermayer's avatar
Michael Niedermayer committed
144

145
cat $* | tr '\n' '@' | $EGREP --color=always -o '(fprintf|av_log|printf)\([^)]*\)[+ ;@]*\1'  >$TMP && printf "\nMergeable calls\n"
Michael Niedermayer's avatar
Michael Niedermayer committed
146 147
cat $TMP | tr '@' '\n'

148
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"
Michael Niedermayer's avatar
Michael Niedermayer committed
149 150
cat $TMP | tr '@' '\n'

151
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"
Michael Niedermayer's avatar
Michael Niedermayer committed
152 153
cat $TMP | tr '@' '\n'

154
cat $* | tr '\n' '@' | $EGREP --color=always -o '\+ *if *\( *([A-Za-z0-9_]*) *\)[ @\\+]*av_free(p|) *\( *(&|) *\1[^-.]'  >$TMP && printf "\nav_free(NULL) is safe\n"
Michael Niedermayer's avatar
Michael Niedermayer committed
155 156
cat $TMP | tr '@' '\n'

157
cat $* | tr '\n' '@' | $EGREP --color=always -o '[^a-zA-Z0-9_]([a-zA-Z0-9_]*) *= *av_malloc *\([^)]*\)[ @;\\+]*memset *\( *\1'  >$TMP && printf "\nav_mallocz()\n"
Michael Niedermayer's avatar
Michael Niedermayer committed
158 159 160 161
cat $TMP | tr '@' '\n'


# doesnt 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"
Michael Niedermayer's avatar
Michael Niedermayer committed
163 164 165 166 167 168 169
#cat $TMP | tr '@' '\n'

exit

TODO/idea list:

for all demuxers & muxers
170
    $EGREP for "avctx->priv_data"
Michael Niedermayer's avatar
Michael Niedermayer committed
171 172 173 174 175 176 177 178 179 180

vertical align =
/* and * align
arrays fitting in smaller types
variables written to twice with no interspaced read
memset(block, 0, 6*64*sizeof(DCTELEM)); -> clear_blocks
check existence of long_name in AVCodec
check that the patch does not touch codec & (de)muxer layer at the same time ->split

write a regression test containing at least a line that triggers each warning once