BBCI is a simple tool for building, booting and testing kernel.
An extra goal is to have a reference of all possible QEMU machine bootable with Linux.
BBCI is licensed under the GPL-v2
For using BBCI, you need the following:
- A LAVA instance for booting devices/qemu See https://www.lavasoftware.org/
- A web server for hosting builded kernel, since LAVA need to download them The docroot need to be set in lab/datadir
- A collection of rootfs for all arches. Availlable via the lab/rootfs_baseuri parameter.
- A toolchain for building. Note that BBCI could download one for you
This is an example on how to test linux-next on x86 qemu. This example assume you build on a X86 machine, see next example for cross compiling.
./bbcy.py -s next -a create
This will checkout linux-next in the directory specified in sources.yaml, in the following examples, it will be $HOME/linux-next
sources:
- name: next
directory: $HOME/linux-next
gituri: https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git
update_script: ./scripts/git-stable
ltag: next-
./bbci.py -s next -t x86_defconfig -a build
This will build next in the directory specified in config.yaml (BBCI build kernel out of tree).
config:
builddir: $HOME/crossbuild
For building BBCI will use the x86_defconfig specified in targets.yaml
targets:
- name: x86_defconfig
larch: x86
flavour: defconfig
defconfig: i386_defconfig
full_tgt: bzImage modules
warnings: "-W1"
So in this example, BBCi will build the i386_defconfig
./bbci.py -s next -t x86_defconfig -a boot
This is an example on how to test the 4.20 stable Linux tree on ARM qemu.
Add the following source section:
- name: stable-4.20
directory: $HOME/linux-stable-4.20
gituri: https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
update_script: ./scripts/git-stable
ltag: v4.20
Then do
./bbcy.py -s stable-4.20 -a create
This will checkout sources in $HOME/linux-stable-4.20
./bbcy.py -s stable-4.20 -t arm_defconfig -a download
./bbci.py -s stable-4.20 -t arm_defconfig -a build
./bbci.py -s stable-4.20 -t arm_defconfig -a boot
./bbci.py -s source -t target -a action
You can separate source, target and actions by "," You can also use all for source and target. You can use defconfig for target for filtering only targets with defconfig: attribute.
Example: build all source with all targets and boot them
./bbci.py -s all -t all -a build,boot
- One sourcename
- A list of sourcename separated by ","
- all
- Only one targetname
- A list of targetname separated by ","
- all
- defconfig
- download: download toolchain for specified targets
- build
- boot
- qemu
- A devicetag
- qemu: Select only qemu machines
Instead of exiting after ended the boot action (sending all jobs to LAVA server) bbci will wait for all jobs to end This is WIP.
See config overlay below
When using a randconfig target, use SEED as config seed.
./bbci.py -s source -t target -a build
./bbci.py -s source -t target -a boot
Testing linux-next with ARM devices
./bbci.py -s next -t arm_generic -a build
./bbci.py -s next -t arm_generic -a boot
Build linux-next targeting arm64:
./bbci.py -s next -t arm64_generic -a build
Then boot it
./bbci.py -s next -t arm64_generic -a boot
This section configure general bbci options
config:
builddir: (mandatory) where to store build output
toolchains: (mandatory) where to store downloaded toolchains
cache: (mandatory) where to store cached objects
This section configure availlable toolchains
toolchains:
- name: (mandatory) Name of the toolchains
larch: (mandatory) The linux arch compilable by this toolchain
url: (optional) Where to download this toolchain
prefix: (mandatory) The prefix of this toolchain
This section configure sources and where to store them
sources:
- name: (mandatory) Nickname of the sources
directory: (mandatory) Where are sources located
gituri: (optional) The GIT URI for creating the repo
update_script: (optional) the patch to a script which update the sources
update_command: (optional) A command which update the sources (ex: git pull)
tag: (optional) A tag option for update_script
Note:
- update_script and update_command and ran after a chdir on "directory".
- Furthermore update_script will be ran with directory as first argument and an optional "-T tag" if tag is set.
Example:
- name: next
directory: $HOME/linux-next
gituri: https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git
update_script: ./scripts/git-stable
tag: next-
"./bbci.py -s next -a create" Will checkout linux-next in $HOME/linux-next "./bbci.py -s next -a update" Will update linux-next in $HOME/linux-next
Target triplet are arch/subarch/flavour:
- Arch need to be set to arch as used by Linux.
- Subarch are for either, SoC names for ARM/ARM64, 32/64 for others.
- Flavour are for having different kernel for the same arch/subarch
targets:
- name: (mandatory) Name of the target
larch: (mandatory) Architecture as called by Linux
cross_compile: (mandatory) cross_compile prefix (or None)
full_tgt: (mandatory) make target to compile (Example: zImage modules)
warnings: (optional) Flags for warning
defconfig: (optional) A defconfig name to use
Examples:
- arm/bcm2835/default
- mips/mips64/malta
- arm64/a64/banapi
- arm64/a64/pine64
Note: If defconfig is not set, a .config must be already present in the final build directory.
When building defconfig, sometime it miss some needed options. Config overlays permit to tweak some configs after the defconfig generation You can add configoverlays via the "-o". Multiple overlays can be specified, separated by ",".
configoverlays:
- name: crypto
list:
- config: config to enable
- config: config to disable
disable: True
Example:
- name: debug
list:
- config: CONFIG_DMA_API_DEBUG=y
- config: CONFIG_DEBUG_INFO=y
- config: CONFIG_DEBUG_KERNEL=y
The following config overlays are hardcoded:
- fulldebug: Enable all debug options
- fullcrypto: Enable all crypto options
- fulldrm: Enable all DRM options
- fullsound: Enable all sound options
- vanilla: Disable all builtin changes
- nomodule: Replace all CONFIG from modules to builtin
- name: unused
arch: (mandatory) Arch of the device
larch: (optional) Arch of the device as named by Linux (default to $arch)
devicetype: (mandatory) LAVA device type
devicename: (optional) Name displayed in LAVA jobs; default to devicetype
kernelfile: (mandatory) kernel file used for booting (zImage, vmlinux, ...)
mach: (mandatory) mach of device as used by kernelCI
qemu: (optional) Specific informations for QEMU devices
machine: (mandatory) QEMU machine type
memory: (optional)
model: model=xx (optional) Network card
guestfs_interface: (optional) Interface for connecting the LAVA test storage
extra_options: (optional) Options for this device, at least the console is needed (WiP console will be set as console:)
- '-append "console=ttyS0 root=/dev/ram0"'
- "-device ide-hd,drive=test"
configs: (optional) List of kernel configs needed/recommanded (WIP)
- CONFIG_PCNET
- CONFIG_RTC_CMOS
- CONFIG_PIIX
tags: (optional)
- ok
The labs entry describes a LAVA lab and how to interact with it.
labs:
- name: (mandatory) Nickname of the LAB
lavauri: (mandatory) URI to access the LAVA LAB
datadir: (mandatory) Local directory where to copy data (kernel, dtb, modules) to use if bbCI is run on datahost
datahost: (mandatory) FQDN of the host storing data (kernel, dtb, modules)
datahost_baseuri: (mandatory) Base URI to access data (kernel, dtb, modules)
rootfs_loc: (mandatory) name of the rootfs location (found in rootfs.yaml)
rootfs:
nameofrootfsloc:
rootfs_baseuri: base URI for rootfs
initrd_baseuri: base URI for initrd
ramdisk:
rootfs: path to rootfs
nfs:
initrd: path to initrd
rootfs:
nbd:
rootfs_script: Script giving path/URL to rootfs
rootfs and initrd will have ARCH_ENDIAN replace by the arch endian name. rootfs_script must accept the following parametrs:
- arch (mandatory) the archendian for the rootfs
- cachedir
- root (mandatory) type of rootfs (nfs/ramdisk/nbd) and need to print the following variables: ROOTFS_URL (mandatory) ROOTFS_BASE (mandatory) ROOTFS_PATH (mandatory) ROOTFS_SHA512 (optional)
- Split build action in two (config and build)
- toolchain selection: currently it uses the first good one id find
- toolchain cycling: like source/target
- The cross_compile: None assume the host is x86, this is a wrong assumption. bbci should detect the host arch.
- Split all.yaml in config.yaml + many linuxarch.yaml
- More arch
- more documentation on buildroot and test
- change boot-method
- NBD
- NFS
- PXE
| Arch | board | Boot | Tests | ||
| HDD | NFS | NBD | |||
| alpha | clipper | OK | OK | ||
| ARM | Cubieboard | OK | OK | ||
| Sabrelite | OK | OK | |||
| virt | OK | OK | |||
| vexpress-a9 | OK | OK | |||
| vexpress-a15 | OK | OK | |||
| versatile | OK | OK | |||
| imx-mcimx6ul-evk | OK | OK | |||
| versatilepb | OK | ||||
| cheetah | WIP | ||||
| smdkc210 | OK | ||||
| nuri | OK | ||||
| xilinx-zynq-a9 | KO | ||||
| n800 | KO | ||||
| n810 | KO | ||||
| sx1 | WIP | ||||
| ARM64 | virt | OK | OK | ||
| xlnx-versal-virt | OK | ||||
| xlnx-zcu102 | OK | ||||
| raspi3 | KO | ||||
| MIPS | malta | OK | OK | ||
| MIPS64 | malta | OK | OK | ||
| PowerPC | G3beige | OK | OK | ||
| virtex-ml507 | OK | KO | |||
| Sam460ex | OK | ||||
| mac99 | OK | ||||
| bamboo | OK | ||||
| mpc8544ds | OK | ||||
| PPC64 | pseries | OK | |||
| x86 | pc | OK | |||
| x86_64 | pc | OK | |||
| SPARC | SS-10 | OK | |||
| SPARC64 | sun4u | OK | |||
- taihu: uboot support removed 2/3 years ago
- 40p: Cannot boot it
- ppce500: need -bios uboot
- ref405ep: TODO
- mips: Cannot boot it
- mipssim: Cannot boot it
- magnum: Need non-free firmware https://www.betaarchive.com/forum/viewtopic.php?f=62&t=6256
- pica61: Probably the same as magnum
- SS-10 and all other SS-XX: kernel crash with initrd (need to send fix to upstream)
- niagara: need external firmware
- sun4v: experimental, fail to boot
- No test (missing storage)
- boot stuck
- Not enough RAM for test
- Need initrd at buildtime