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