Statistics
| Branch: | Revision:

ffmpeg / tools / patcheck @ 565344e7

History | View | Annotate | Download (7.35 KB)

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