754d96ebc5
tools/windows/ .ps1 (pwsh, so usable from Linux and macOS too)
tools/posix/ .sh
tools/python/ .py
tools/ .c and .pl
The .c and .pl files stay at the top level because they are not
host-specific: the build compiles or invokes them on every platform.
Call sites updated in the Makefile, ports/mk/port.mk, docs and the
project memory. The one thing that does not survive a move on its own is
a script deriving the repo root from its own location -- all nine
PowerShell tools used Split-Path $PSScriptRoot -Parent, and memory-sync.sh
used dirname/.., both of which quietly become tools/ one level deeper.
Two levels now.
Two pre-existing Windows failures surfaced while verifying, both real and
neither caused by the move:
- schfs_fsck.c did not compile under mingw at all: --extract uses
POSIX mkdir(path,mode), symlink() and link(), none of which mingw
has. That took the whole tool with it, and `make schfs-check` with
it. mkdir maps to _mkdir; symlink and link fail loudly rather than
writing a regular file in their place, because an extracted tree
that differs from the image while reporting success defeats the
point of --extract.
- the round-trip test then failed at `ln -s`, since Git Bash cannot
create symlinks without developer mode. It skips with a message now.
Not a fudge: mkschfs's mingw build cannot see a symlink either, so
the test would have compared a tree with none against an image with
none and called it a pass -- coverage reporting itself as present
while being absent.
Verified on Windows: build clean, all seven bootcheck suites green,
make schfs-check passes.
115 lines
4.9 KiB
Markdown
115 lines
4.9 KiB
Markdown
<!-- SPDX-License-Identifier: Apache-2.0 -->
|
|
# Building SchOS
|
|
|
|
Supported hosts: **Linux, macOS, FreeBSD/OpenBSD/NetBSD, and Windows** (under
|
|
Git Bash or MSYS2). The build is developed from both Windows and Linux, so a
|
|
change that only works on one of them is a bug.
|
|
|
|
```sh
|
|
make # kernel + bootloader + root filesystem -> schos.img
|
|
make qemu # build and boot it
|
|
```
|
|
|
|
## Prerequisites
|
|
|
|
| Need | Why | Windows | Linux | macOS | BSD |
|
|
|---|---|---|---|---|---|
|
|
| `clang`, `ld.lld`, `llvm-objcopy`, `llvm-objdump` | cross-compiles the kernel, the 16/32-bit boot code, and musl userland | LLVM installer | `clang lld llvm` | `brew install llvm` | `pkg install llvm` |
|
|
| `make` | — | Git Bash | `make` | Xcode CLT | `gmake` |
|
|
| `perl` | generates the interrupt vector table | Git Bash | usually present | present | `pkg install perl5` |
|
|
| `python3` | boot logo, crash-screen QR | python.org (`python`) | `python3` | `brew install python` | `pkg install python3` |
|
|
| `qemu-system-x86_64` | running and testing | `scoop install qemu` | `qemu-system-x86` | `brew install qemu` | `pkg install qemu` |
|
|
| `curl`, `tar` | fetching ports | Git Bash | present | present | present |
|
|
| `xorriso` **or** `mkisofs` | `make iso` only | `scoop install cdrtools` | `xorriso` | `brew install xorriso` | `pkg install xorriso` |
|
|
|
|
A host C compiler (`cc`) is also needed, for the tools that build the disk
|
|
images. On Windows that must be **mingw-w64's gcc**, not clang: clang defaults
|
|
to an MSVC target there, and `tools/mkfs.c` needs `<unistd.h>` and `<dirent.h>`,
|
|
which the Windows SDK does not have.
|
|
|
|
## Why clang rather than a cross-gcc
|
|
|
|
clang is a cross-compiler by construction, so one ordinary LLVM install targets
|
|
everything this tree needs — bare-metal ELF, code linked below one megabyte, and
|
|
Linux/musl userland — from any host. A cross binutils+gcc would be a day of
|
|
setup per platform that then rots, and on macOS it means brewing
|
|
`x86_64-elf-gcc` before anything builds at all.
|
|
|
|
The Makefile selects clang+lld whenever both are on `PATH`. To force the GNU
|
|
toolchain instead:
|
|
|
|
```sh
|
|
make USE_GNU=1 # needs a cross toolchain that emits x86_64 ELF
|
|
make USE_GNU=1 TOOLPREFIX=x86_64-elf-
|
|
```
|
|
|
|
## Testing
|
|
|
|
```sh
|
|
tools/windows/bootcheck.ps1 # boots, drives the shell, asserts on output
|
|
tools/windows/bootcheck.ps1 -Tty -Ps # plus terminal behaviour and process listing
|
|
make schfs-check # SchFS unit, object and image suites
|
|
```
|
|
|
|
`bootcheck` is PowerShell, and PowerShell 7 (`pwsh`) runs on Linux, macOS and
|
|
the BSDs as well as Windows — `brew install powershell`, or your distribution's
|
|
`powershell` package. It finds QEMU on `PATH`.
|
|
|
|
Booting to a prompt proves nothing on its own: a filesystem can mount and still
|
|
fail the first real command, which has happened here. `bootcheck` types commands
|
|
at the serial console and greps the transcript for the answers they should
|
|
produce.
|
|
|
|
## Ports
|
|
|
|
`musl`, `toybox` and `mksh` are built from source into `sysroot/`. **This does
|
|
not work on a Windows host** — `make` prints `ports: skipped` and uses whatever
|
|
is already staged in `sysroot/`. Building them needs a Linux host (or any other
|
|
Unix); do it once and the staged result serves the Windows builds.
|
|
|
|
## Where the tools live
|
|
|
|
`tools/` is grouped by what runs the file, so it is obvious at a glance which
|
|
tools a given host can use:
|
|
|
|
```
|
|
tools/
|
|
windows/ .ps1 PowerShell (pwsh runs these on Linux and macOS too)
|
|
posix/ .sh shell
|
|
python/ .py
|
|
*.c host programs -- compiled by the build, run everywhere
|
|
*.pl perl, likewise
|
|
```
|
|
|
|
The `.c` and `.pl` files stay at the top level because they are not
|
|
host-specific: the build compiles or invokes them on every platform.
|
|
|
|
A script that needs the repo root derives it from its own location, so anything
|
|
moved between these directories has to have that adjusted — the PowerShell tools
|
|
use `Split-Path (Split-Path $PSScriptRoot -Parent) -Parent`, two levels up.
|
|
|
|
## Known host differences, already handled
|
|
|
|
Listed because they are the shape of the next such bug, not because anything is
|
|
outstanding:
|
|
|
|
- `<sys/sysmacros.h>` is glibc/musl only. macOS and the BSDs take `major()` and
|
|
`minor()` from `<sys/types.h>`.
|
|
- `sha256sum` exists on Linux and Git Bash; macOS has `shasum -a 256`,
|
|
FreeBSD/NetBSD `sha256`, OpenBSD `cksum -a sha256`. `tools/posix/sha256check.sh`
|
|
finds whichever is present.
|
|
- `nproc` is coreutils, so absent on macOS and BSD, where it is
|
|
`sysctl -n hw.ncpu`.
|
|
- In the PowerShell tools, path literals must use forward slashes:
|
|
`Join-Path $root 'build\x'` produces a *filename containing a backslash* on a
|
|
Unix host.
|
|
|
|
## Working on two machines
|
|
|
|
Claude Code's project memory is kept in the repo and moved with:
|
|
|
|
```sh
|
|
tools/posix/memory-sync.sh status
|
|
tools/posix/memory-sync.sh export # after a session that learned something; then commit
|
|
tools/posix/memory-sync.sh import # after cloning or pulling elsewhere
|
|
```
|