123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161 |
- #!/bin/sh
- TMP=patcheck.tmp
- OPT="-nH"
- #FILES=`grep '^+++' $* | sed 's/+++ //g'`
- 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
- echo something wrong, fix it and send a patch to the ffmpeg-dev ML
- 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
- grep $OPT '^+' $* | grep -v ':+++'| egrep --color=always -- "$arg"> $TMP && printf "\n$msg\n"
- cat $TMP
- }
- hiegrep2(){
- arg="$1"
- varg="$2"
- msg="$3"
- shift 3
- grep $OPT '^+' $* | grep -v ':+++' | egrep -v -- "$varg" | egrep --color=always -- "$arg" > $TMP && printf "\n$msg\n"
- cat $TMP
- }
- hiegrep '[[:space:]]$' 'trailing whitespace' $*
- hiegrep "`echo x | tr 'x' '\t'`" 'tabs' $*
- #hiegrep ':\+$' 'Empty lines' $*
- hiegrep ';;' 'double ;' $*
- hiegrep2 '\b_[a-zA-Z0-9_]{1,}' '__(asm|attribute)([^a-zA-Z0-9]|$)' 'reserved identifer' $*
- hiegrep '//[-/<\* ]*$' 'empty comment' $*
- hiegrep '/\*[-<\* ]*\*/' 'empty comment' $*
- hiegrep 'for *\( *'"$ERE_PRITYP"' ' 'not gcc 2.95 compatible' $*
- hiegrep '(static|inline|const) *\1' 'duplicate word' $*
- hiegrep 'INIT_VLC_USE_STATIC' 'forbidden ancient vlc type' $*
- 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' $*
- 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' $*
- egrep $OPT '^\+ *(const *|)static' $*| egrep --color=always '[^=]= *(0|NULL)[^0-9a-zA-Z]'> $TMP && printf '\nuseless 0 init\n'
- cat $TMP
- hiegrep '# *ifdef * (HAVE|CONFIG)_' 'ifdefs that should be #if' $*
- hiegrep '\b(awnser|cant|dont|quantised|quantisation|teh|wont)\b' 'common typos' $*
- 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' $*
- 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)?' $*
- hiegrep ' *static *'"$ERE_FUNCS"'[^)]*\);' 'static prototype, maybe you should reorder your functions' $*
- hiegrep2 '\.long_name *=' 'NULL_IF_CONFIG_SMAL' 'missing NULL_IF_CONFIG_SMAL' $*
- 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' $*
- #egrep $OPT '^\+.*const ' $*| grep -v 'static'> $TMP && printf '\nnon static const\n'
- #cat $TMP
- hiegrep2 "$ERE_TYPES" '(static|av_|ff_|typedef|:\+[^a-zA-Z_])' 'Non static with no ff_/av_ prefix' $*
- hiegrep ':\+[^}#]*else' 'missing } prior to else' $*
- #FIXME this should print the previous statement maybe
- hiegrep ':\+ *{ *$' '{ should be on the same line as the related previous statement' $*
- rm $TMP
- 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/'`
- grep " *$doxpar *[),]" $file | grep -v '@param' >/dev/null || grep --color=always "@param *$doxpar" $file >>$TMP
- done
- if test -e $TMP ; then
- printf '\nmismatching doxy params\n'
- cat $TMP
- fi
- egrep -B2 $OPT '^(\+|) *('"$ERE_TYPES"'|# *define)' $* | egrep -A2 --color=always '(:|-)\+[^/]*/(\*([^*]|$)|/([^/]|$))' > $TMP && printf "\n Non doxy comments\n"
- cat $TMP
- rm $TMP
- for i in \
- `egrep -H '^\+ *'"$ERE_TYPES" $* |\
- grep -v '(' | egrep -v '\Wgoto\W' |\
- xargs -d '\n' -n 1 |\
- grep -o '[* ][* ]*[a-zA-Z][0-9a-zA-Z_]* *[,;=]' |\
- sed 's/.[* ]*\([a-zA-Z][0-9a-zA-Z_]*\) *[,;=]/\1/'` \
- ; do
- 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
- done
- if test -e $TMP ; then
- printf '\npossibly unused variables\n'
- cat $TMP
- fi
- grep '^Index:.*Changelog' $* >/dev/null || printf "\nMissing changelog entry (ignore if minor change)\n"
- cat $* | tr '\n' '@' | egrep --color=always -o '(fprintf|av_log|printf)\([^)]*\)[+ ;@]*\1' >$TMP && printf "\nMergeable calls\n"
- cat $TMP | tr '@' '\n'
- 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"
- cat $TMP | tr '@' '\n'
- 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"
- cat $TMP | tr '@' '\n'
- cat $* | tr '\n' '@' | egrep --color=always -o '\+ *if *\( *([A-Za-z0-9_]*) *\)[ @\\+]*av_free(p|) *\( *(&|) *\1[^-.]' >$TMP && printf "\nav_free(NULL) is safe\n"
- cat $TMP | tr '@' '\n'
- cat $* | tr '\n' '@' | egrep --color=always -o '[^a-zA-Z0-9_]([a-zA-Z0-9_]*) *= *av_malloc *\([^)]*\)[ @;\\+]*memset *\( *\1' >$TMP && printf "\nav_mallocz()\n"
- cat $TMP | tr '@' '\n'
- # doesnt work
- #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"
- #cat $TMP | tr '@' '\n'
- exit
- TODO/idea list:
- for all demuxers & muxers
- grep for "avctx->priv_data"
- 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
|