build-camkes.sh

#! /bin/bash
#
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# This script is derived from work by mwitkowski@antmicro.com

# Script for building a CAmkES test setup using the minimal bits from
# CantripOS. This is meant for testing cantrip-os-common portability and as
# a pathway to public use of the Rust code bits.
#
# This script assumes you have a gnu toolchain setup for the target
# platform and the associated "bin" dir in your shell's search path.
# The rust compiler likewise must be in your search path; the script
# will use rustup to request target support.
#
# Beware the CantripOS Rust code currently uses a nightly build of Rust.
# Check projects/cantrip/apps/system/rust.cmake for cargo usage.
#
# The riscv* and arm/aarch* targets are build tested and in some cases
# tested under simulation. The x86* targets are untested and likely
# do not compile. There are many arm target flavors and only the basic
# stuff may work; in particular don't expect any hypervisor support to
# work without effort.

# TODO(sleffler): add install-* scripts for necessary toolchains
# TODO(sleffler): import dependent simulators as needed: qemu, spike, renode

TARGET_ARCH=${1:-aarch64}
EXTRA_INIT_ARGS=
MACHINE=

case ${TARGET_ARCH} in
arm|aarch32)
    EXTRA_INIT_ARGS="${EXTRA_INIT_ARGS} -DSIMULATION=TRUE -DAARCH32=TRUE"
    CROSS_COMPILER_PREFIX="arm-none-eabi-"
    RUST_TARGET="arm-unknown-linux-gnueabi"
    PLATFORM=omap3
    ;;
aarch64)
    EXTRA_INIT_ARGS="${EXTRA_INIT_ARGS} -DSIMULATION=TRUE -DAARCH64=TRUE"
    CROSS_COMPILER_PREFIX="aarch64-none-linux-gnu-"
    RUST_TARGET="${TARGET_ARCH}-unknown-none"
    PLATFORM=rpi3
    MACHINE=raspi3b
    ;;
riscv32)
    # https://docs.sel4.systems/Hardware/spike.html
    # assumes --enable-multilib toolchain
    EXTRA_INIT_ARGS="${EXTRA_INIT_ARGS} -DRISCV32=TRUE"
    CROSS_COMPILER_PREFIX="riscv32-unknown-elf-"
    RUST_TARGET="riscv32imac-unknown-none-elf"
    PLATFORM=spike
    ;;
riscv64)
    # https://docs.sel4.systems/Hardware/spike.html
    # assumes --enable-multilib toolchain
    EXTRA_INIT_ARGS="${EXTRA_INIT_ARGS} -DRISCV64=TRUE"
    CROSS_COMPILER_PREFIX="riscv64-unknown-linux-gnu-"
    RUST_TARGET="riscv64imac-unknown-none-elf"
    PLATFORM=spike
    ;;
esac

mkdir camkes-${TARGET_ARCH}-rootserver
cd camkes-${TARGET_ARCH}-rootserver

# NB: "no" disables colorization
echo 'no' | repo init -u https://spacebeaker.googlesource.com/shodan/manifest -m camkes-manifest.xml
repo sync -j$(nproc)

# Export required variables
# TODO: requiring SEL4_DIR & SEL4_OUT_DIR in the environment is
#   awkward; maybe add fallback/defaults in the build glue

export ROOTDIR="$(pwd)"
export SEL4_DIR="${ROOTDIR}/kernel"
export SEL4_OUT_DIR="${ROOTDIR}/build/kernel"

# NB: the gnu toolchain is expected to be in your shell search PATH; e.g.
# cd ~
# wget https://developer.arm.com/-/media/Files/downloads/gnu/11.2-2022.02/binrel/gcc-arm-11.2-2022.02-x86_64-aarch64-none-linux-gnu.tar.xz
# tar xf gcc-arm-11.2-2022.02-x86_64-aarch64-none-linux-gnu.tar.xz
# PATH=~/gcc-arm-11.2-2022.02-x86_64-aarch64-none-linux-gnu/bin:$PATH

# NB: use an existing toolchain but make sure the necessary target is installed
rustup target add --toolchain nightly-2021-11-05-x86_64-unknown-linux-gnu ${RUST_TARGET}

# Run cmake to build the ninja files
test -d build || {
    mkdir build
    pushd build
    ../init-build.sh \
        -DCROSS_COMPILER_PREFIX=${CROSS_COMPILER_PREFIX} \
        -DRUST_TARGET=${RUST_TARGET} \
        -DPLATFORM=${PLATFORM} \
        -DCAPDL_LOADER_APP=cantrip-os-rootserver \
        -DSIMULATION=TRUE \
        ${EXTRA_INIT_ARGS}
    popd # build
}

# Run ninja to do the actual build
pushd build
ninja -j$(nproc)

# If there's a simulator you can test the rootserver
if test -x simulate; then
  ./simulate -M ${MACHINE}
else
  echo "No simulate script so don't know how to test machine ${MACHINE}"
fi
popd # build