Reorganize source tree: kernel/, v3/, v4/ split and board infrastructure

Source tree reorganization:
- Move StarForth v3 engine to v3/ (src/, include/, Makefile)
- Move kernel to kernel/ (src/, include/, linker/, Makefile)
- Create v4/ skeleton for F18-ISA golden model (DECOMPOSITION.md, JUSTIFICATION.md)
- Move FABRIC-0..4.md to docs/fabric/
- Move ONTOLOGY.md and ROADMAP.md to docs/

Board infrastructure:
- Add boards/ser5/, boards/raspi/, boards/milkv/, boards/zynq7020/
- Each board has board.mk (ISA, CPU flags, boot recipe) and README.md
- Root Makefile becomes thin dispatcher: boot_image, all, clean, docs take TARGET
- make boot_image TARGET=SER5|RASPI|MILKV builds one GPT/MBR image per board
- ZYNQ7020 target exists but stops with clear error (ARMv7 port not built yet)
- scripts/mkdiskimage.sh builds disk images for all boards

Docs pipeline:
- docs/book/ with LaTeX master (main.tex) and Makefile
- pandoc converts Markdown to LaTeX at build time
- Two Lua filters: table-widths.lua (wide tables wrap), code-breaks.lua (inline code breaks)
- make docs builds single PDF (754 pages, 0 missing characters)
- make docs TARGET=<board> adds board appendix
- build/docs/<book|board>/meta.tex stamps git commit into PDF

Bug fixes:
- 42 include paths that only worked by accident now use correct relative paths
- clang-18 hardcode replaced with configurable CC variable (fixed aarch64 build)
- Pi 5: kernel_2712.img linked at 0x80000, .bss zeroed, memory reserved
- Doxyfile, .clang-tidy, README.md, Kconfig paths updated

Verified:
- Hosted v3 build passes 1012 tests, 0 failures
- SER5 image boots in QEMU (OVMF), POST passes, K exact (65536 = Q48_ONE)
- Milk-V image boots in QEMU (OpenSBI + U-Boot + bootefi), POST passes
- make clean TARGET=<board> removes only that board and its ISA objects
- make all builds all boards, hosted v3, and docs in one run

Co-authored-by: Junie <junie@jetbrains.com>
This commit is contained in:
rajames
2026-10-01 15:40:09 -04:00
co-authored by Junie
parent 3c709c115b
commit a8b70e88d3
630 changed files with 2646 additions and 2036 deletions
+23
View File
@@ -0,0 +1,23 @@
# linker/
GNU ld linker scripts for the LithosAnanke UEFI kernel. Three ISAs × two
build variants (monolithic loader / split ELF kernel).
## Files
| Script | ISA | Use |
|--------|-----|-----|
| `starkernel-amd64.ld` | amd64 | Monolithic build (loader + kernel in one PE32+) |
| `starkernel-loader-amd64.ld` | amd64 | UEFI loader (split build) |
| `starkernel-loader-amd64-pe.ld` | amd64 | PE32+ format (split build) |
| `starkernel-kernel-amd64.ld` | amd64 | ELF kernel (split build) |
| `starkernel-loader-aarch64.ld` | aarch64 | UEFI loader (split build) |
| `starkernel-loader-aarch64-pe.ld` | aarch64 | PE32+ format (split build) |
| `starkernel-kernel-aarch64.ld` | aarch64 | ELF kernel (split build) |
| `starkernel-loader-riscv64.ld` | riscv64 | UEFI loader |
| `starkernel-kernel-riscv64.ld` | riscv64 | ELF kernel |
## See also
- [`Makefile.starkernel`](../Makefile.starkernel) — selects the correct script per `ARCH`
- [Project root](../README.md)
+52
View File
@@ -0,0 +1,52 @@
/* Linker script for StarKernel (amd64/x86_64) */
/* UEFI PE32+ format */
OUTPUT_FORMAT("elf64-x86-64")
OUTPUT_ARCH(i386:x86-64)
ENTRY(efi_main)
SECTIONS
{
/* Base address for UEFI applications (1MB) */
. = 0x100000;
__kernel_start = .;
.text : {
__text_start = .;
*(.text.entry)
*(.text .text.*)
__text_end = .;
}
.rodata : ALIGN(4K) {
__rodata_start = .;
*(.rodata .rodata.*)
__rodata_end = .;
}
.data : ALIGN(4K) {
__data_start = .;
*(.data .data.*)
__data_end = .;
}
.rela.dyn : ALIGN(4K) {
*(.rela .rela.*)
}
.bss : ALIGN(4K) {
__bss_start = .;
*(.bss .bss.*)
*(COMMON)
__bss_end = .;
}
__kernel_end = .;
/DISCARD/ : {
*(.comment)
*(.note*)
*(.eh_frame)
}
}
@@ -0,0 +1,55 @@
/* Linker script for StarKernel Kernel ELF (aarch64) */
/* Freestanding ELF64 binary */
OUTPUT_FORMAT("elf64-littleaarch64")
OUTPUT_ARCH(aarch64)
ENTRY(kernel_main)
SECTIONS
{
/* Kernel loaded at 4MB by ELF loader */
. = 0x400000;
__kernel_start = .;
.text : ALIGN(4K) {
__text_start = .;
*(.text.entry)
*(.text .text.*)
__text_end = .;
}
.rodata : ALIGN(4K) {
__rodata_start = .;
*(.rodata .rodata.*)
__rodata_end = .;
}
.data : ALIGN(4K) {
__data_start = .;
*(.data .data.*)
*(.got .got.*)
__data_end = .;
}
.rela.dyn : ALIGN(4K) {
*(.rela .rela.*)
}
.bss : ALIGN(4K) {
__bss_start = .;
*(.bss .bss.*)
*(COMMON)
__bss_end = .;
}
__kernel_end = .;
/DISCARD/ : {
*(.comment)
*(.note*)
*(.eh_frame)
*(.dynamic)
*(.dynsym)
}
}
+54
View File
@@ -0,0 +1,54 @@
/* Linker script for StarKernel Kernel ELF (amd64/x86_64) */
/* Freestanding ELF64 binary */
OUTPUT_FORMAT("elf64-x86-64")
OUTPUT_ARCH(i386:x86-64)
ENTRY(kernel_main)
SECTIONS
{
/* Kernel loaded at 4MB by ELF loader */
. = 0x400000;
__kernel_start = .;
.text : ALIGN(4K) {
__text_start = .;
*(.text.entry)
*(.text .text.*)
__text_end = .;
}
.rodata : ALIGN(4K) {
__rodata_start = .;
*(.rodata .rodata.*)
__rodata_end = .;
}
.data : ALIGN(4K) {
__data_start = .;
*(.data .data.*)
__data_end = .;
}
.rela.dyn : ALIGN(4K) {
*(.rela .rela.*)
}
.bss : ALIGN(4K) {
__bss_start = .;
*(.bss .bss.*)
*(COMMON)
__bss_end = .;
}
__kernel_end = .;
/DISCARD/ : {
*(.comment)
*(.note*)
*(.eh_frame)
*(.dynamic)
*(.dynsym)
}
}
@@ -0,0 +1,54 @@
/* Linker script for StarKernel Kernel ELF (riscv64) */
OUTPUT_FORMAT("elf64-littleriscv")
OUTPUT_ARCH(riscv:rv64)
ENTRY(kernel_main)
SECTIONS
{
. = 0x400000;
__kernel_start = .;
.text : ALIGN(4K) {
__text_start = .;
*(.text.entry)
*(.text .text.*)
__text_end = .;
}
.rodata : ALIGN(4K) {
__rodata_start = .;
*(.rodata .rodata.*)
__rodata_end = .;
}
.data : ALIGN(4K) {
__data_start = .;
*(.data .data.*)
*(.got .got.*)
*(.got.plt)
__data_end = .;
}
.rela.dyn : ALIGN(4K) {
*(.rela .rela.*)
}
.bss : ALIGN(4K) {
__bss_start = .;
*(.bss .bss.*)
*(COMMON)
__bss_end = .;
}
__kernel_end = .;
/DISCARD/ : {
*(.comment)
*(.note*)
*(.eh_frame)
*(.dynamic)
*(.dynsym)
}
}
@@ -0,0 +1,62 @@
/* Linker script for StarKernel UEFI Loader (aarch64) - PE32+ direct */
/* Used with ld -m aarch64pe for direct PE output with base relocations */
OUTPUT_FORMAT("pei-aarch64-little")
OUTPUT_ARCH(aarch64)
ENTRY(efi_main)
SECTIONS
{
/* First section starts at RVA 0x1000 (standard PE alignment) */
. = 0x1000;
__kernel_start = .;
__loader_start = .;
.text : {
__text_start = .;
*(.text.entry)
*(.text .text.*)
__text_end = .;
}
.rodata : ALIGN(0x1000) {
__rodata_start = .;
*(.rodata .rodata.*)
*(.rdata .rdata.*)
__rodata_end = .;
}
.data : ALIGN(0x1000) {
__data_start = .;
*(.data .data.*)
*(.got .got.*)
__data_end = .;
}
.bss : ALIGN(0x1000) {
__bss_start = .;
*(.bss .bss.*)
*(COMMON)
__bss_end = .;
}
/* Base relocation section - PE requires this for UEFI to relocate */
.reloc : ALIGN(0x1000) {
*(.reloc)
}
__loader_end = .;
__kernel_end = .;
/DISCARD/ : {
*(.comment)
*(.note*)
*(.eh_frame)
*(.dynsym)
*(.dynstr)
*(.dynamic)
*(.hash)
*(.gnu.hash)
}
}
@@ -0,0 +1,70 @@
/* Linker script for StarKernel UEFI Loader (aarch64) - ELF64 intermediate */
/* UEFI PE64 format — used as ELF intermediate before objcopy to PE */
OUTPUT_FORMAT("elf64-littleaarch64")
OUTPUT_ARCH(aarch64)
ENTRY(efi_main)
SECTIONS
{
/* Base address for UEFI applications */
. = 0x1000;
__loader_start = .;
.text : {
__text_start = .;
*(.text.entry)
*(.text .text.*)
__text_end = .;
}
.rodata : ALIGN(4K) {
__rodata_start = .;
*(.rodata .rodata.*)
__rodata_end = .;
}
.data : ALIGN(4K) {
__data_start = .;
*(.data .data.*)
*(.got .got.*)
__data_end = .;
}
.rela.dyn : ALIGN(4K) {
*(.rela .rela.*)
}
.dynsym : {
*(.dynsym)
}
.dynamic : {
*(.dynamic)
}
/* PE32+ relocation section - required for UEFI to relocate the image.
* Pre-allocate 128 KB; the tools/pe_reloc_gen.py script patches this
* section after objcopy with proper DIR64 entries from .rela.dyn. */
.reloc : ALIGN(4K) {
KEEP(*(.reloc))
. = ALIGN(4K);
. += 0x20000; /* 128 KB reserved for reloc entries */
}
.bss : ALIGN(4K) {
__bss_start = .;
*(.bss .bss.*)
*(COMMON)
__bss_end = .;
}
__loader_end = .;
/DISCARD/ : {
*(.comment)
*(.note*)
*(.eh_frame)
}
}
@@ -0,0 +1,74 @@
/* Linker script for StarKernel UEFI Loader (amd64/x86_64) - PE32+ direct */
/* Used with ld -m i386pep for direct PE output with base relocations */
OUTPUT_FORMAT("pei-x86-64")
OUTPUT_ARCH(i386:x86-64)
ENTRY(efi_main)
/* PE image base - UEFI will relocate this */
/* Note: For PE, ImageBase sets the preferred load address */
/* Sections are RVA offsets from this base */
SECTIONS
{
/* First section starts at RVA 0x1000 (standard PE alignment) */
. = 0x1000;
__kernel_start = .;
__loader_start = .;
.text : {
__text_start = .;
*(.text.entry)
*(.text .text.*)
__text_end = .;
}
.rodata : ALIGN(0x1000) {
__rodata_start = .;
*(.rodata .rodata.*)
*(.rdata .rdata.*)
__rodata_end = .;
}
.data : ALIGN(0x1000) {
__data_start = .;
*(.data .data.*)
*(.got .got.*)
__data_end = .;
}
.pdata : ALIGN(0x1000) {
*(.pdata)
}
.xdata : {
*(.xdata)
}
.bss : ALIGN(0x1000) {
__bss_start = .;
*(.bss .bss.*)
*(COMMON)
__bss_end = .;
}
/* Base relocation section - PE requires this for UEFI to relocate */
.reloc : ALIGN(0x1000) {
*(.reloc)
}
__loader_end = .;
__kernel_end = .;
/DISCARD/ : {
*(.comment)
*(.note*)
*(.eh_frame)
*(.dynsym)
*(.dynstr)
*(.dynamic)
*(.hash)
*(.gnu.hash)
}
}
+65
View File
@@ -0,0 +1,65 @@
/* Linker script for StarKernel UEFI Loader (amd64/x86_64) */
/* UEFI PE32+ format - DUMB LOADER ONLY */
OUTPUT_FORMAT("elf64-x86-64")
OUTPUT_ARCH(i386:x86-64)
ENTRY(efi_main)
SECTIONS
{
/* Base address for UEFI applications - low address like GRUB */
. = 0x1000;
__loader_start = .;
.text : {
__text_start = .;
*(.text.entry)
*(.text .text.*)
__text_end = .;
}
.rodata : ALIGN(4K) {
__rodata_start = .;
*(.rodata .rodata.*)
__rodata_end = .;
}
.data : ALIGN(4K) {
__data_start = .;
*(.data .data.*)
__data_end = .;
}
.rela.dyn : ALIGN(4K) {
*(.rela .rela.*)
}
.dynsym : {
*(.dynsym)
}
.dynamic : {
*(.dynamic)
}
/* PE32+ relocation section - required for UEFI to relocate the image */
.reloc : ALIGN(4K) {
KEEP(*(.reloc))
}
.bss : ALIGN(4K) {
__bss_start = .;
*(.bss .bss.*)
*(COMMON)
__bss_end = .;
}
__loader_end = .;
/DISCARD/ : {
*(.comment)
*(.note*)
*(.eh_frame)
}
}
@@ -0,0 +1,74 @@
/* Linker script for StarKernel UEFI Loader (riscv64) - ELF64 intermediate */
/* Linked as shared ELF, then converted to PE via objcopy -O pei-riscv64-little */
/*
* Section layout:
* .text/.rodata/.data — code and initialized data
* .bss — uninitialized data (right after .data, VMA-only, no file data)
* .reloc at 0x700000 — PE base relocation table injected post-link
* (large fixed gap avoids overlap with ~6MB BSS)
* .rela.dyn / ELF dyn — ELF dynamic sections, stripped before PE conversion
*/
OUTPUT_FORMAT("elf64-littleriscv")
OUTPUT_ARCH(riscv:rv64)
ENTRY(efi_main)
SECTIONS
{
. = 0x1000;
__loader_start = .;
.text : {
__text_start = .;
*(.text.entry)
*(.text .text.*)
__text_end = .;
}
.rodata : ALIGN(4K) {
__rodata_start = .;
*(.rodata .rodata.*)
__rodata_end = .;
}
.data : ALIGN(4K) {
__data_start = .;
*(.data .data.*)
*(.got .got.*)
*(.got.plt)
__data_end = .;
}
/* BSS immediately after .data — no gap, no section overlap */
.bss : ALIGN(4K) {
__bss_start = .;
*(.bss .bss.*)
*(COMMON)
__bss_end = .;
}
__loader_end = .;
/* PE base relocation table — immediately after BSS (self-adjusting).
* gen_pe_reloc.py replaces this stub with IMAGE_REL_BASED_DIR64 entries.
* ALIGN(4K) avoids the old fixed-address overlap when BSS grows. */
.reloc : ALIGN(4K) {
KEEP(*(.reloc))
}
/* ELF dynamic sections — stripped by objcopy before PE conversion */
.rela.dyn : ALIGN(4K) { *(.rela .rela.*) }
.dynsym : { *(.dynsym) }
.dynamic : { *(.dynamic) }
/DISCARD/ : {
*(.comment)
*(.note*)
*(.eh_frame)
*(.gnu.hash)
*(.hash)
*(.dynstr)
*(.riscv.attributes)
}
}
+74
View File
@@ -0,0 +1,74 @@
/* Linker script for the Raspberry Pi 5 native (non-UEFI) kernel image.
*
* Linked from the same objects as the aarch64 kernel ELF, entered at
* rpi5_native_start (arch/aarch64/native_rpi5_entry.S, section
* .text.entry -- placed first so it sits at the load address), then
* flattened with `objcopy -O binary` into kernel_2712.img.
*
* Load address 0x80000 must match boards/raspi/config.txt's
* kernel_address=0x80000: Pi 5 firmware's own default for
* kernel_2712.img is 0x200000, so the address is pinned on both sides
* rather than left to the firmware default.
*
* __kernel_start/__kernel_end span the whole image including .bss so
* pmm_init() reserves every page the image occupies (aarch64 boot.S's
* zero-length substitutes are only correct for the UEFI loader path,
* where UEFI owns the image pages). __bss_start/__bss_end are 16-byte
* aligned for the entry stub's zeroing loop: firmware does not clear
* memory past the end of the file it loads.
*/
OUTPUT_FORMAT("elf64-littleaarch64")
OUTPUT_ARCH(aarch64)
ENTRY(rpi5_native_start)
SECTIONS
{
. = 0x80000;
__kernel_start = .;
.text : {
__text_start = .;
KEEP(*(.text.entry))
*(.text .text.*)
__text_end = .;
}
.rodata : ALIGN(4K) {
__rodata_start = .;
*(.rodata .rodata.*)
__rodata_end = .;
}
.data : ALIGN(4K) {
__data_start = .;
*(.data .data.*)
*(.got .got.*)
__data_end = .;
}
.rela.dyn : ALIGN(8) {
*(.rela .rela.*)
}
.bss (NOLOAD) : ALIGN(4K) {
__bss_start = .;
*(.bss .bss.*)
*(COMMON)
. = ALIGN(16);
__bss_end = .;
}
. = ALIGN(4K);
__kernel_end = .;
/DISCARD/ : {
*(.comment)
*(.note*)
*(.eh_frame)
*(.dynamic)
*(.dynsym)
*(.interp)
}
}