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