Skip to content

build.md

Latest commit

 

History

History
151 lines (110 loc) · 4.39 KB

build.md

File metadata and controls

151 lines (110 loc) · 4.39 KB
Raw

Build {#development_build}

The root CMake project uses foliSDK's CMake to build host tools, user-space programs, Vellum, and Strata. Build foliSDK first and keep its host and target tool directories at the front of PATH while configuring foliOS.

SDK Toolchain

Build foliSDK with the build-directory layout:

(cd folisdk && ./build.py --arch x86_64 --builddir-layout --jobs 18)

Then expose the SDK tools from the root of the foliOS checkout:

export PATH="$(pwd)/folisdk/build/folisdk-host/bin:$(pwd)/folisdk/build/folisdk-x86_64/bin:$PATH"

Use folisdk/build/folisdk-host/bin/cmake for configure and build commands. This keeps the kernel, bootloader, SDK runtime, and user-space programs on the same toolchain.

Rebuilding SDK Runtime Components

Do not rebuild SDK internals by entering folisdk/build/* directories and running make or cmake --build directly. The SDK build script owns the order, stamps, install destinations, and build-directory layout. Bypassing it can leave the sysroot, startup objects, or user-space programs linked against stale runtime objects.

After changing folisdk/musl-strata, rerun the musl pass through build.py:

(cd folisdk && python3 build.py --arch=x86_64 --builddir-layout --rerun-step build-musl-pass2-x86_64)

After changing folisdk/libstrata, rerun libstrata and the musl passes that consume its installed headers and libraries:

(cd folisdk && python3 build.py \
    --arch=x86_64 \
    --builddir-layout \
    --rerun-step build-libstrata-x86_64 \
    --rerun-step build-musl-pass1-x86_64 \
    --rerun-step build-musl-pass2-x86_64)

Then relink any user-space programs that may have pulled in the changed runtime objects before rebuilding Strata. For the temporary SystemManager package:

rm -f build/syspkgs_temp/SystemManager/main.app
folisdk/build/folisdk-host/bin/cmake --build build --target system_manager --parallel=18
folisdk/build/folisdk-host/bin/cmake --build build --target strata --parallel=18

Configure

The common development target is BIOS-based AMD64:

folisdk/build/folisdk-host/bin/cmake \
    -S . \
    -B build \
    -DCMAKE_BUILD_TYPE=Debug \
    -DTARGET=amd64-pc-bios \
    -DCMAKE_EXPORT_COMPILE_COMMANDS=ON

TARGET uses the arch-platform-firmware format. The top-level build derives TARGET_ARCH, TARGET_PLATFORM, and TARGET_FIRMWARE from that value, then passes the relevant settings into the Vellum and Strata external projects.

For AMD64 Strata, Vellum is still built as IA-32:

if ("${TARGET_ARCH}" STREQUAL "amd64")
    set(VELLUM_TARGET_ARCH ia32)
endif()

That split is also reflected in disk image creation.

Build

Build everything:

folisdk/build/folisdk-host/bin/cmake --build build --parallel=18

Build one component explicitly:

folisdk/build/folisdk-host/bin/cmake --build build --target vellum
folisdk/build/folisdk-host/bin/cmake --build build --target strata

The external project build directories are normally:

  • build/vellum;
  • build/strata;
  • build/docs/doxygen for generated documentation.

Documentation

Generate all documentation outputs:

folisdk/build/folisdk-host/bin/cmake --build build --target docs-doxygen-all

Doxygen HTML uses doxygen-awesome-css by default. CMake downloads the pinned release into the build directory during configuration instead of tracking it as a submodule. Disable the theme with -DFOLIOS_DOXYGEN_AWESOME=OFF.

The generated references are split by component:

  • build/docs/doxygen/html: top-level conceptual docs;
  • build/docs/doxygen/strata/html: Strata reference;
  • build/docs/doxygen/vellum/html: Vellum reference;
  • build/docs/doxygen/common/html: common loader ABI reference.

Static Analysis

Configure with clang-tidy enabled:

folisdk/build/folisdk-host/bin/cmake \
    -S . \
    -B build \
    -DCMAKE_BUILD_TYPE=Debug \
    -DTARGET=amd64-pc-bios \
    -DCMAKE_EXPORT_COMPILE_COMMANDS=ON \
    -DENABLE_CLANG_TIDY=ON

Run the scripted targets after the component build exists:

folisdk/build/folisdk-host/bin/cmake --build build --target tidy-strata
folisdk/build/folisdk-host/bin/cmake --build build --target tidy-vellum
folisdk/build/folisdk-host/bin/cmake --build build --target tidy-all

The tidy scripts use the root .clang-tidy configuration and add target-aware compiler arguments so kernel and bootloader headers are parsed under the right architecture.