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