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