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