快速入门指南

英文原文快照

检出Zircon代码

注意：由于Fuchsia也包含了Zircon的代码，请查看Fuchsia的入门指南。如果仅专注于Zircon的开发，请参考此文档。

Zircon的git仓库位于：https://fuchsia.googlesource.com/zircon (译者注：Github的镜像在此)

假设在环境中已设置好$SRC变量（译者注：即Fuchsia的工作目录），克隆Zircon仓库到本地：

  1. git clone https://fuchsia.googlesource.com/zircon $SRC/zircon
  2. # 或者
  3. git clone https://github.com/fuchsia-mirror/zircon $SRC/zircon

在文档接下来的部分，我们已假设Zircon已经被检出到$SRC/zircon目录下，进而工具链、QEMU等也将在$SRC下进行构建。多个make命令通过-j32选项被并行调用，如果这种并行度对于你的机器比较吃力，请尝试-j16或者-j8选项。

准备构建环境

Ubuntu

在Ubuntu系统中，下面的命令可以获取所需的依赖：

  1. sudo apt-get install texinfo libglib2.0-dev autoconf libtool libsdl-dev build-essential

macOS

安装Xcode命令行工具（Command Line Tools）：

  1. xcode-select --install

安装其他的依赖项：

  • 使用Homebrew：

    1. brew install wget pkg-config glib autoconf automake libtool

  • 使用MacPorts：

    1. port install autoconf automake libtool libpixman pkgconfig glib2

    <!—-

    Install Toolchains

If you’re developing on Linux or macOS, there are prebuilt toolchain binaries avaiable. Just run this script from your Zircon working directory:

  1. ./scripts/download-prebuilt

If you would like to build the toolchains yourself, follow the instructions later in the document. —->

安装工具链

如果你的开发环境是Linux或macOS，已有预编译的工具链可直接进行下载，只需在Zircon的工作目录下运行下列脚本即可：

  1. ./scripts/download-prebuilt

如果你想自己构建工具链，请依照本文档后面的步骤执行。

构建Zircon

构建生成的文件位于$SRC/zircon/build-{arm64,x64}下。

对于特定的构建目标，下面示例中的$BUILDDIR变量指向构建的输出目录。

  1. cd $SRC/zircon
  3. # 对于aarch64
  4. make -j32 arm64
  6. # 对于x64
  7. make -j32 x64

使用Clang

如果你想使用Clang作为构建Zircon的工具链，请在调用make时使用USE_CLANG=true选项。 <!—-

  1. cd $SRC/zircon
  3. # for aarch64
  4. make -j32 USE_CLANG=true arm64
  6. # for x64
  7. make -j32 USE_CLANG=true x64

—->

  1. cd $SRC/zircon
  3. # 对于aarch64
  4. make -j32 USE_CLANG=true arm64
  6. # 对于x86-64
  7. make -j32 USE_CLANG=true x64

为所有目标体系结构构建Zircon

  1. # -r选项也将同时编译release版本
  2. ./scripts/buildall -r

请在提交代码变更之前为所有目标体系结构构建一次，已保证代码在所有体系结构上能工作。

QEMU

如果你使用真实硬件进行测试，那么可以跳过此步骤，但是模拟器可以很方便地进行快速本地测试，所以该步骤通常是值得进行的。

对于在zircon中构建和使用QEMU，请查看相应的文档（英文原文）。

构建Toolchains（可选项）

如果预编译工具链对于你的系统不适用，为了在ARM64和x86-64上构建Zircon，也有一些脚本可用于你下载和构建合适的gcc工具链： <!—-

  1. cd $SRC
  2. git clone https://fuchsia.googlesource.com/third_party/gcc_none_toolchains toolchains
  3. cd toolchains.
  4. ./do-build --target arm-none
  5. ./do-build --target aarch64-none
  6. ./do-build --target x86_64-none

—->

  1. cd $SRC
  2. git clone https://fuchsia.googlesource.com/third_party/gcc_none_toolchains toolchains
  3. cd toolchains.
  4. ./do-build --target arm-none
  5. ./do-build --target aarch64-none
  6. ./do-build --target x86_64-none

为toolchains配置PATH环境变量

如果使用的是预编译工具链，构建过程可以自动找到它们，因此可跳过此步骤。

  1. # 对于Linux
  2. export PATH=$PATH:$SRC/toolchains/aarch64-elf-5.3.0-Linux-x86_64/bin
  3. export PATH=$PATH:$SRC/toolchains/x86_64-elf-5.3.0-Linux-x86_64/bin
  5. # 对于Mac
  6. export PATH=$PATH:$SRC/toolchains/aarch64-elf-5.3.0-Darwin-x86_64/bin
  7. export PATH=$PATH:$SRC/toolchains/x86_64-elf-5.3.0-Darwin-x86_64/bin

Zircon双向拷贝文件

若本地IPv6网络配置成功，便可以使用主机工具./build-zircon-ARCH/tools/netcp来拷贝文件。

  1. # 拷贝myprogram文件到Zircon
  2. netcp myprogram :/tmp/myprogram
  4. # 拷贝Zircon的myprogram文件到开发主机
  5. netcp :/tmp/myprogram myprogram

添加额外的用户态文件

Zircon的构建过程会产生一个bootfs镜像，它包含系统启动必需的用户态组件（包括设备管理器，一些设备驱动等）。除此之外，内核也能够包含一个以ramdisk镜像的形式，由QEMU或者bootloader提供的额外镜像。

为了产生该bootfs镜像，请使用在构建中同时生成的mkbootfs工具。mkbootfs可以通过两种方式装配出一个bootfs镜像：通过目标目录（该目录的所有文件和子目录都将包含在内）或通过逐行列出需要包括在内的清单文件： <!—-

  1. $BUILDDIR/tools/mkbootfs -o extra.bootfs @/path/to/directory
  3. echo "issue.txt=/etc/issue" > manifest
  4. echo "etc/hosts=/etc/hosts" >> manifest
  5. $BUILDDIR/tools/mkbootfs -o extra.bootfs manifest

—->

  1. $BUILDDIR/tools/mkbootfs -o extra.bootfs @/path/to/directory
  3. echo "issue.txt=/etc/issue" > manifest
  4. echo "etc/hosts=/etc/hosts" >> manifest
  5. $BUILDDIR/tools/mkbootfs -o extra.bootfs manifest

在Zircon系统启动完成后，bootfs镜像中的文件将出现在/boot目录下，所以上面例子中的”host”文件位于/boot/etc/hosts。

对于QEMU，请使用run-zircon-*脚本的-x选项来指定额外的bootfs镜像。

网络启动

有两种机制支持网络启动Zircon：Gigaboot和Zirconboot。Gigaboot是基于EFI的bootloader，而Zirconboot则是允许一个最小化的zircon系统来充当启动zircon自身的bootloader。

在支持通过EFI启动的硬件设备（如Acer和NUC）上，上述两种方式都是支持的。而对于其他系统，zirconboot可能是网络启动的唯一选项。

通过Gigaboot启动

基于GigaBoot20x6（英文原文）的bootloader使用一种简单的基于IPV6的UDP网络启动协议，它不需要特殊的服务器配置和使用权限设置。

它利用IPV6链路的本地寻址和广播来达到此目的，允许目标设备发布它的启动消息，开发主机在接收消息后发送启动镜像到目标设备。

如果你有运行GigaBoot20x6的硬件设备（例如配备Broadwell或Skylake结构的CPU的Intel NUC），请首先手动创建USB启动盘（英文原文），或使用脚本（仅针对Linux）。然后运行： <!—-

  1. $BUILDDIR/tools/bootserver $BUILDDIR/zircon.bin
  3. # if you have an extra bootfs image (see above):
  4. $BUILDDIR/tools/bootserver $BUILDDIR/zircon.bin /path/to/extra.bootfs

—->

  1. $BUILDDIR/tools/bootserver $BUILDDIR/zircon.bin
  3. # 如果有额外的bootfs镜像（见上）：
  4. $BUILDDIR/tools/bootserver $BUILDDIR/zircon.bin /path/to/extra.bootfs

引导服务器默认将一直运行，一旦检测出有网络启动的请求，它就会将内核（包括bootfs，如果有的话）发送到该请求设备上。如果在启动引导服务时传递-1选项，那么它将在执行一次成功的启动后停止服务并退出。

通过Zirconboot启动

Zirconboot是一种允许Zircon系统充当启动Zircon自身的bootloader机制，而且Zirconboot使用和前文提到的Gigaboot相同的启动协议。

为了使用Zirconboot，请通过在kernel命令行种传递netsvc.netboot=true选项到Zircon的方式。当Zirconboot启动时，它将试图从挂载于开发主机的引导服务器上获取并启动zircon系统。

通过网络查看日志

Zircon的构建过程默认包含了网络日志服务，它通过本地IPv6的UDP协议广播系统日志。请注意，这只是一种快速能用的方式，未来某个时刻协议肯定会发生改变。

当前，如果你在QEMU上加-N选项运行zircon或者在配备以太网卡的真实硬件上（ASIX上的USB网络适配器或NUC上的Intel网卡），loglistener工具可以通过本地网络接收日志广播：

  1. $BUILDDIR/tools/loglistener

调试

关于在Zircon环境中进行调试的随机提示信息，请查看调试（英文原文）部分。

贡献代码变更