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