mirror of
https://github.com/espressif/openthread.git
synced 2025-05-17 15:26:16 +08:00
[script] check-size to generate formatted table on push (#9382)
This commit updates the `check-size` script to generate a formatted table on a branch push. The table will first include the code size difference for all binary files, followed by the difference for all library files. This allows us to use the `check-size` script on local machines during development to get a full size impact report, similar to what will be reported on the GitHub Action branch push. This commit also generates a size report for posting on a pull request in Markdown format. In particular, the table with the size difference for all library files is added as a collapsible section after the main table for binary files.
This commit is contained in:
Abtin Keshavarzian
committed by
GitHub
GitHub
parent
c6bece0729
commit
5c051ffeb5
@ -38,8 +38,14 @@ readonly OT_SHA_NEW
|
||||
OT_SHA_OLD="$(git cat-file -p "${OT_SHA_NEW}" | grep 'parent ' | head -n1 | cut -d' ' -f2)"
|
||||
readonly OT_SHA_OLD
|
||||
|
||||
OT_REPORT_FILE=/tmp/size_report
|
||||
readonly OT_REPORT_FILE
|
||||
OT_REPORT_FILE_TABLE="${OT_TMP_DIR}/report_table"
|
||||
readonly OT_REPORT_FILE_TABLE
|
||||
|
||||
OT_REPORT_FILE_PR="${OT_TMP_DIR}/report_pr"
|
||||
readonly OT_REPORT_FILE_TABLE
|
||||
|
||||
OT_REPORTER="${OT_SIZE_REPORTER-}"
|
||||
readonly OT_REPORTER
|
||||
|
||||
setup_arm_gcc_7()
|
||||
{
|
||||
@ -66,51 +72,6 @@ setup()
|
||||
setup_ninja_build
|
||||
}
|
||||
|
||||
markdown_init()
|
||||
{
|
||||
echo '| name | branch | text | data | bss | total |'
|
||||
echo '| :----: | :------: | -----: | ----: | ---: | ----: |'
|
||||
}
|
||||
|
||||
markdown_size()
|
||||
{
|
||||
local name
|
||||
name=$(basename "$1")
|
||||
|
||||
read -r -a size_old <<<"$(size "$1" | awk '{text+=$1} {bss+=$2} {data+=$3} {total+=$4} END {printf "%d %d %d %d", text, bss, data, total}')"
|
||||
read -r -a size_new <<<"$(size "$2" | awk '{text+=$1} {bss+=$2} {data+=$3} {total+=$4} END {printf "%d %d %d %d", text, bss, data, total}')"
|
||||
|
||||
local -a size_diff
|
||||
|
||||
for i in 0 1 2 3; do
|
||||
size_diff[$i]="$((size_new["$i"] - size_old["$i"]))"
|
||||
if [[ ${size_diff["$i"]} != 0 ]]; then
|
||||
size_diff["$i"]=$(printf '%+d' "${size_diff["$i"]}")
|
||||
fi
|
||||
done
|
||||
|
||||
echo "| ${name} | -${OT_SHA_OLD:0:7} | ${size_old[0]} | ${size_old[1]} | ${size_old[2]} | ${size_old[3]} |"
|
||||
echo "| | +${OT_SHA_NEW:0:7} | ${size_new[0]} | ${size_new[1]} | ${size_new[2]} | ${size_new[3]} |"
|
||||
echo "| | +/- | ${size_diff[0]} | ${size_diff[1]} | ${size_diff[2]} | ${size_diff[3]} |"
|
||||
}
|
||||
|
||||
markdown()
|
||||
{
|
||||
case "$1" in
|
||||
init)
|
||||
shift
|
||||
markdown_init "$@" >"${OT_REPORT_FILE}"
|
||||
;;
|
||||
size)
|
||||
shift
|
||||
markdown_size "$@" >>"${OT_REPORT_FILE}"
|
||||
;;
|
||||
post)
|
||||
mdv "${OT_REPORT_FILE}"
|
||||
;;
|
||||
esac
|
||||
}
|
||||
|
||||
nm_size()
|
||||
{
|
||||
arm-none-eabi-nm --print-size --defined-only -C "$1" | cut -d' ' -f2- >nmsize_old
|
||||
@ -197,6 +158,106 @@ build_nrf52840()
|
||||
cd "${cur_dir}"
|
||||
}
|
||||
|
||||
generate_table_header()
|
||||
{
|
||||
{
|
||||
printf "+----------------------------+----------+----------+----------+----------+----------+\n"
|
||||
printf "| name | branch | text | data | bss | total |\n"
|
||||
printf "+============================+==========+==========+==========+==========+==========+\n"
|
||||
} >>"${OT_REPORT_FILE_TABLE}"
|
||||
|
||||
{
|
||||
printf "# Size Report of **OpenThread**\n"
|
||||
printf "Merging PR into main\n\n"
|
||||
printf "| name | branch | text | data | bss | total |\n"
|
||||
printf "| :----: | :------: | -----: | ----: | ---: | ----: |\n"
|
||||
} >>"${OT_REPORT_FILE_PR}"
|
||||
|
||||
{
|
||||
printf "\n<details><summary>Library files</summary>\n\n\n"
|
||||
printf "| name | branch | text | data | bss | total |\n"
|
||||
printf "| :----: | :------: | -----: | ----: | ---: | ----: |\n"
|
||||
} >>"${OT_REPORT_FILE_PR}_libs"
|
||||
|
||||
if [ -n "${OT_REPORTER}" ]; then
|
||||
"${OT_REPORTER}" init OpenThread
|
||||
fi
|
||||
|
||||
}
|
||||
|
||||
generate_size_diff()
|
||||
{
|
||||
local name
|
||||
local old_file
|
||||
local new_file
|
||||
|
||||
old_file="$1"
|
||||
new_file="$2"
|
||||
|
||||
name=$(basename "${old_file}")
|
||||
|
||||
case "${name}" in
|
||||
lib*)
|
||||
table_report_file="${OT_REPORT_FILE_TABLE}_libs"
|
||||
pr_report_file="${OT_REPORT_FILE_PR}"_libs
|
||||
;;
|
||||
*)
|
||||
table_report_file="${OT_REPORT_FILE_TABLE}"
|
||||
pr_report_file="${OT_REPORT_FILE_PR}"
|
||||
;;
|
||||
esac
|
||||
|
||||
read -r -a size_old <<<"$(size "${old_file}" | awk '{text+=$1} {bss+=$2} {data+=$3} {total+=$4} END {printf "%d %d %d %d", text, bss, data, total}')"
|
||||
read -r -a size_new <<<"$(size "${new_file}" | awk '{text+=$1} {bss+=$2} {data+=$3} {total+=$4} END {printf "%d %d %d %d", text, bss, data, total}')"
|
||||
|
||||
local -a size_diff
|
||||
|
||||
for i in 0 1 2 3; do
|
||||
size_diff[$i]="$((size_new["$i"] - size_old["$i"]))"
|
||||
if [[ ${size_diff["$i"]} != 0 ]]; then
|
||||
size_diff["$i"]=$(printf '%+d' "${size_diff["$i"]}")
|
||||
fi
|
||||
done
|
||||
|
||||
# Generate table format report
|
||||
|
||||
{
|
||||
printf "| %-26s | %-8s " "${name}" "${OT_SHA_OLD:0:8}"
|
||||
printf "| %8u | %8u | %8u | %8u |" "${size_old[0]}" "${size_old[1]}" "${size_old[2]}" "${size_old[3]}"
|
||||
printf "\n"
|
||||
|
||||
printf "| %-26s | %-8s " "" "${OT_SHA_NEW:0:8}"
|
||||
printf "| %8u | %8u | %8u | %8u |" "${size_new[0]}" "${size_new[1]}" "${size_new[2]}" "${size_new[3]}"
|
||||
printf "\n"
|
||||
|
||||
printf "| %-26s | %-8s " "" "+/-"
|
||||
printf "| %+8d | %+8d | %+8d | %+8d |" "${size_diff[0]}" "${size_diff[1]}" "${size_diff[2]}" "${size_diff[3]}"
|
||||
printf "\n" >>"${table_report_file}"
|
||||
|
||||
printf "+----------------------------+----------+----------+----------+----------+----------+\n"
|
||||
} >>"${table_report_file}"
|
||||
|
||||
# Generate PR post format report
|
||||
|
||||
{
|
||||
printf "| %s | %s " "${name}" "${OT_SHA_OLD:0:8}"
|
||||
printf "| %u | %u | %u | %u |" "${size_old[0]}" "${size_old[1]}" "${size_old[2]}" "${size_old[3]}"
|
||||
printf "\n"
|
||||
|
||||
printf "| | %s " "${OT_SHA_NEW:0:8}"
|
||||
printf "| %u | %u | %u | %u |" "${size_new[0]}" "${size_new[1]}" "${size_new[2]}" "${size_new[3]}"
|
||||
printf "\n"
|
||||
|
||||
printf "| | %s " "+/-"
|
||||
printf "| %+d | %+d | %+d | %+d |" "${size_diff[0]}" "${size_diff[1]}" "${size_diff[2]}" "${size_diff[3]}"
|
||||
printf "\n"
|
||||
} >>"${pr_report_file}"
|
||||
|
||||
if [ -n "${OT_REPORTER}" ]; then
|
||||
"${OT_REPORTER}" size "${old_file}" "${new_file}"
|
||||
fi
|
||||
}
|
||||
|
||||
generate_report()
|
||||
{
|
||||
local type="${1}"
|
||||
@ -217,11 +278,24 @@ generate_report()
|
||||
;;
|
||||
esac
|
||||
|
||||
"${reporter}" size "${old_file}" "${new_file}"
|
||||
generate_size_diff "${old_file}" "${new_file}"
|
||||
|
||||
echo "nm_size ${old_file} ${new_file}"
|
||||
nm_size "${old_file}" "${new_file}"
|
||||
done
|
||||
}
|
||||
|
||||
finalize_report()
|
||||
{
|
||||
cat "${OT_REPORT_FILE_TABLE}"
|
||||
cat "${OT_REPORT_FILE_TABLE}_libs"
|
||||
|
||||
printf "</details>" >>${OT_REPORT_FILE_PR}_libs
|
||||
cat "${OT_REPORT_FILE_PR}_libs" >>${OT_REPORT_FILE_PR}
|
||||
|
||||
if [ -n "${OT_REPORTER}" ]; then
|
||||
"${OT_REPORTER}" post
|
||||
fi
|
||||
}
|
||||
|
||||
size_nrf52840()
|
||||
@ -229,13 +303,13 @@ size_nrf52840()
|
||||
export OT_SHA_NEW OT_SHA_OLD
|
||||
|
||||
rm -rf "${OT_TMP_DIR}"
|
||||
mkdir -p "${OT_TMP_DIR}"
|
||||
|
||||
if [[ "${GITHUB_ACTIONS+x}" ]]; then
|
||||
git fetch --depth 1 --no-recurse-submodules origin "${OT_SHA_OLD}"
|
||||
fi
|
||||
|
||||
local reporter="${OT_SIZE_REPORTER:-markdown}"
|
||||
"${reporter}" init OpenThread
|
||||
generate_table_header
|
||||
|
||||
build_nrf52840 ftd new
|
||||
build_nrf52840 mtd new
|
||||
@ -279,7 +353,7 @@ size_nrf52840()
|
||||
generate_report br "${br_files[@]}"
|
||||
generate_report ftd "${rcp_files[@]}"
|
||||
|
||||
"${reporter}" post
|
||||
finalize_report
|
||||
}
|
||||
|
||||
main()
|
||||
|
||||
Reference in New Issue
Block a user