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