面向 VLink workspace 的跨平台构建与交付工具

English | 中文 · 官方网站 · 变更日志 · 许可证

VKit 是 VLink workspace 的统一构建入口。它把多仓库源码、跨平台工具链、分层组件、部署目录和 SDK / Runtime 包装在一套命令里，让 VLink 及其依赖在 Linux / QNX / Android / macOS / Windows 上保持一致的构建与交付方式。

VKit 不替代 CMake，也不主打通用依赖管理。它关注的是 VLink 这类多仓库、多平台、多设备工程如何稳定构建和交付。

适合使用 VKit 的场景：

• 一个 workspace 下有多个仓库，且组件之间存在固定构建顺序。
• 同一套代码需要面向多个目标平台或多个设备配置交付。
• 既要支持本地单组件迭代，也要让 CI 使用同一套入口产出 runtime / SDK 包。

不必使用 VKit 的场景：

• 只需要管理第三方库版本，优先考虑 Conan / vcpkg。
• 单仓库、单平台的小项目，直接使用 CMake 会更轻量。

推荐 Ubuntu 22.04，最低 Ubuntu 20.04。

sudo apt-get -y install \
    git git-lfs \
    autoconf automake tclsh \
    build-essential ninja-build \
    ccache rsync \
    python3 openjdk-17-jdk \
    doxygen graphviz
sudo pip install vcs2l

cmake / ripvcs / protoc / flatc / fastddsgen 随仓库提供，会由 vkit-setup.sh 加入 PATH。

依赖分工：

git clone <vkit-url> vkit && cd vkit

$EDITOR repos/full/*.repos

make import_full

源码集合：

如果使用开发者集合：

make import_dev

默认 VKIT_PLATFORM=auto。常见平台只需准备对应环境：

# Linux x86_64（本机）       无需额外设置
# Linux aarch64（交叉编译）  export CROSS_COMPILE_PREFIX=/opt/.../bin/aarch64-none-linux-gnu-
# QNX                        source ~/.qnx/qnxsdp-env.sh
# Android                    export ANDROID_NDK=/opt/android-ndk-r27

auto 只自动识别常用目标。需要 qnx-x86_64、android-x86_64 等目标时，显式设置：

export VKIT_PLATFORM=qnx-x86_64

source vkit-setup.sh
make

make 会按配置顺序构建组件，并生成 runtime 包。需要 SDK 包时：

make deploy_sdk

VKIT_PLATFORM 表示目标平台，例如 linux-aarch64。VKIT_DEVICE 表示可选设备层，例如 myecu。

两者组合得到 VKIT_DEVICE_PLATFORM，并用于隔离产物：

build/<DEVICE_PLATFORM>/
prebuilt/<DEVICE_PLATFORM>/
prebuilt-private/<DEVICE_PLATFORM>/
packup/<DEVICE_PLATFORM>/

同一份源码可以同时维护多个平台或设备，只要在不同 shell 中设置不同的 VKIT_PLATFORM / VKIT_DEVICE。

.cfg 用一行描述一个组件：

middleware/my-component; -DBUILD_SHARED_LIBS=ON -DMY_FEATURE=ON

分号前是组件路径，分号后是传给 CMake 的参数。

Runtime 包面向目标设备，保留运行所需的 target/ 内容。SDK 包在 runtime 基础上保留 CMake 配置、host 工具和开发期依赖，适合离线集成或下游工程二次构建。

组件如果只提供编译期依赖，应安装到 prebuilt-private/，避免把开发期内容带进运行时包。

source vkit-setup.sh
cd middleware/vlink

mmm                         # 使用 cfg 中的参数构建当前组件
mm '-DENABLE_VIEWER=ON'     # 直接传 CMake 参数
mm clean                    # 清理当前组件

切换配置参数后，建议先清理当前组件再重新构建。

mm_thirdparty
mm_vendor
mm_middleware
mm_app
mm_all                      # 等价于 make install

切换平台或设备时通常不需要清理，VKit 会按 VKIT_DEVICE_PLATFORM 隔离目录。只有切换同一组件的配置参数、排查缓存问题或准备干净产物时，才需要主动清理。

在 repos/<dev|full>/<层>.repos 注册仓库：

repositories:
  middleware/my-component:
    type: git
    url: <git-url>
    version: <branch-or-tag>

在 config/<平台>/<层>.cfg 加入构建项：

middleware/my-component; -DBUILD_SHARED_LIBS=ON

组件需要提供 CMakeLists.txt、cmake/CMakeLists.txt、build.sh 或 Makefile 之一。

仅用于编译或链接、不需要进入 runtime 包的依赖，可以显式安装到私有前缀：

thirdparty/my-headers; -DENABLE_INSTALL_PRIVATE=ON -DBUILD_SHARED_LIBS=OFF

这类依赖仍会被后续组件搜索到，但不会默认进入部署包，适合 header-only 库、静态库和构建期工具。

mkdir -p config/linux-aarch64-mydev
cp config/linux-aarch64/middleware.cfg config/linux-aarch64-mydev/
$EDITOR config/linux-aarch64-mydev/middleware.cfg

export VKIT_DEVICE=mydev
export CROSS_COMPILE_PREFIX=...
make

设备层只需要覆盖与平台默认配置不同的部分。

外置 toolchain 用于接入 OE / Yocto / 厂商 SDK。推荐位置：

~/vkit-toolchains/<name>/<name>_setup.sh

示例：

export OE_CMAKE_TOOLCHAIN_FILE=/opt/myoe/cmake-toolchain.cmake
export SYSROOT=/opt/myoe/sysroot
export CC=$SYSROOT/usr/bin/aarch64-poky-linux-gcc
export CXX=$SYSROOT/usr/bin/aarch64-poky-linux-g++
export VKIT_PLATFORM=linux-aarch64

使用：

source vkit-setup.sh <name>
make

当目标不属于现有平台矩阵时，按以下顺序接入：

1. 在 cmake/toolchain.cmake 中增加新的 VKIT_PLATFORM 分发分支。
2. 在 cmake/<os>/ 下增加对应 toolchain 文件。
3. 从相近平台复制一份 config/<platform>/，保留需要构建的层和组件。
4. 设置 VKIT_PLATFORM=<new-platform> 后执行 make 验证。

新增平台时优先复用现有组件的 CMake 工程，不要为平台差异改动组件目录结构。

本项目采用 MIT License 开源。