----------------------------------------------------------------------------------------------------------------------------
开发板 :ArmSoM-Sige7
开发板eMMC
:64GB
LPDDR4
:8GB
显示屏 :15.6
英寸HDMI
接口显示屏u-boot
:2017.09
linux
:5.10
----------------------------------------------------------------------------------------------------------------------------
在《Rockchip RK3588 - Rockchip Linux SDK
编译》我们SDK
的编译流程以及固件升级相关的内容,本节将会对编译脚本进行深入的分析。
一、build.sh
分析
Rockchip Linux SDK
编译命令是由build.sh
脚本实现的,其入口函数为main
函数。
1.1 main
函数
由于main
函数代码内容较长,我们只对重点内容进行分析:
点击查看代码
main()
{[ -z "$DEBUG" ] || set -xtrap 'err_handler' ERRset -eE# Save intial envionmentsunset INITIAL_SESSIONINITIAL_ENV=$(mktemp -u)if [ -z "$RK_SESSION" ]; thenINITIAL_SESSION=1env > "$INITIAL_ENV"fiexport LC_ALL=Cexport SCRIPTS_DIR="$(dirname "$(realpath "$BASH_SOURCE")")"export COMMON_DIR="$(realpath "$SCRIPTS_DIR/..")"export SDK_DIR="$(realpath "$COMMON_DIR/../../..")"export DEVICE_DIR="$SDK_DIR/device/rockchip"export CHIPS_DIR="$DEVICE_DIR/.chips"export CHIP_DIR="$DEVICE_DIR/.chip"export RK_DATA_DIR="$COMMON_DIR/data"export RK_TOOL_DIR="$COMMON_DIR/tools"export RK_IMAGE_DIR="$COMMON_DIR/images"export RK_KBUILD_DIR="$COMMON_DIR/linux-kbuild"export RK_CONFIG_IN="$COMMON_DIR/configs/Config.in"export RK_BUILD_HOOK_DIR="$COMMON_DIR/build-hooks"export BUILD_HELPER="$RK_BUILD_HOOK_DIR/build-helper"export RK_POST_HOOK_DIR="$COMMON_DIR/post-hooks"export POST_HELPER="$RK_POST_HOOK_DIR/post-helper"export PARTITION_HELPER="$SCRIPTS_DIR/partition-helper"export RK_SESSION="${RK_SESSION:-$(date +%F_%H-%M-%S)}"export RK_OUTDIR="$SDK_DIR/output"export RK_SESSION_DIR="$RK_OUTDIR/sessions"export RK_LOG_BASE_DIR="$RK_OUTDIR/log"export RK_LOG_DIR="$RK_SESSION_DIR/$RK_SESSION"export RK_INITIAL_ENV="$RK_LOG_DIR/initial.env"export RK_CUSTOM_ENV="$RK_LOG_DIR/custom.env"export RK_FINAL_ENV="$RK_LOG_DIR/final.env"export RK_ROCKDEV_DIR="$SDK_DIR/rockdev"export RK_FIRMWARE_DIR="$RK_OUTDIR/firmware"export RK_SECURITY_FIRMWARE_DIR="$RK_OUTDIR/security-firmware"export RK_CONFIG="$RK_OUTDIR/.config"export RK_DEFCONFIG_LINK="$RK_OUTDIR/defconfig"# For Makefilecase "$@" inmake-targets)# Chip targetsls "$CHIPS_DIR";&make-usage)run_build_hooks "$@"rm -f "$INITIAL_ENV"exit 0 ;;esac# Log SDK informationMANIFEST="$SDK_DIR/.repo/manifest.xml"if [ -e "$MANIFEST" ]; thenif [ ! -L "$MANIFEST" ]; thenMANIFEST="$SDK_DIR/.repo/manifests/$(grep -o "[^\"]*\.xml" "$MANIFEST")"fiTAG="$(grep -o "linux-.*-gen-rkr[^.\"]*" "$MANIFEST" | \head -n 1 || true)"MANIFEST="$(basename "$(realpath "$MANIFEST")")"echoecho -e "\e[35m############### Rockchip Linux SDK ###############\e[0m"echoecho -e "\e[35mManifest: $MANIFEST\e[0m"if [ "$TAG" ]; thenecho -e "\e[35mVersion: $TAG\e[0m"fiechofi# Prepare firmware dirsmkdir -p "$RK_FIRMWARE_DIR" "$RK_SECURITY_FIRMWARE_DIR"cd "$SDK_DIR"[ -f README.md ] || ln -rsf "$COMMON_DIR/README.md" .[ -d common ] || ln -rsf "$COMMON_DIR" .# TODO: Remove it in the repo manifest.xmlrm -f envsetup.shOPTIONS=${@:-allsave}# Special handle for chip and defconfig# e.g. ./build.sh rk3588:rockchip_defconfigfor opt in $OPTIONS; doif [ -d "$CHIPS_DIR/${opt%%:*}" ]; thenOPTIONS=$(echo "$OPTIONS" | xargs -n 1 | \sed "s/^$opt$/chip:$opt/" | xargs)elif echo "$opt" | grep -q "^[0-9a-z_]*_defconfig$"; thenOPTIONS=$(echo "$OPTIONS" | xargs -n 1 | \sed "s/^$opt$/defconfig:$opt/" | xargs)fidone# Options checkingCMDS="$(run_build_hooks support-cmds all | xargs)"for opt in $OPTIONS; docase "$opt" inhelp | h | -h | --help | usage | \?) usage ;;clean:*)# Check cleanup modulesfor m in $(echo ${opt#clean:} | tr ':' ' '); dogrep -wq clean_hook \"$SCRIPTS_DIR/mk-$m.sh" \2>/dev/null || usagedone;&shell | cleanall)# Check single optionsif [ "$opt" = "$OPTIONS" ]; thenbreakfiecho "ERROR: $opt cannot combine with other options!";;post-rootfs)if [ "$opt" = "$1" -a -d "$2" ]; then# Hide other args from build stagesOPTIONS=$optbreakfiecho "ERROR: $opt should be the first option followed by rootfs dir!";;*)# Make sure that all options are handledif option_check "$CMDS" $opt; thencontinuefiecho "ERROR: Unhandled option: $opt";;esacusagedone# Prepare log dirsif [ ! -d "$RK_LOG_DIR" ]; thenrm -rf "$RK_LOG_BASE_DIR" "$RK_LOG_DIR" "$RK_SESSION_DIR/latest"mkdir -p "$RK_LOG_DIR"ln -rsf "$RK_SESSION_DIR" "$RK_LOG_BASE_DIR"ln -rsf "$RK_LOG_DIR" "$RK_SESSION_DIR/latest"echo -e "\e[33mLog saved at $RK_LOG_DIR\e[0m"echofi# Drop old logscd "$RK_LOG_BASE_DIR"rm -rf $(ls -t | sed '1,10d')cd "$SDK_DIR"# Save initial envionmentsif [ "$INITIAL_SESSION" ]; thenrm -f "$RK_INITIAL_ENV"mv "$INITIAL_ENV" "$RK_INITIAL_ENV"ln -rsf "$RK_INITIAL_ENV" "$RK_OUTDIR/"fi# Init stage (preparing SDK configs, etc.)run_build_hooks init $OPTIONSrm -f "$RK_OUTDIR/.tmpconfig*"# No need to go furtherCMDS="$(run_build_hooks support-cmds pre-build build \post-build | xargs) cleanall clean post-rootfs"option_check "$CMDS" $OPTIONS || return 0# Force exporting config environmentsset -a# Load config environmentssource "$RK_CONFIG"cp "$RK_CONFIG" "$RK_LOG_DIR"if [ -z "$INITIAL_SESSION" ]; then# Inherit session environmentssed -n 's/^\(RK_.*=\)\(.*\)/\1"\2"/p' "$RK_FINAL_ENV" > \"$INITIAL_ENV"source "$INITIAL_ENV"rm -f "$INITIAL_ENV"else# Detect and save custom environments# Find custom environmentsrm -f "$RK_CUSTOM_ENV"for cfg in $(grep "^RK_" "$RK_INITIAL_ENV" || true); doenv | grep -q "^${cfg//\"/}$" || \echo "$cfg" >> "$RK_CUSTOM_ENV"done# Allow custom environments overridingif [ -e "$RK_CUSTOM_ENV" ]; thenln -rsf "$RK_CUSTOM_ENV" "$RK_OUTDIR/"echo -e "\e[31mWARN: Found custom environments: \e[0m"cat "$RK_CUSTOM_ENV"echo -e "\e[31mAssuming that is expected, please clear them if otherwise.\e[0m"read -t 10 -p "Press enter to continue."source "$RK_CUSTOM_ENV"if grep -q "^RK_KERNEL_VERSION=" "$RK_CUSTOM_ENV"; thenecho -e "\e[31mCustom RK_KERNEL_VERSION ignored!\e[0m"load_config RK_KERNEL_VERSIONfiif grep -q "^RK_ROOTFS_SYSTEM=" "$RK_CUSTOM_ENV"; thenecho -e "\e[31mCustom RK_ROOTFS_SYSTEM ignored!\e[0m"load_config RK_ROOTFS_SYSTEMfififisource "$PARTITION_HELPER"rk_partition_initset +aexport PYTHON3=/usr/bin/python3export RK_KERNEL_VERSION_REAL=$(kernel_version_real)# Handle special commandscase "$OPTIONS" incleanall)run_build_hooks cleanrm -rf "$RK_OUTDIR" "$SDK_DIR/rockdev"finish_build cleanallexit 0 ;;clean:*)MODULES="$(echo ${OPTIONS#clean:} | tr ':' ' ')"for m in $MODULES; do"$SCRIPTS_DIR/mk-$m.sh" cleandonefinish_build clean - $MODULESexit 0 ;;post-rootfs)shiftrun_post_hooks $@finish_build post-rootfsexit 0 ;;esac# Save final environmentsrm -f "$RK_FINAL_ENV"env > "$RK_FINAL_ENV"ln -rsf "$RK_FINAL_ENV" "$RK_OUTDIR/"# Log configsechoecho "=========================================="echo " Final configs"echo "=========================================="env | grep -E "^RK_.*=.+" | grep -vE "PARTITION_[0-9]" | \grep -vE "=\"\"$|_DEFAULT=y" | \grep -vE "^RK_CONFIG|_BASE_CFG=|_LINK=|DIR=|_ENV=|_NAME=" | sortecho# Pre-build stage (submodule configuring, etc.)run_build_hooks pre-build $OPTIONS# No need to go furtherCMDS="$(run_build_hooks support-cmds build post-build | xargs)"option_check "$CMDS" $OPTIONS || return 0# Build stage (building, etc.)run_build_hooks build $OPTIONS# No need to go furtherCMDS="$(run_build_hooks support-cmds post-build | xargs)"option_check "$CMDS" $OPTIONS || return 0# Post-build stage (firmware packing, etc.)run_build_hooks post-build $OPTIONS
}
1.1.1 提示模式和错误处理
调试模式设置:首先通过判断是否设置了环境变量DEBUG
,决定是否启用调试模式。如果 DEBUG
被设置为非空值,则运行 set -x
开启调试模式,这样脚本执行时会显示每一行命令的执行情况。
错误处理:使用 trap
和 ERR
捕获脚本中的错误。一旦发生错误,将调用 err_handler
函数;同时,set -eE
确保如果任何命令失败,脚本会立即退出,并且支持 ERR
跟踪。
保存初始环境变量:接着尝试保存当前的环境变量到一个临时文件中。首先,它解除定义了 INITIAL_SESSION
变量(如果存在),然后使用 mktemp -u
生成一个唯一的临时文件路径。如果 RK_SESSION
变量未设置,则认为这是一个新的会话,并将所有当前环境变量保存到生成的临时文件中。
1.1.2 设置环境变量
接着是设置一系列环境变,这些变量定义了一些重要的目录路径,通常在脚本执行过程中会用到这些路径。
export LC_ALL=Cexport SCRIPTS_DIR="$(dirname "$(realpath "$BASH_SOURCE")")"
export COMMON_DIR="$(realpath "$SCRIPTS_DIR/..")"
......
realpath "$BASH_SOURCE"
获取当前脚本的绝对路径,由于build.sh
指向了device/rockchip/common/scripts/build.sh
;所以:
SCRIPTS_DIR=<SDK>/device/rockchip/common/scripts
COMMON_DIR=<SDK>/device/rockchip/common
SDK_DIR=<SDK>
DEVICE_DIR=<SDK>/device/rockchip
CHIPS_DIR=<SDK>/device/rockchip/.chips
CHIP_DIR=<SDK>/device/rockchip/.chip
RK_DATA_DIR=<SDK>/device/rockchip/common/data
RK_TOOL_DIR=<SDK>/device/rockchip/common/tools
RK_IMAGE_DIR=<SDK>/device/rockchip/common/images
RK_KBUILD_DIR=<SDK>/device/rockchip/common/linux-kbuild
RK_CONFIG_IN=<SDK>/device/rockchip/common/configs/Config.in
RK_BUILD_HOOK_DIR=<SDK>/device/rockchip/common/build-hooks
BUILD_HELPER=<SDK>/device/rockchip/common/build-hooks/build-helper
RK_POST_HOOK_DIR=<SDK>/device/rockchip/common/post-hooks
POST_HELPER=<SDK>/device/rockchip/common/post-hooks/post-helper
PARTITION_HELPER=<SDK>/device/rockchip/common/scripts/partition-helper
RK_SESSION=2024-07-08_21-52-58
RK_OUTDIR=<SDK>/output
RK_SESSION_DIR=<SDK>output/sessions
RK_LOG_BASE_DIR=<SDK>/output/log
RK_LOG_DIR=<SDK>/output/sessions/2024-07-08_21-52-58
RK_INITIAL_ENV=<SDK>/output/sessions/2024-07-08_21-52-58/initial.env
RK_CUSTOM_ENV=<SDK>/output/sessions/2024-07-08_21-52-58/custom.env
RK_FINAL_ENV=<SDK>/output/sessions/2024-07-08_21-52-58/final.env
RK_ROCKDEV_DIR=<SDK>/rockdev
RK_FIRMWARE_DIR=<SDK>/output/firmware
RK_SECURITY_FIRMWARE_DIR=<SDK>/output/security-firmware
RK_CONFIG=<SDK>/output/.config
RK_DEFCONFIG_LINK=<SDK>/output/defconfig
1.1.3 选项make-targets/make-usage
接着就是对选项make-targets
和make-usage
的支持,实际上也是输出帮助信息。
1.1.4 选项chip/defconfig
接着就是对如下选项的支持:
chip[:<chip>[:<config>]]
:<chip>
可选,表示SoC
,比如rk3588
;<config>
可选,表示板级配置,比如rockchip_defconfig
;defconfig[:<config>]
:<config>
可选,表示板级配置,比如rockchip_defconfig
;
(1) 如果有参数传递给脚本,则OPTIONS
被设置为这些参数的组合;如果没有参数传递,则OPTIONS
被设置为 allsave
。
(2) 接着对$OPTIONS
变量进行特殊处理,用于处理 chip
和defconfig
的情况。它会检查每个参数,并根据特定的条件对其进行转换。
首先:
if [ -d "$CHIPS_DIR/${opt%%:*}" ]; thenOPTIONS=$(echo "$OPTIONS" | xargs -n 1 | \sed "s/^$opt$/chip:$opt/" | xargs)
检查是否存在以$CHIPS_DIR
开头、后面跟着$opt
变量:
分隔之前的字符串作为目录名, 如果满足;修改 $OPTIONS
变量,替换内容$opt
为 chip:$opt
;
- 比如
./builsh rk3588:rockchip_defconfig
,opt=rk3588:rockchip_defconfig
,处理后OPTIONS=chip:rk3588:rockchip_defconfig
;
接着:
elif echo "$opt" | grep -q "^[0-9a-z_]*_defconfig$"; thenOPTIONS=$(echo "$OPTIONS" | xargs -n 1 | \sed "s/^$opt$/defconfig:$opt/" | xargs)
fi
如果是以_defconfig
结尾命名,修改 $OPTIONS
变量,替换内容$opt
为 defconfig:$opt
;
- 比如
./builsh rockchip_defconfig
,opt=rockchip_defconfig
,处理后OPTIONS=defconfig:rockchip_defconfig
;
1.1.5 选项检查
首先是获取支持的所有命令:
CMDS="$(run_build_hooks support-cmds all | xargs)"
xargs
将会把 run_build_hooks support-cmds all
的输出(echo
函数的输出)捕获,并通过管道传递给 xargs
。
由于run_build_hooks
函数会依次执行<SDK>/device/rockchip/common/build-hooks
下的*.sh
脚本,因此CMDS
存储的就是这些脚本执行的输出,具体分析参考后文《run_build_hooks
》。
执行完毕CMDS
中存储build.sh
支持的所有命令;
CMDS='chip defconfig lunch .*_defconfig olddefconfig savedefconfig menuconfig config shell print-parts mod-parts edit-parts new-parts insert-part del-part move-part rename-part resize-part kernel-config kernel-make kmake kernel modules linux-headers wifibt rtos buildroot debian yocto buildroot-config buildroot-make bmake rootfs buildroot debian yocto recovery pcba security_check createkeys security_ramboot security_uboot security_boot security_recovery security_rootfs loader uboot uefi firmware edit-package-file edit-ota-package-file edit-package-file edit-ota-package-file updateimg otapackage all allsave save'
接着是一段选项检查的代码;
for opt in $OPTIONS; docase "$opt" inhelp | h | -h | --help | usage | \?) usage ;;clean:*)# Check cleanup modulesfor m in $(echo ${opt#clean:} | tr ':' ' '); dogrep -wq clean_hook \"$SCRIPTS_DIR/mk-$m.sh" \2>/dev/null || usagedone;&shell | cleanall)# Check single optionsif [ "$opt" = "$OPTIONS" ]; thenbreakfiecho "ERROR: $opt cannot combine with other options!";;post-rootfs)if [ "$opt" = "$1" -a -d "$2" ]; then# Hide other args from build stagesOPTIONS=$optbreakfiecho "ERROR: $opt should be the first option followed by rootfs dir!";;*)# Make sure that all options are handledif option_check "$CMDS" $opt; thencontinuefiecho "ERROR: Unhandled option: $opt";;esacusage
done
根据传入的选项($OPTIONS
)进行判断和处理,这里遍历选项依次执行:
- 当选项满足
help | h | -h | --help | usage | \?
,执行usage
函数。比如我们前文执行./build.sh help
,就是则调用usage
函数来显示帮助信息; - 如果选项以
clean:
开头,则验证验证相应的清理模块是否存在,比如./build.sh clean:kernel
,则判断"device/rockchip/common/scripts/mk-kernel.sh/mk-kernel.sh
中是否包含clean_hook
方法;后续会调用mk-kernel.sh clean
执行清理工作; - 如果选项是
shell
或cleanall
,执行函数run_build_hooks clean
,该函数则会遍历device/rockchip/common/scripts
下shell
脚本文件,并传入clean
参数函数依次执行; - 如果选项是
post-rootfs
,并且满足上面的条件,则设置OPTIONS=$opt
; - 如果不满足以上条件,则调用
option_check
函数检查给定的命令选项是否在指定的命令列表中,如果匹配失败,则输出错误信息,并调用usage
函数。
1.1.6 准备日志目录
接着是创建编译日志目录:
# Prepare log dirs
if [ ! -d "$RK_LOG_DIR" ]; thenrm -rf "$RK_LOG_BASE_DIR" "$RK_LOG_DIR" "$RK_SESSION_DIR/latest"mkdir -p "$RK_LOG_DIR"ln -rsf "$RK_SESSION_DIR" "$RK_LOG_BASE_DIR"ln -rsf "$RK_LOG_DIR" "$RK_SESSION_DIR/latest"echo -e "\e[33mLog saved at $RK_LOG_DIR\e[0m"echo
fi
首先判断日志目录$RK_LOG_DIR
是否存在,如果该目录不存在,则执行一系列操作来创建目录结构并设置符号链接,将 $RK_LOG_DIR
符号链接到$RK_SESSION_DIR/latest
,确保最新日志目录符号链接始终指向最新的日志目录。
1.1.7 清理旧日志
接着是清理日志目录,只保留最新的10次编译的日志记录:
# Drop old logs
cd "$RK_LOG_BASE_DIR"
rm -rf $(ls -t | sed '1,10d')
cd "$SDK_DIR"
跳转到<SDK>/output/log
目录,把除了最新的10个文件或目录外的所有内容传递给rm -rf
命令进行删除操作。
1.1.8 保存初始化环境变量
接着是保存初始化环境变量;
# Save initial envionments
if [ "$INITIAL_SESSION" ]; thenrm -f "$RK_INITIAL_ENV"mv "$INITIAL_ENV" "$RK_INITIAL_ENV"ln -rsf "$RK_INITIAL_ENV" "$RK_OUTDIR/"
fi
由于前文设置INITIAL_ENV=$(mktemp-u)
,即使用mktemp -u
生成一个唯一的临时文件路径,比如/tmp/tmp.ag1ffjvNMG
。
因此该段脚本:
- 它会先删除旧的
<SDK>/output/sessions/initial.env
文件; - 然后将临时文件移动并重命名为
<SDK>/output/sessions/$RK_SESSION/initial.env
; - 最后在指定的输出目录
<SDK>/output
下创建一个指向<SDK>/output/sessions/$RK_SESSION/initial.env
的符号链接。
1.1.9 初始化阶段
脚本进入初始化阶段,用于准备SDK
配置等工作;
# Init stage (preparing SDK configs, etc.)
run_build_hooks init $OPTIONS
rm -f "$RK_OUTDIR/.tmpconfig*"
这里再次调用run_build_hooks
函数,入参为init $OPTIONS
,具体分析参考后文《run_build_hooks
》。
1.1.10 选项检查
接下来就是判断我们传入的选项是否是build.sh pre-build build post-build
阶段中定义的命令。
# No need to go further
CMDS="$(run_build_hooks support-cmds pre-build build \post-build | xargs) cleanall clean post-rootfs"
option_check "$CMDS" $OPTIONS || return 0
xargs
将会把 run_build_hooks support-cmds pre-build build post-build
的输出(echo
函数的输出)捕获,并通过管道传递给 xargs
。
由于run_build_hooks
函数会依次执行<SDK>/device/rockchip/common/build-hooks
下的sh
脚本,因此CMDS
存储的就是这些脚本执行的输出。
执行完毕CMDS
中存储build.sh
在pre-build build post-build
阶段中支持的命令;
CMDS='shell print-parts mod-parts edit-parts new-parts insert-part del-part move-part rename-part resize-part kernel-config kernel-make kmake kernel modules linux-headers wifibt rtos buildroot-config buildroot-make bmake rootfs buildroot debian yocto recovery pcba security_check createkeys security_ramboot security_uboot security_boot security_recovery security_rootfs loader uboot uefi firmware edit-package-file edit-ota-package-file updateimg otapackage all allsave save cleanall clean post-rootfs'
接着调用option_check
检查变量CMDS
中的命令是否包含在$OPTIONS
指定的选项中。
- 如果找到任何一个在任何一个选项中有匹配,则函数返回0,表示命令匹配成功;
- 如果所有的命令都没有在任何一个选项中找到匹配,则函数最终返回1,表示命令匹配失败。
如果option_check
函数返回非0值(即失败),则执行return 0
,表示退出当前函数。
1.1.11 导出config environments
# Force exporting config environments
set -a# Load config environments
source "$RK_CONFIG"
cp "$RK_CONFIG" "$RK_LOG_DIR"if [ -z "$INITIAL_SESSION" ]; then# Inherit session environmentssed -n 's/^\(RK_.*=\)\(.*\)/\1"\2"/p' "$RK_FINAL_ENV" > \"$INITIAL_ENV"source "$INITIAL_ENV"rm -f "$INITIAL_ENV"
else# Detect and save custom environments# Find custom environmentsrm -f "$RK_CUSTOM_ENV"for cfg in $(grep "^RK_" "$RK_INITIAL_ENV" || true); doenv | grep -q "^${cfg//\"/}$" || \echo "$cfg" >> "$RK_CUSTOM_ENV"done# Allow custom environments overridingif [ -e "$RK_CUSTOM_ENV" ]; thenln -rsf "$RK_CUSTOM_ENV" "$RK_OUTDIR/"echo -e "\e[31mWARN: Found custom environments: \e[0m"cat "$RK_CUSTOM_ENV"echo -e "\e[31mAssuming that is expected, please clear them if otherwise.\e[0m"read -t 10 -p "Press enter to continue."source "$RK_CUSTOM_ENV"if grep -q "^RK_KERNEL_VERSION=" "$RK_CUSTOM_ENV"; thenecho -e "\e[31mCustom RK_KERNEL_VERSION ignored!\e[0m"load_config RK_KERNEL_VERSIONfiif grep -q "^RK_ROOTFS_SYSTEM=" "$RK_CUSTOM_ENV"; thenecho -e "\e[31mCustom RK_ROOTFS_SYSTEM ignored!\e[0m"load_config RK_ROOTFS_SYSTEMfifi
fisource "$PARTITION_HELPER"
rk_partition_initset +a
1.1.12 选项claenall/clean:*/post-rootfs
export PYTHON3=/usr/bin/python3
export RK_KERNEL_VERSION_REAL=$(kernel_version_real)# Handle special commands
case "$OPTIONS" incleanall)run_build_hooks cleanrm -rf "$RK_OUTDIR" "$SDK_DIR/rockdev"finish_build cleanallexit 0 ;;clean:*)MODULES="$(echo ${OPTIONS#clean:} | tr ':' ' ')"for m in $MODULES; do"$SCRIPTS_DIR/mk-$m.sh" cleandonefinish_build clean - $MODULESexit 0 ;;post-rootfs)shiftrun_post_hooks $@finish_build post-rootfsexit 0 ;;
esac
1.1.13 保存final
环境变量
# Save final environments
rm -f "$RK_FINAL_ENV"
env > "$RK_FINAL_ENV"
ln -rsf "$RK_FINAL_ENV" "$RK_OUTDIR/"
1.1.14 预编译/编译/编译后
# Log configs
echo
echo "=========================================="
echo " Final configs"
echo "=========================================="
env | grep -E "^RK_.*=.+" | grep -vE "PARTITION_[0-9]" | \grep -vE "=\"\"$|_DEFAULT=y" | \grep -vE "^RK_CONFIG|_BASE_CFG=|_LINK=|DIR=|_ENV=|_NAME=" | sort
echo# Pre-build stage (submodule configuring, etc.)
run_build_hooks pre-build $OPTIONS# No need to go further
CMDS="$(run_build_hooks support-cmds build post-build | xargs)"
option_check "$CMDS" $OPTIONS || return 0# Build stage (building, etc.)
run_build_hooks build $OPTIONS# No need to go further
CMDS="$(run_build_hooks support-cmds post-build | xargs)"
option_check "$CMDS" $OPTIONS || return 0# Post-build stage (firmware packing, etc.)
run_build_hooks post-build $OPTIONS
1.2 option_check
option_check
函数检查给定的命令选项是否在指定的命令列表中。
option_check()
{# 将第一个参数$1赋值给变量CMDS,这个参数是一组命令列表,用空格分隔CMDS="$1"# 将参数列表向左移动一位,去掉了第一个参数(即CMDS),剩下的参数存储在$@中shift# 嵌套循环检查选项和命令for opt in $@; do # 遍历传递给函数的所有剩余参数(除了第一个参数CMDS)for cmd in $CMDS; do # 再嵌套一个循环,遍历存储在CMDS变量中的命令列表# NOTE: There might be patterns in commands 检查命令是否匹配选项,如果grep 命令没有匹配到,则继续下一次循>环echo "${opt%%:*}" | grep -q "^$cmd$" || continue# 如果匹配成功,则返回状态码 0,表示找到了匹配的命令选项return 0donedonereturn 1
}
比如我们给函数传入:
commands="run jump swim"
option_check "$commands" run swim sleep
在这个示例中:
$commands
被传递给CMDS
变量,即CMDS="run jump swim
;run swim sleep
是要检查的选项,即option1=run
、option2=swim
、option3=sleep
。
函数会逐个检查每个选项是否在命令列表CMDS
中,如果找到任意匹配的命令,则返回状态码0;否则返回状态码1。
1.3 run_hooks
run_hooks
在指定目录中查找并执行所有以 .sh
结尾的脚本文件。如果执行任何一个脚本失败,它将调用错误处理函数 err_handler
处理错误,并以失败的返回码退出整个脚本。
run_hooks()
{# 将第一个参数$1赋值给变量DIRDIR="$1"# 将参数列表向左移动一位,去掉了第一个参数(即DIR),剩下的参数存储在$@中shift# 遍历目录for dir in "$CHIP_DIR/$(basename "$DIR")/" "$DIR"; do# 当前的$dir是否是一个存在的目录。如果不是,则继续到下一个循环迭代[ -d "$dir" ] || continue# 在$dir目录下(不深入子目录,-maxdepth 1)查找所有以.sh结尾的文件for hook in $(find "$dir" -maxdepth 1 -name "*.sh" | sort); do"$hook" $@ && continue # *.sh退出状态码为0则执行continueHOOK_RET=$?err_handler $HOOK_RET "${FUNCNAME[0]} $*" "$hook $*"exit $HOOK_RETdonedone
}
比如我们给函数传入:
RK_BUILD_HOOK_DIR=<SDK>/device/rockchip/common/build-hooks
run_hooks "$RK_BUILD_HOOK_DIR" support-cmds all
在这个示例中:
-
将遍历目录
<SDK>/device/rockchip/.chip/build-hooks
、<SDK>/device/rockchip/common/build-hooks
; -
由于
<SDK>/device/rockchip/.chip/build-hooks
不是目录将跳过; -
接着在
<SDK>/device/rockchip/common/build-hooks
目录下(不深入子目录,-maxdepth 1
)查找所有以.sh
结尾的文件;依次执行- 执行找到的每一个脚本文件,传递参数
support-cmds all
; - 如果执行成功(
exit 0
),则继续下一个钩子脚本的执行; - 如果执行失败(
exit
非0),调用err_handler
函数处理错误,传递错误码、当前函数名以及传递给当前函数的所有参数,以HOOK_RET
的值退出脚本,终止整个构建过程。
- 执行找到的每一个脚本文件,传递参数
我们查看<SDK>/device/rockchip/common/build-hooks
目录下的sh
脚本;
root@ubuntu:/work/sambashare/rk3588/armsom/armsom-rk3588-bsp$ ll device/rockchip/common/build-hooks/
lrwxrwxrwx 1 root root 23 6月 9 12:58 00-config.sh -> ../scripts/mk-config.sh*
lrwxrwxrwx 1 root root 22 6月 9 12:58 00-shell.sh -> ../scripts/mk-shell.sh*
lrwxrwxrwx 1 root root 27 6月 9 12:58 05-partitions.sh -> ../scripts/mk-partitions.sh*
lrwxrwxrwx 1 root root 23 6月 9 12:58 10-kernel.sh -> ../scripts/mk-kernel.sh*
lrwxrwxrwx 1 root root 23 6月 9 12:58 20-wifibt.sh -> ../scripts/mk-wifibt.sh*
lrwxrwxrwx 1 root root 21 6月 9 12:58 25-rtos.sh -> ../scripts/mk-rtos.sh*
lrwxrwxrwx 1 root root 23 6月 9 12:58 30-rootfs.sh -> ../scripts/mk-rootfs.sh*
lrwxrwxrwx 1 root root 25 6月 9 12:58 40-recovery.sh -> ../scripts/mk-recovery.sh*
lrwxrwxrwx 1 root root 21 6月 9 12:58 50-pcba.sh -> ../scripts/mk-pcba.sh*
lrwxrwxrwx 1 root root 25 6月 9 12:58 60-security.sh -> ../scripts/mk-security.sh*
lrwxrwxrwx 1 root root 23 6月 9 12:58 70-loader.sh -> ../scripts/mk-loader.sh*
lrwxrwxrwx 1 root root 25 6月 9 12:58 80-firmware.sh -> ../scripts/mk-firmware.sh*
lrwxrwxrwx 1 root root 26 6月 9 12:58 90-updateimg.sh -> ../scripts/mk-updateimg.sh*
lrwxrwxrwx 1 root root 20 6月 9 12:58 99-all.sh -> ../scripts/mk-all.sh*
lrwxrwxrwx 1 root root 23 6月 9 12:58 build-helper -> ../scripts/build-helper
-rwxr-xr-x 1 root root 4210 6月 9 12:58 example.sh.in*
其中,比较重要的有:
00-config.sh
:板载配置相关,支持的编译选项有chip
、defconfig
、menuconfig
等;05-partitions.sh
:分区配置相关,支持的编译选项有:print-parts
、mod-parts
、edit-parts
等;10-kernel.sh
:内核编译相关,支持的编译选项有:kernel
、modules
、linux-headers
等;20-wifibt.sh
:wifibt
编译相关;30-rootfs.sh
:根文件系统编译相关,支持的编译选项有:buildroot
、yocto
、debian
等;40-recovery.sh
:recovery
编译相关;70-loader.sh
:uboot
编译相关,支持的编译选项有:loader[:cmds]
、uboot[:cmds]
、uefi[:cmds]
等;80-firmware.sh
:分区镜像打包相关;90-updateimg.sh
:统一固件打包相关;99-all.sh
:所有,支持的编译选项有:all
、save
等;
在该示例中将会按顺序依次执行*.sh
脚本,并传递参数support-cmds all
,有关这些*.sh
脚本的执行我们在后面介绍。
1.4 run_build_hooks
run_build_hooks
函数作用是运行一些构建过程中的钩子(hooks
),并且记录执行日志。
run_build_hooks()
{# Don't log these hookscase "$1" ininit | pre-build | make-* | usage | support-cmds)run_hooks "$RK_BUILD_HOOK_DIR" $@ || truereturn 0;;esac# 设置日志文件LOG_FILE="$(start_log "$1")"# 记录运行日志echo -e "# run hook: $@\n" >> "$LOG_FILE"# 运行钩子并记录输出run_hooks "$RK_BUILD_HOOK_DIR" $@ 2>&1 | tee -a "$LOG_FILE"# 处理钩子执行结果HOOK_RET=${PIPESTATUS[0]}if [ $HOOK_RET -ne 0 ]; thenerr_handler $HOOK_RET "${FUNCNAME[0]} $*" "$@"exit $HOOK_RETfi
}
函数执行流程如下:
-
根据传递给函数的第一个参数
$1
进行匹配,如果$1
匹配到init
、pre-build
、以make-
开头的任意字符串、usage
或者support-cmds
中的一个;- 调用
run_hooks
函数,并传递参数<SDK>/device/rockchip/common/build-hooks
和$@
(所有传递给当前函数的参数); || true
确保即使run_hooks
函数失败,也不会中断执行;- 返回状态码 0,表示成功执行;
- 调用
-
设置日志文件:
LOG_FILE
被设置为一个日志文件的路径,使用start_log
函数生成基于传入参数$1
的日志文件名; -
记录运行日志:将
# run hook: $@
打印到$LOG_FILE
中; -
运行钩子并记录输出:
- 再次调用
run_hooks
函数,传递<SDK>/device/rockchip/common/build-hooks
和$@
,标准错误(2)输出到(>)到标准输出(&1); - 将标准错误输出重定向到标准输出,这样可以确保错误信息也被
tee
命令捕获到; tee -a
将管道中的输出同时输出到标准输出和追加到$LOG_FILE
文件中;
- 再次调用
-
处理钩子执行结果:将管道中上一个命令的退出状态保存在
HOOK_RET
变量中,PIPESTATUS[0]
是Bash
内置的数组,包含了最近一个管道中命令的退出状态;- 如果
HOOK_RET
不等于 0,则表示有错误发生; - 调用
err_handler
数处理错误,传递错误码、当前函数名以及传递给当前函数的所有参数; - 以
HOOK_RET
的值退出脚本,终止整个构建过程。
- 如果
在编译过程中,main
函数多次调用run_build_hooks
函数的,其执行顺序依次为;
run_build_hooks support-cmds all
;run_build_hooks init recovery
;run_build_hooks support-cmds pre-build build post-build
;run_build_hooks pre-build recovery
;run_build_hooks support-cmds build post-build
;run_build_hooks build recovery
;run_build_hooks support-cmds post-build
;run_build_hooks post-buildrecovery
。
二、build-helper
build-helper
从文件名字不难猜测出来这是一个编译辅助脚本,其位于<SDK>/device/rockchip/common/build-hooks
目录下,提供了若干个辅助函数。
2. 1 脚本入口
build-helper
脚本会被<SDK>/device/rockchip/common/build-hooks
下的所有*.sh
脚本调用,并传入不同的参数,比如:
support-cmds all
;init recovery
;support-cmds pre-build build post-build
;pre-build recovery
;support-cmds build post-build
;build recovery
;support-cmds post-build
;post-build recovery
。
其中:recovery
可以替换成./build.sh
支持的任意选项,比如all
、buildroot
、uboot
、kernel
等。
脚本入口代码如下:
......# 跳转到<SDK>目录
cd "$SDK_DIR"# 比如 LOG_FILE_NAME=$(*.sh脚本名称,比如00-config)-(参数1,比如`support-cmds`)_2024-07-08_21-12-25
LOG_FILE_NAME="$(basename "${0%.sh}")-$1_$(date +"%F_%H-%M-%S")"case "$1" inhelp | h | -h | --help | \?) usage ;;make-targets) make_targets; exit 0 ;;make-usage) make_usage; exit 0 ;;usage) usage_hook; exit 0 ;;support-cmds) # 将参数列表向左移动一位,去掉了第一个参数(support-cmds),剩下的参数存储在$@中(即all)shift{ALL_CMDS="$INIT_CMDS $PRE_BUILD_CMDS $BUILD_CMDS \$POST_BUILD_CMDS"for stage in ${@:-all}; docase $stage ininit) echo "$INIT_CMDS" ;;pre-build) echo "$PRE_BUILD_CMDS" ;;build) echo "$BUILD_CMDS" ;;post-build) echo "$POST_BUILD_CMDS" ;;# 走这里,输出支持的命令 chip defconfig lunch .*_defconfig olddefconfig savedefconfig menuconfig configall) echo "$ALL_CMDS" ;; esacdone} | xargs -n 1 | grep -v "^default$" | xargs || true # 过滤掉单独包含 "default" 的行,然后将剩余的行作为参数依次传递给下一个命令exit 0;;clean)try_func clean_hookexit 0;;init)shifttry_hook init_hook "$INIT_CMDS" $@exit 0;;pre-build)shifttry_hook pre_build_hook "$PRE_BUILD_CMDS" $@exit 0;;build)shifttry_hook build_hook "$BUILD_CMDS" $@exit 0;;post-build)shifttry_hook post_build_hook "$POST_BUILD_CMDS" $@exit 0;;
esacif [ "$DRY_RUN" ]; thenecho "Environment 'DRY_RUN' ignored!"unset DRY_RUN
fiif [ "$2" = cmds ]; thenexport DRY_RUN=1
fi
2.1.1 入参为support-cmds all
如果入参为support-cmds all
,代码会进入support-cmds
分支;
support-cmds) # 走这里# 将参数列表向左移动一位,去掉了第一个参数(support-cmds),剩下的参数存储在$@中(即all)shift{ALL_CMDS="$INIT_CMDS $PRE_BUILD_CMDS $BUILD_CMDS \$POST_BUILD_CMDS"for stage in ${@:-all}; docase $stage ininit) echo "$INIT_CMDS" ;;pre-build) echo "$PRE_BUILD_CMDS" ;;build) echo "$BUILD_CMDS" ;;post-build) echo "$POST_BUILD_CMDS" ;;# 走这里,输出支持的命令 chip defconfig lunch .*_defconfig olddefconfig savedefconfig menuconfig configall) echo "$ALL_CMDS" ;; esacdone} | xargs -n 1 | grep -v "^default$" | xargs || true # 过滤掉单独包含 "default" 的行,然后将剩余的行作为参数依次传递给下一个命令exit 0;;
首先输出ALL_CMDS
,最后执行exit 0
退出*.sh
脚本(build-heleper
是在*.sh
脚本中以source
方式执行的)文件的执行;
通过代码分析,我们可以得到入参第一个参数为support-cmds
的命令均会进入该分支:
-
support-cmds all
; -
support-cmds pre-build build post-build
; -
support-cmds build post-build
; -
support-cmds post-build
;
脚本根据support-cmds
之后的参数来执行不同的处理逻辑,比如:
all
:输出所有支持的命令,包括INIT_CMDS
、PRE_BUILD_CMDS
、BUILD_CMDS
、POST_BUILD_CMDS
;pre-build
:输出PRE_BUILD_CMDS
;build
:输出BUILD_CMDS
;post-build
:输出POST_BUILD_CMDS
。
由于<SDK>/device/rockchip/common/build-hooks
目录下各个*.sh
脚本中支持的INIT_CMDS
、PRE_BUILD_CMDS
、BUILD_CMDS
、POST_BUILD_CMDS
是不同的,因此每个*.sh
脚本在使用source
命令执行build-helper
脚本时输出也是不同的。
我们以如下命令为例:
CMDS="$(run_build_hooks support-cmds all | xargs)"
xargs
将会把 run_build_hooks support-cmds all
的输出(echo
函数的输出)捕获,并通过管道传递给 xargs
。由于run_build_hooks
函数会依次执行*.sh
脚本,因此CMDS
存储的就是这些脚本执行的输出结果。
2.1.2 入参为init recovery
如果入参为init recovery
,代码会进入init
分支;
init)# 将参数列表向左移动一位,去掉了第一个参数(support-cmds),剩下的参数存储在$@中(即recovery)shifttry_hook init_hook "$INIT_CMDS" $@exit 0;;
接着会执行try_hook
函数,具体参考《try_hook
分析》。
2.1.3 入参为pre-build recovery
如果入参为pre-build recovery
,代码会进入pre-build
分支;
pre-build)shifttry_hook pre_build_hook "$PRE_BUILD_CMDS" $@exit 0;;
接着会执行try_hook
函数,具体参考《try_hook
分析》。
2.1.4 入参为build recovery
如果入参为build recovery
,代码会进入build
分支;
build)shifttry_hook build_hook "$BUILD_CMDS" $@exit 0;;
接着会执行try_hook
函数,具体参考《try_hook
分析》。
2.1.5 入参为post-build recovery
如果入参为post-build recovery
,代码会进入post-build
分支;
post-build)shifttry_hook post_build_hook "$POST_BUILD_CMDS" $@exit 0;;
接着会执行try_hook
函数,具体参考《try_hook
分析》。
2.2 err_handler
error
处理函数,脚本中的任何命令失败(即退出状态为非零),那么就会调用err_handler
函数;
err_handler()
{# 如果参数1为空,则获取最近一次执行命令的退出状态ret=${1:-$?}# 退出状态为0,直接返回[ "$ret" -eq 0 ] && return# 入参参数2为空,输出调用栈中的第二个函数名echo "ERROR: Running $0 - ${2:-${FUNCNAME[1]}} failed!"# 输出错误状态码,以及发生错误的行号echo "ERROR: exit code $ret from line ${BASH_LINENO[0]}:"# 如果参数3为空,输出当前正在执行的命令echo " ${3:-$BASH_COMMAND}"echo "ERROR: call stack:"for i in $(seq 1 $((${#FUNCNAME[@]} - 1))); doSOURCE="${BASH_SOURCE[$i]}"LINE=${BASH_LINENO[$(( $i - 1 ))]}echo " $(basename "$SOURCE"): ${FUNCNAME[$i]}($LINE)"doneexit $ret
}
trap 'err_handler' ERR
set -eE
2.3 try_hook
try_hook
函数接收3个参数:
- 参数1是被调用的
hook
函数; - 参数2是
hook
函数支持的命令数组CMDS
; - 参数3是当前需要执行的任一选项命令;
函数定义如下:
try_hook()
{# init_hook、pre_build_hook等FUNC=$1# 将参数列表向左移动一位,去掉了第一个参数(init_hook)shift# 支持的命令数组CMDS="$1"# 将参数列表向左移动一位,去掉了第二个参数(CMDS)shift# 配以default开头并且后面跟着一个空格或者直接是行尾的行if echo "$CMDS" | grep -qE "^default( |$)"; thenOPTS="default $@"else# 一般走这里OPTS="$@ default"fi# 检查名为$FUNC的函数是否存在并且可执行,不存在或不可执行则return 0type $FUNC >/dev/null 2>/dev/null || return 0# 遍历选项数组for opt in $OPTS; do#匹配包含:cmds这个字符串,并且后面紧跟着一个冒号:,或者是行尾的地方 比如opt="recovery:cmds",IS_DRY_RUN=$(echo $opt | grep -E ":cmds(:|$)" || true)# 遍历命令数组for cmd in $CMDS; do# NOTE: There might be patterns in commands .... default 姑且认为查找opt、cmd相等的项ARGS="$(echo $opt | grep -E "^$cmd(:|$)" | \tr ':' ' ' || true)"[ "$ARGS" ] || continue# D优先使用DRY_RUN变量的值,如果DRY_RUN不存在或为空,则根据IS_DRY_RUN的值来决定是否展开为1。DRY_RUN=${DRY_RUN:-${IS_DRY_RUN:+1}} \try_func $FUNC $ARGSdonedone
}
这里我们姑且认为双层循环就是查找在CMDS
数组中支持的选项,然后调用try_func
函数,并传递参数$FUNC
以及匹配到的选项。
2.3.1 入参为init_hook
build-helper
脚本中入参为init_hook
的函数调用如下:
try_hook init_hook "$INIT_CMDS" $@
由于<SDK>/device/rockchip/common/build-hooks
目录下各个*.sh
脚本中定义的init_hook
函数、INIT_CMDS
数组不相同,尽管$@
参数一样但是执行的结果均是不同的。
注意:实际上只有部分*.sh
脚本定义有init_hook
,如果该函数未定义的try_hook
会直接return 0
。
2.3.2 入参为pre_build_hook
build-helper
脚本中入参为pre_build_hook
的函数调用如下:
try_hook pre_build_hook "$PRE_BUILD_CMDS" $@
由于<SDK>/device/rockchip/common/build-hooks
目录下各个*.sh
脚本中定义的pre_build_hook
函数、PRE_BUILD_CMDS
数组不相同,尽管$@
参数一样但是执行的结果均是不同的。
注意:实际上只有部分*.sh
脚本定义有pre_build_hook
,如果该函数未定义的try_hook
会直接return 0
。
2.3.3 入参为build_hook
build-helper
脚本中入参为build_hook
的函数调用如下:
try_hook build_hook "$BUILD_CMDS" $@
由于<SDK>/device/rockchip/common/build-hooks
目录下各个*.sh
脚本中定义的build_hook
函数、BUILD_CMDS
数组不相同,尽管$@
参数一样但是执行的结果均是不同的。
注意:实际上只有部分*.sh
脚本定义有build_hook
,如果该函数未定义的try_hook
会直接return 0
。
2.3.4 入参为post_build_hook
build-helper
脚本中入参为post_build_hook
的函数调用如下:
try_hook post_build_hook "$POST_BUILD_CMDS" $@
由于<SDK>/device/rockchip/common/build-hooks
目录下各个*.sh
脚本中定义的post_build_hook
函数、POST_BUILD_CMDS
数组不相同,尽管$@
参数一样但是执行的结果均是不同的。
注意:实际上只有部分*.sh
脚本定义有post_build_hook
,如果该函数未定义的try_hook
会直接return 0
。
2.3 try_func
尝试调用某个函数,函数接收多个参数:
- 参数1为函数将要调用的
hook
函数,比如usage_hook
、init_hook
、pre_build_hook
、build_hook
、post_build_hook
、clean_hook
;这些函数一般在查看使用说明、构建的初始化阶段、预构建、构建、构建后、以及清理时被触发; - 参数2为
hook
函数的入参,传入hook
函数所支持的命令选项;
比如try_func init_hook default
,将会执行init_hook default
;
# try_func init_hook default
try_func()
{# 检查名为init_hook的函数是否存在并且可执行,不存在或不可执行则return 0type $1 >/dev/null 2>/dev/null || return 0# Don't log these hookscase "${1%_hook}" in # 第一个参数移除_hook,即initinit | pre_build)$@ # 执行init_hook defaultreturn 0;;esacif [ "$DRY_RUN" ]; thenDRY_FUNC=$1_dry # 比如build_hook_drytype $DRY_FUNC >/dev/null 2>/dev/null || return 0# 将参数列表向左移动一位,去掉了第1个参数shift# 函数调用$DRY_FUNC $@return 0fi# 设置日志文件LOG_FILE="$(start_log ${LOG_FILE_NAME%%_*} $LOG_FILE_NAME)"、# 记录运行日志echo -e "# run func: $@\n" >> "$LOG_FILE"# 运行钩子并记录输出$@ 2>&1 | tee -a "$LOG_FILE"# 处理钩子执行结果FUNC_RET=${PIPESTATUS[0]}if [ $FUNC_RET -ne 0 ]; thenerr_handler $FUNC_RET "${FUNCNAME[0]} $*" "$@"exit $FUNC_RETfi
}
判断调用的是不是init_hook
、pre_build_hook
函数,如果是执行该函数并将参数传入,执行完后return 0
;
如果是build_hook
、post_build_hook
等函数,
- 如果
$DRY_RUN
存在将会执行$1_dry
,比如build_hook_dry 参数2
,执行完后return 0
; - 否则将会执行如下过程:
- 设置日志文件:
LOG_FILE=output/sessions/latest/$(*.sh脚本名称,比如00-config)-(参数1,比如support-cmds)_创建时间
; - 记录运行日志:将
# run hook: $@
打印到$LOG_FILE
中; - 运行钩子并记录输出:
- 调用钩子函数,并将标准错误(2)输出到(>)到标准输出(&1);
- 将标准错误输出重定向到标准输出,这样可以确保错误信息也被
tee
命令捕获到; tee -a
将管道中的输出同时输出到标准输出和追加到$LOG_FILE
文件中;
- 处理钩子执行结果:将管道中上一个命令的退出状态保存在
FUNC_RET
变量中,PIPESTATUS[0]
是Bash
内置的数组,包含了最近一个管道中命令的退出状态;- 如果
FUNC_RET
不等于 0,则表示有错误发生; - 调用
err_handler
数处理错误,传递错误码、当前函数名以及传递给当前函数的所有参数; - 以
FUNC_RET
的值退出脚本,终止整个构建过程。
- 如果
- 设置日志文件:
三、00-config.sh
00-config.sh
脚本位于<SDK>/device/rockchip/common/build-hooks/
目录,这里我们挑选一些重点内容介绍。
3.1 脚本入口
首先执行SDK/device/rockchip/common/build-hooks/build-helper
脚本,会将这个脚本的内容直接加载到当前shell
环境中执行,build-helper.sh
能够获取父文件中的变量和参数;
# source SDK/device/rockchip/common/build-hooks/build-helper
source "${BUILD_HELPER:-$(dirname "$(realpath "$0")")/../build-hooks/build-helper}"init_hook $@
使用source
命令执行脚本的一些注意事项:
- 环境变量和函数的影响:被执行的脚本可以修改当前
shell
的环境变量和定义的函数,这些修改将持续影响到当前shell
的会话,直到会话结束或者重新定义了这些变量和函数。 - 退出状态:被执行的脚本的退出状态(即最后一个命令的退出状态)会影响到当前
shell
。可以通过$?
变量来获取最近一次执行命令的退出状态; - 交互性:与直接执行脚本不同,使用
source
执行脚本时,不会创建新的shell
环境,因此不会有新的子shell
进程。这使得它适合于需要脚本和当前shell
环境之间相互影响的场景,例如定义函数或设置环境变量;
3.2 usage_hook
usage_hook
用于输出当前脚本支持的命令;
usage_hook()
{echo -e "chip[:<chip>[:<config>]] \tchoose chip"echo -e "defconfig[:<config>] \tchoose defconfig"echo -e " *_defconfig \tswitch to specified defconfig"echo " available defconfigs:"ls "$CHIP_DIR/" | grep "defconfig$" | sed "s/^/\t/"echo -e " olddefconfig \tresolve any unresolved symbols in .config"echo -e " savedefconfig \tsave current config to defconfig"echo -e " menuconfig \tinteractive curses-based configurator"echo -e "config \tmodify SDK defconfig"
}
3.3 init_hook
init_hook
函数在构建的初始化阶段被调用,用于处理INIT_CMDS
命令;
INIT_CMDS="chip defconfig lunch .*_defconfig olddefconfig savedefconfig menuconfig config default"init_hook()
{case "${1:-default}" inchip) shift; choose_chip $@ ;;lunch|defconfig) shift; choose_defconfig $@ ;;*_defconfig) switch_defconfig "$1" ;;olddefconfig | savedefconfig | menuconfig)prepare_config$MAKE $1;;config)prepare_config$MAKE menuconfig$MAKE savedefconfig;;default) prepare_config ;; # End of init*) usage ;;esac
}
在调用init_hook
函数时可以传入以上任一命令作为选项,init_hook
将会执行不同的分支:
chip
:执行choose_chip $@
函数;lunch|defconfig
:执行choose_defconfig $@
函数;_defconfig
:执行switch_defconfig "$1"
函数;olddefconfig | savedefconfig | menuconfig
:执行prepare_config
函数;config
:执行prepare_config
函数、$MAKE menuconfig
、$MAKE savedefconfig
;default
:执行prepare_config
函数;- 不满足以上命令,将会执行
usage
输出该脚本用法;
3.3.1 入参为default
执行prepare_config
函数;
# 如果板载配置不存在在,选择板载配置
prepare_config()
{ # 如果<SDK>/device/rockchip/.chip路径不存在,则执行choose_chip选择芯片# 如果存在,其指向如下:.chip -> .chips/rk3588/[ -e "$CHIP_DIR" ] || choose_chip# 进入<SDK>/device/rockchipcd "$DEVICE_DIR"# 查找/device/rockchip/.chips目录下文件,即删除rk3588 rk3588 -> .chips/rk3588/rm -f $(ls "$CHIPS_DIR") # ln -rsf .chips/rk3588 .ln -rsf "$(readlink "$CHIP_DIR")" .# 跳转到SDK目录cd "$SDK_DIR"# 如果<SDK>/output/defconfig文件不存在或不可读,则执行choose_chip选择芯片 if [ ! -r "$RK_DEFCONFIG_LINK" ]; thenecho "WARN: $RK_DEFCONFIG_LINK not exists"choose_defconfigreturn 0fi# 由<SDK>/output/defconfig -> ../device/rockchip/.chips/rk3588/rockchip_rk3588_sige7_defconfig,得到rockchip_rk3588_sige7_defconfigDEFCONFIG=$(basename "$(realpath "$RK_DEFCONFIG_LINK")")# 检查两个文件是否不是同一个文件if [ ! "$RK_DEFCONFIG_LINK" -ef "$CHIP_DIR/$DEFCONFIG" ]; thenecho "WARN: $RK_DEFCONFIG_LINK is invalid"choose_defconfigreturn 0fi# 检查文件$RK_CONFIG是否比$RK_DEFCONFIG_LINK更旧if [ "$RK_CONFIG" -ot "$RK_DEFCONFIG_LINK" ]; thenecho "WARN: $RK_CONFIG is out-dated"$MAKE $DEFCONFIG &>/dev/nullreturn 0fiCONFIG_DIR="$(dirname "$RK_CONFIG_IN")"if find "$CONFIG_DIR" -cnewer "$RK_CONFIG" | grep -q ""; thenecho "WARN: $CONFIG_DIR is updated"$MAKE $DEFCONFIG &>/dev/nullreturn 0fiCFG="RK_DEFCONFIG=\"$(realpath "$RK_DEFCONFIG_LINK")\""if ! grep -wq "$CFG" "$RK_CONFIG"; thenecho "WARN: $RK_CONFIG is invalid"$MAKE $DEFCONFIG &>/dev/nullreturn 0fiif [ "$RK_CONFIG" -nt "${RK_CONFIG}.old" ]; then$MAKE olddefconfig &>/dev/nulltouch "${RK_CONFIG}.old"fi
}
3.1.2 入参为_defconfig
执行switch_defconfig
函数:
switch_defconfig()
{DEFCONFIG="$1"[ -f "$DEFCONFIG" ] || DEFCONFIG="$CHIP_DIR/$DEFCONFIG"if [ ! -f "$DEFCONFIG" ]; thenecho "No such defconfig: $1"exit 1fiecho "Switching to defconfig: $DEFCONFIG"rm -f "$RK_DEFCONFIG_LINK"ln -rsf "$DEFCONFIG" "$RK_DEFCONFIG_LINK"DEFCONFIG="$(realpath "$DEFCONFIG")"rm -rf "$CHIP_DIR"ln -rsf "$(dirname "$DEFCONFIG")" "$CHIP_DIR"$MAKE $(basename "$DEFCONFIG")
}
参考文章
[1] Rockchip_Developer_Guide_Linux_Software_CN.pdf
[2] repo
介绍与使用
[3] Rockchip_Developer_Guide_Linux_Upgrade_CN.pdf
[4] Rockchip RK3588 - NanoPC-T6
开发板介绍
[5] Rockchip RK3399 - NanoPC-T4
开发板介绍
[6] Buildroot
根文件系统构建
[7] Debian
根文件系统构建