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