7.6 构建系统开发指南
BSP 源码包下载地址参见: 系统软件(需要注册登录)
商业版提供更完整的功能支持、更深入的硬件能力开放和专属的定制内容。为确保内容合规、安全交付,我们将通过以下方式开放商业版访问权限。
商业版本获取流程:
- 填写问卷:提交您的机构信息、使用场景等基本情况
- 签署保密协议(NDA):我们将根据提交信息与您联系,双方确认后签署保密协议
- 内容释放:完成协议签署后,我们将通过私有渠道为您开放商业版本资料
如您希望获取商业版内容,请点击下方链接填写问卷,我们将在 3 ~ 5 个工作日内与您联系: https://horizonrobotics.feishu.cn/share/base/form/shrcnpBby71Y8LlixYF2N3ENbre
7.6.1 概述
本章节主要针对需要对 RDK 构建系统进行定制化修改的介绍,rdk_gen 的使用说明,请参考 rdk_gen 仓库的 README.md。
基本的使用说明:
# 在线镜像构建,从地瓜及第三方APT源下载依赖的deb包
sudo ./pack_image.sh
# 离线镜像构建,只安装out/product/deb_packages下的deb包,使用此选项时请确保out/product/deb_packages内的deb符合预期,同时out/product/rootfs_packages下已有预编译根文件系统包
sudo ./pack_image.sh -l
# 仅搭建deb包编译环境,不打包镜像
sudo ./pack_images.sh -p
# 构建所有deb包
./mk_debs.sh
# 构建特定deb包,以hobot-configs为例
./mk_debs.sh hobot-configs
7.6.2 根文件系统预编译包构建说明
根文件系统由 multistrap+chroot 构建生成。
multistrap
官方文档
工具简介
总结而言,multistrap是独立于debbootstrap工具的另一套 debian/Ubuntu 等以 apt 源为基础生成根文件系统的工具。它基于一个/多个配置文件定义生成根文件系统所使用的 apt 源,以及需要默认生成哪些包。
与debootstrap最大的区别有以下几点:
- 灵活性:
multistrap允许用户完全自定义新生成的根文件系统内的所有包,包括 apt 源内标记为必选的包,但是用户需要自行保证根文件系统的完整性和可用性; - 生成流程:
multistrap不同于debbootstrap,它的生成流程可以概括为以下几个步骤,最大的区别在于 第四步,multistrap只进行包的解压缩,没有对包进行配置(也就是执行[pre/post]install 脚本): - 读取配置文件
- 根据配置文件从获取指定的 apt 源的元数据
- 根据配置文件尝试下载指定的包
- 根据配置文件解压缩指定的包
在地瓜提供的
multistrap编译脚本中,我们基于实践经验,通过使用binfmt-support + chroot,在 sudo 权限下实现了对包的配置,以达到用户制作的根文件系统可以直接烧录上板使用。
配置文件简介
multistrap的配置文件支持单文件/多文件两种形式。多文件情况下可以通过"include"字段将基础版本所包含的所有内容添加上后,只针对特定版本进行配置,极大的方便了多文件系统的维护工作。
以下章节内容的配置文件路径:samplefs/configs:
$ tree samplefs/configs/
samplefs/configs/
├── jammy-base.conf
├── jammy-desktop.conf
├── jammy-server.conf
├── noble-base.conf
├── noble-desktop.conf
└── pip-requirements.list
0 directories, 6 files
- RDK S100: 使用
jammy-*配置文件(Ubuntu 22.04) - RDK S600: 使用
noble-*配置文件(Ubuntu 24.04)
基本格式介绍
详细的字段介绍请参考官方文档,这里主要针对地瓜的配置文件中的重要配置进行说明。
- 字段:
key1=value1的格式,定义了某个字段"key1"的值为"value1" - 字段集(stanza/section):通过定义"
[Some-Section]"来归集从该行开始,到下一个"[Next-Section]"为止中间所有字段为一个"Section"
重点字段介绍:
- include
- 定义需要 include 的配置文件的路径
- bootstrap
- 定义生成根文件系统所使用的 apt 源和要下载并解压缩的包所在的字段集
- aptsources
- 定义生成的根文件系统中路径/etc/sources.list.d/内会保存的 apt 源所在的字段集。注意,这个源不一定需要与 bootstrap 中用于生成根文件系统的源保持一致,但我们强烈建议 aptsources 定义的 apt 源是 bootstrap 定义的源的超集。
- source/suite/components/omitdebsrc
- 定义 apt 源使用的关键字。可以参考apt源格式定义
- source:apt 源的根链接,与 apt 源格式的"uri"字段匹配
- suite:apt 源的 suite,与 apt 源格式的"suite"字段匹配,一般代表该源对应的系统 code name+属性,例如 Ubuntu 的 jammy/focal/noble/jammy-updates/noble-security
- components:apt 源的 component,与 apt 源格式的"component"字段匹配,同样可以添加多个
- omitdebsrc:拉取 apt 元数据及包时,是否下载 deb 包对应的 src 包,一般配置为"true",即不下载 deb 包对应的 src 包,以加速构建。
- packages
- 用于定义需要拉取的包的字段,一个 packages 字段可以定义多个包,包之间以空格分隔,多个 packages 字段的合集会作为最终的包定义。
多文件配置示例
请参考代码路径samplefs/configs/jammy-desktop.conf
请参考代码路径samplefs/configs/noble-desktop.conf
RDK 的实现
配置文件设计
RDK 上,multistrap 的配置文件默认根据平台分为多个部分:
- jammy-base.conf:用于配置 RDK S100通用的默认根文件系统配置,包括使用的 apt 源,RDK S100所有版本默认包含的包等;
- jammy-desktop.conf:用于配置 RDK S100桌面版根文件系统基于 jammy-base.conf 新增的包;
- jammy-server.conf:用于配置 RDK S100服务器版根文件系统基于 jammy-base.conf 新增的包;
- noble-base.conf:用于配置 RDK S600通用的默认根文件系统配置,包括使用的 apt 源,RDK S600所有版本默认包含的包等;
- noble-desktop.conf:用于配置 RDK S600桌面版根文件系统基于 noble-base.conf 新增的包;
构建流程说明
用户一般使用samplefs/make_ubuntu_samplefs.sh脚本来进行根文件系统的构建,如果使用 sudo 调用该脚本,则根文件系统构建过程会包括对包的配置,耗时会显著增加。
如果不使用 sudo 调用该脚本,则构建过程不会包括对包的配置,耗时会相对减少,但是首次启动需要在板端使用命令rm -rf /var/lock/* ; dpkg --configure -a --force-confdef --force-confold ; systemctl enable /etc/systemd/system/S*.service命令来初始化系统并重启以确保系统正常工作。
推荐使用 sudo调用 samplefs/make_ubuntu_samplefs.sh。
调用samplefs/make_ubuntu_samplefs.sh脚本需要在 samplefs 目录下进行。
在不添加参数的情况下直接在使用sudo ./make_ubuntu_samplefs.sh:
脚本默认构建桌面版镜像,也就是使用jammy-desktop.conf文件来构建根文件系统。
脚本默认构建桌面版镜像,也就是使用noble-desktop.conf文件来构建根文件系统。
指定使用的配置文件的命令:sudo ./make_ubuntu_samplefs.sh build <config_file_name>,例如新增的配置文件为:new-desktop.conf,则命令就是:sudo ./make_ubuntu_samplefs.sh build new-desktop.conf,new-desktop.conf文件需要放到samplefs/configs文件夹内。
脚本构建流程图如下:
裁剪/自定义根文件系统的方法
apt 源(deb 包的 control 信息)中的 Priority 字段会区分裁剪/自定义的流程。 multistrap 默认会将所有 Priority 为"Required"的包进行安装。 地瓜定义 important 包也会被安装。
仅裁剪/自定义 apt 优先级不为"important"/"required"的包
用户直接在 samplefs/configs/jammy-base.conf 等配置文件的各个"packages"字段中删除自己不需要的包,或者定义一个新的字段集,并在"[General]"字段集的"boostrap"字段中去掉原有字段集并添加自己的字段集即可。
用户直接在 samplefs/configs/noble-base.conf 等配置文件的各个"packages"字段中删除自己不需要的包,或者定义一个新的字段集,并在"[General]"字段集的"boostrap"字段中去掉原有字段集并添加自己的字段集即可。
需要裁剪/自定义 apt 优先级为"important"/"required"的包
注意:一般来说各个 apt 源的维护者会将他们认为该系统(Ubuntu/Debian 的各个版本)的最小集的包的优先级标为"Required",但是是可以进一步裁剪的。进行这种程度的根文件系统裁剪时,用户需要自己保证根文件系统的完整性和可用性。
步骤如下:
- 在
[Gerneral]字段集中添加omitrequired=true; - 在
Packages中对所有需要添加的包进行定义。
7.6.3 RDK deb 包构建流程说明
简介
RDK 默认以 deb 包的形式来管理用户层的地瓜定制功能。在 SDK 的 source/目录下保存了所有地瓜定制功能的 deb 包构建的源码。
构建脚本介绍
构建 deb 的入口脚本为mk_debs.sh,该脚本位于 SDK 包的根目录。用户可以通过该脚本构建仓库内的 deb 包。
deb 包源码目录
source下的目录,除bootloader,kernel,hobot-drivers外均为地瓜定制化功能的 deb 包的构建源码。其中hobot-spdev,hobot-camera,hobot-io等目录内包含了相应动态库的源码,通过 mk_debs.sh 脚本构建这两个包时,对应的源码会被编译。
deb 包源码目录的基本结构(以 hobot-configs 为例)内会包括:
hobot-configs/
├── LICENSE # deb包源码的License信息
├── README.md # deb包的简单说明
├── VERSION # deb包的版本号,以major.minor.patch的形式保存,编译时默认添加时间戳
└── debian # deb包的根目录,相当于板端安装时的根目录
├── DEBIAN # deb包的元数据信息
| ├── postinst # deb包标准脚本之一,在dpkg安装的拷贝步骤后执行
│ ├── postrm # deb包标准脚本之一,在dpkg删除的文件删除步骤后执行
│ ├── preinst # deb包标准脚本之一,在dpkg安装的拷贝步骤前执行
│ └── prerm # deb包标准脚本之一,在dpkg删除的文件删除步骤前执行
├── etc # 具体需要拷贝到根文件系统的文件,根据实际情况创建即可。相对"debian"的目录,就是相对根文件系统的目录,例如这个目录就会被安装到板端/etc目录下
├── lib # 具体需要拷贝到根文件系统的文件,根据实际情况创建即可。
└── usr # 具体需要拷贝到根文件系统的文件,根据实际情况创建即可。
包含源码的 deb 包目录,则会在 debian 目录之外,新增源码目录,如 hobot-camera:
hobot-camera/
├── LICENSE
├── README.md
├── VERSION
├── debian
│ ├── DEBIAN
│ ├── etc
│ └── usr
├── drivers # 需要编译的源码目录
│ ├── Makefile # 源码编译的入口Makefile
│ ├── deserial # 源码子目录
│ ├── inc
│ └── sensor
├── lib -> ../hobot-multimedia/debian/usr/hobot/lib # 方便编译的源码软连接
├── sensor_calibration # Sensor tuning库,下列库仅为示例,以实际情况为准
│ └── lib_imx219_linear.so
└── tuning_tool # 地瓜提供的Sensor tuning工具
├── bin
├── cfg
├── control_tool
├── res
└── scripts
构建流程说明
详细流程请参考mk_debs.sh脚本实现,以下是一个简略的流程图:
自定义 deb 包流程说明
- 在
source/文件夹下,新建对应包的包名(dpkg 内的 package name)命名的文件夹,这里以"new_package"为例; - 在
source/new_package文件夹下,新建debian文件夹,里面创建4个脚本文件,这4个脚本文件可以为空:- preinst:安装 new_package 包拷贝前需要执行的脚本;
- postinst:安装 new_package 包拷贝执行完成后需要执行的脚本;
- prerm:移除 new_package 包执行删除命令前需要执行的脚本;
- postrm:移除 new_package 包执行删除命令后需要执行的脚本。
- 如果需要在
mk_debs.sh不带入参时自动对该包进行编译,则在mk_debs.sh脚本的deb_pkg_list变量内添加new_package字段; - 在
mk_debs.sh脚本的make_debian_deb函数的switch内添加new_package的case:- 在
case内调度gen_control_file函数,生成构建 deb 包所需要的 control 文件; - 在
case内调度sed命令,将默认的"depends"字段替换为真正的 deb 依赖。假设new_package的依赖为dep_pkg1和dep_pkg2;- 如果有依赖,则使用
sed -i 's/Depends: .*$/Depends: dep_pkg1,dep_pkg2/' "${deb_dst_dir}"/DEBIAN/control; - 如果没有依赖,则使用
sed -i 's/Depends: .*$/Depends: /' "${deb_dst_dir}"/DEBIAN/control;
- 如果有依赖,则使用
- (可选)如果该 deb 在打包前,需要进行源码编译,则进行源码编译命令的调度,请注意最终的所有输出,均需要 输出到
out/build/debs/new_pkg/debian/目录下; - 置位
is_allowed=1
- 在
7.6.4 deb 包编入镜像流程说明
在镜像构建的过程中,deb 包会被编入板端根文件系统内。
在线镜像构建
流程说明
当pack_image.sh不添加-l 选项进行调度时,会进入在线镜像构建流程。流程介绍如下:
- 从
pack_image.sh的DEFAULT_CONFIG字段获取当前的默认编译配置文件,例如 S100为build_params/ubuntu-22.04_desktop_rdk-s100_release.conf,S600为build_params/ubuntu-24.04_desktop_rdk-s600_release.conf;- 该配置文件可以通过-c 选项指定
- 从编译配置文件内获取
RDK_DPKG_DEB_PKG_LIST字段; - chroot 到
out/deploy/rootfs目录下:- 根据
RDK_DPKG_DEB_PKG_LIST字段从现有板端 apt 源内尝试下载所有 deb 包; - 安装所有 deb 包;
- 根据