patcheck 8.6 KB

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