xref: /rkbin/scripts/checkpatch.sh (revision 0f8ea74fb0836088eae78d9d2d28ad3b719e6a20)
1#!/bin/bash
2set -e
3
4DIFF_SUBSET="scripts/.diff_*"
5DIFF_DOC_ALL="scripts/.diff_all.txt"
6DIFF_DOC_FIXED="scripts/.diff_fixed.txt"
7
8function check_doc()
9{
10	local TOP_SEVERITY LANGUAGE=$1
11
12	if [ "${LANGUAGE}" == "EN" ] ; then
13		SVT_CRITIAL="critical"
14		SVT_IMPORTANT="important"
15		SVT_MODERATE="moderate"
16		DOC=`git log -1 --name-only | sed -n "/_EN\.md/p"`
17	else
18		SVT_CRITIAL="紧急"
19		SVT_IMPORTANT="重要"
20		SVT_MODERATE="普通"
21		DOC=`git log -1 --name-only | sed -n "/_CN\.md/p"`
22	fi
23
24	echo "Checking doc: ${DOC}"
25
26	# check DOS encoding
27	git show -1 ${DOC} | sed -n "/^+/p" > ${DIFF_DOC_ALL}
28	git show -1 ${DOC} | sed -n "/^+/p" > ${DIFF_DOC_ALL}.dos
29	dos2unix ${DIFF_DOC_ALL}.dos >/dev/null 2>&1
30	CSUM1=`md5sum ${DIFF_DOC_ALL} | awk '{ print $1 }'`
31	CSUM2=`md5sum ${DIFF_DOC_ALL}.dos | awk '{ print $1 }'`
32	if [ "${CSUM1}" != "${CSUM2}" ]; then
33		echo "ERROR: ${DOC} is DOS encoding. Fix it by: 'dos2unix ${DOC}'"
34		exit 1
35	fi
36
37	TITLE=`sed -n "/^+## /p" ${DIFF_DOC_ALL} | tr -d " +#"`
38	FILE=`sed -n "/^+| 20[0-9][0-9]-/p" ${DIFF_DOC_ALL} | tr -d " " | awk -F "|" '{ print $3 }'`
39	COMMIT=`sed -n "/^+| 20[0-9][0-9]-/p" ${DIFF_DOC_ALL} | tr -d " " | awk -F "|" '{ print $4 }'`
40	SEVERITY=`sed -n "/^+| 20[0-9][0-9]-/p" ${DIFF_DOC_ALL} | tr -d " " | awk -F "|" '{ print $5 }'`
41	HORIZONTAL_LINE=`sed -n "/^+------$/p" ${DIFF_DOC_ALL}`
42	# echo "### ${COMMIT}, ${SEVERITY}, ${TITLE}, ${FILE}"
43
44	# check new content location
45	if ! git show -1 ${DOC} | grep -q 'Release Note' ; then
46		echo "ERROR: ${DOC}: Adding new content at the top but not bottom"
47		exit 1
48	fi
49
50	# check TAB before index of 'New' body
51	if grep -q $'\t[0-9]' ${DOC} ; then
52		echo "ERROR: ${DOC}: Don't add TAB before index:"
53		grep $'\t[0-9]' ${DOC}
54		exit 1
55	fi
56
57	# check standalone file
58	if ! echo ${FILE} | grep -q { ; then
59		if ! git log -1 --name-only | grep -q ${FILE}; then
60			echo "ERROR: ${DOC}: '${FILE}' is not updated in this patch"
61			exit 1
62		fi
63	fi
64
65	# check title
66	if [ "${TITLE}" != "${FILE}" ]; then
67		echo "ERROR: ${DOC}: Title '${TITLE}' is not match with '${FILE}'"
68		exit 1
69	fi
70
71	# check commit
72	COMMIT=${COMMIT//#/ }
73	for LIST in ${COMMIT}; do
74		CMT=`echo ${LIST} | cut -d : -f 2`
75		if ! git log -1 | grep -q ${CMT} ; then
76			echo "ERROR: ${DOC}: '${CMT}' is not match in commit message"
77			exit 1
78		fi
79
80		if ! echo ${FILE} | grep -q { ; then
81			if echo ${FILE} | grep -Eq 'spl_|tpl_|bl31_|bl32_|tee_' ; then
82				FILE_PATH=`find -name ${FILE}`
83				if ! strings ${FILE_PATH} | grep -q ${CMT} ; then
84					echo "ERROR: ${DOC}: ${FILE} is not build from '${CMT}'"
85					exit 1
86				fi
87			fi
88		fi
89	done
90
91	# check severity
92	if [ "${SEVERITY}" != "${SVT_CRITIAL}" -a "${SEVERITY}" != "${SVT_IMPORTANT}" -a "${SEVERITY}" != "${SVT_MODERATE}" ]; then
93		echo "ERROR: ${DOC}: Unknown main severity: ${SEVERITY}"
94		exit 1
95	fi
96
97	# check horizontal line
98	if [ -z "${HORIZONTAL_LINE}" ]; then
99		echo "ERROR: ${DOC}: No horizontal line '------' at the last of new content"
100		exit 1
101	fi
102
103	# check 'Fixed' content
104	if grep -q "^+### Fixed" ${DIFF_DOC_ALL} ; then
105		awk -v RS='### Fixed' 'END{printf "%s", $0}' ${DIFF_DOC_ALL} > ${DIFF_DOC_FIXED}
106		sed -i "/^$/d"    ${DIFF_DOC_FIXED}
107		sed -i "/Index/d" ${DIFF_DOC_FIXED}
108		sed -i "/---/d"   ${DIFF_DOC_FIXED}
109		sed -i "/^+$/d"   ${DIFF_DOC_FIXED}
110
111		while read LINE
112		do
113			EACH_SEVERITY=`echo "${LINE}" | awk -F "|" '{ print $3 }' | tr -d " "`
114			if [ "${EACH_SEVERITY}" != "${SVT_CRITIAL}" -a "${EACH_SEVERITY}" != "${SVT_IMPORTANT}" -a "${EACH_SEVERITY}" != "${SVT_MODERATE}" ]; then
115				echo "ERROR: ${DOC}: Unknown severity: ${EACH_SEVERITY}"
116				exit 1
117			fi
118
119			# echo "## EACH: $EACH_SEVERITY"
120			if [ -z "${TOP_SEVERITY}" ]; then
121				TOP_SEVERITY="${EACH_SEVERITY}"
122			elif [ "${TOP_SEVERITY}" == "${SVT_MODERATE}" ]; then
123				if [ "${EACH_SEVERITY}" == "${SVT_CRITIAL}" -o "${EACH_SEVERITY}" == "${SVT_IMPORTANT}" ]; then
124						TOP_SEVERITY="${EACH_SEVERITY}"
125				fi
126			elif [ "${TOP_SEVERITY}" == "${SVT_IMPORTANT}" ]; then
127				if [ "${EACH_SEVERITY}" == "${SVT_CRITIAL}" ]; then
128						TOP_SEVERITY="${EACH_SEVERITY}"
129				fi
130			fi
131		done < ${DIFF_DOC_FIXED}
132
133		if [ "${SEVERITY}" != "${TOP_SEVERITY}" ]; then
134			echo "ERROR: ${DOC}: Main severity should be '${TOP_SEVERITY}'"
135			exit 1
136		fi
137	fi
138}
139
140function check_docs()
141{
142	if git log -1 --name-only | grep -Eq '\.bin|\.elf' ; then
143		DOC_CN=`git log -1 --name-only | sed -n "/_CN\.md/p"`
144		DOC_EN=`git log -1 --name-only | sed -n "/_EN\.md/p"`
145		if [ -z "${DOC_CN}" -o -z "${DOC_EN}" ]; then
146			echo "ERROR: Update CN/EN Release-Note when .bin or .elf changed"
147			exit 1
148		fi
149
150		if ! which dos2unix > /dev/null 2>&1 ; then
151			echo "ERROR: No 'dos2unix'. Fix by: sudo apt-get install dos2unix"
152			exit 1
153		fi
154
155		check_doc CN
156		check_doc EN
157	fi
158
159	rm -f ${DIFF_SUBSET}
160}
161
162function pack_loader_image()
163{
164	for FILE in `ls ./RKBOOT/*MINIALL*.ini`
165	do
166		if [ "${FILE}" = "./RKBOOT/RK302AMINIALL.ini" -o \
167			 "${FILE}" = "./RKBOOT/RK30BMINIALL.ini" -o \
168			 "${FILE}" = "./RKBOOT/RK30MINIALL.ini" -o \
169			 "${FILE}" = "./RKBOOT/RK310BMINIALL.ini" ]; then
170			continue;
171		fi
172
173		if grep -q '^PATH=img/' ${FILE}; then
174			continue;
175		fi
176
177		echo "Pack loader: ${FILE}"
178		./tools/boot_merger ${FILE}
179		rm -f *loader*.bin *download*.bin *idblock*.img
180		echo
181	done
182}
183
184function pack_trust_image()
185{
186	# Pack 32-bit trust
187	for FILE in `ls ./RKTRUST/*TOS*.ini`
188	do
189		if ! test -s ${FILE}; then
190			continue;
191		elif ! grep -q 'TOS' ${FILE}; then
192			continue;
193		elif grep -q '^PATH=img/' ${FILE}; then
194			continue;
195		fi
196
197		echo "Pack trust: ${FILE}"
198		# Parse orignal path
199		TOS=`sed -n "/TOS=/s/TOS=//p" ${FILE}|tr -d '\r'`
200		TOS_TA=`sed -n "/TOSTA=/s/TOSTA=//p" ${FILE}|tr -d '\r'`
201
202		# replace "./tools/rk_tools/" with "./" to compatible legacy ini content of rkdevelop branch
203		TOS=$(echo ${TOS} | sed "s/tools\/rk_tools\//\.\//g")
204		TOS_TA=$(echo ${TOS_TA} | sed "s/tools\/rk_tools\//\.\//g")
205
206		if [ x${TOS_TA} != x -a x${TOS} != x ]; then
207			./tools/loaderimage --pack --trustos ${TOS} ./trust.img 0x68400000
208			./tools/loaderimage --pack --trustos ${TOS_TA} ./trust_with_ta.img 0x68400000
209		elif [ ${TOS} ]; then
210			./tools/loaderimage --pack --trustos ${TOS} ./trust.img 0x68400000
211		elif [ ${TOS_TA} ]; then
212			./tools/loaderimage --pack --trustos ${TOS_TA} ./trust.img 0x68400000
213		else
214			exit 1
215		fi
216		rm -f trust*.img
217		echo
218	done
219
220	# Pack 64-bit trust
221	for FILE in `ls ./RKTRUST/*TRUST*.ini`
222	do
223		if grep -q '^PATH=img/' ${FILE}; then
224			continue;
225		fi
226
227		echo "Pack trust: ${FILE}"
228		./tools/trust_merger ${FILE}
229		rm -f trust*.img
230		echo
231	done
232}
233
234function check_dirty()
235{
236	for FILE in `find -name '*spl*.bin' -o -name '*tpl*.bin' -o -name '*usbplug*.bin' -o -name '*bl31*.elf' -o -name '*bl32*.bin'`; do
237		echo "Checking clean: ${FILE}"
238		if strings ${FILE} | grep '\-dirty ' ; then
239			echo "ERROR: ${FILE} is dirty"
240			exit 1
241		fi
242	done
243}
244
245function check_stripped()
246{
247	for FILE in `find -name '*bl31*.elf'`; do
248		echo "Checking strip: ${FILE}"
249		INFO=`file ${FILE}`
250		if echo ${INFO} | grep -q "not stripped" ; then
251			echo "ERROR: ${FILE} is not stripped"
252			exit 1
253		fi
254	done
255}
256
257function check_mode()
258{
259	echo "Checking file mode..."
260	if git whatchanged -1 --oneline | sed -n '/RKBOOT\//p; /RKTRUST\//p; /bin\//p; /doc\//p;' | awk '{ print $2 }' | grep -q 755 ; then
261		git whatchanged -1 --oneline | sed -n '/RKBOOT\//p; /RKTRUST\//p; /bin\//p; /doc\//p;' | grep 755
262		echo "ERROR: Set 644 file permission but not 755."
263		exit 1
264	fi
265}
266
267function finish()
268{
269	echo "OK, everything is nice."
270	echo
271}
272
273check_mode
274check_docs
275check_dirty
276check_stripped
277pack_loader_image
278pack_trust_image
279finish
280