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>
2026-10-01 15:40:09 -04:00
parent 3c709c115b
commit a8b70e88d3
630 changed files with 2646 additions and 2036 deletions
@@ -0,0 +1,133 @@
+/*
+  StarForth — Steady-State Virtual Machine Runtime
+
+  Copyright (c) 2023–2025 Robert A. James
+  All rights reserved.
+
+  This file is part of the StarForth project.
+
+  Licensed under the StarForth License, Version 1.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://github.com/star.4th@proton.me/StarForth/LICENSE.txt
+
+  This software is provided "AS IS", WITHOUT WARRANTY OF ANY KIND,
+  express or implied, including but not limited to the warranties of
+  merchantability, fitness for a particular purpose, and noninfringement.
+
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+/**
+ * capsule_validate.c - Capsule Validation (M7.1)
+ *
+ * Validates capsule descriptors for structural integrity and content hash.
+ * Freestanding - no libc dependency.
+ */
+
+#include "starkernel/capsule.h"
+#include "starkernel/xxhash64.h"
+
+/*===========================================================================
+ * Validation Result Strings
+ *===========================================================================*/
+
+static const char *validate_result_strings[] = {
+    "valid",
+    "bad magic",
+    "bad version",
+    "bad hash algorithm",
+    "bounds error",
+    "mode invalid",
+    "revoked but active",
+    "hash mismatch",
+    "null pointer",
+};
+
+const char *capsule_validate_result_str(CapsuleValidateResult result) {
+    if ((size_t)result < sizeof(validate_result_strings) / sizeof(validate_result_strings[0])) {
+        return validate_result_strings[result];
+    }
+    return "unknown error";
+}
+
+/*===========================================================================
+ * Validation
+ *===========================================================================*/
+
+CapsuleValidateResult capsule_validate(
+    const CapsuleDesc *desc,
+    const uint8_t *arena_base,
+    uint64_t arena_size,
+    int verify_hash)
+{
+    /* Check for null pointers */
+    if (!desc) {
+        return CAPSULE_ERR_NULL_PTR;
+    }
+
+    /* 1. Check magic signature */
+    uint32_t sig = CAPSULE_MAGIC_GET_SIG(desc->magic);
+    if (sig != (uint32_t)CAPSULE_DESC_MAGIC) {
+        return CAPSULE_ERR_BAD_MAGIC;
+    }
+
+    /* 2. Check version */
+    uint8_t version = CAPSULE_MAGIC_GET_VERSION(desc->magic);
+    if (version != CAPSULE_VERSION_0) {
+        return CAPSULE_ERR_BAD_VERSION;
+    }
+
+    /* 3. Check hash algorithm is known */
+    uint8_t hash_alg = CAPSULE_MAGIC_GET_HASHALG(desc->magic);
+    if (hash_alg > CAPSULE_HASH_BLAKE3) {
+        return CAPSULE_ERR_BAD_HASH_ALG;
+    }
+
+    /* 4. Check bounds: offset + length <= arena_size */
+    if (arena_base && arena_size > 0) {
+        if (desc->offset > arena_size ||
+            desc->length > arena_size ||
+            desc->offset + desc->length > arena_size) {
+            return CAPSULE_ERR_BOUNDS;
+        }
+    }
+
+    /* 5. Check mode flags: exactly one of (p) or (e) must be set */
+    if (!CAPSULE_MODE_VALID(desc->flags)) {
+        return CAPSULE_ERR_MODE_INVALID;
+    }
+
+    /* 6. Reject if REVOKED and ACTIVE are both set — data inconsistency */
+    if ((desc->flags & CAPSULE_FLAG_REVOKED) &&
+        (desc->flags & CAPSULE_FLAG_ACTIVE)) {
+        return CAPSULE_ERR_REVOKED_ACTIVE;
+    }
+
+    /* 7. Verify content hash if requested */
+    if (verify_hash && arena_base && desc->length > 0) {
+        /* Currently only xxHash64 is supported */
+        if (hash_alg != CAPSULE_HASH_XXHASH64) {
+            /* Can't verify unsupported hash algorithms */
+            return CAPSULE_ERR_BAD_HASH_ALG;
+        }
+
+        const uint8_t *payload = arena_base + desc->offset;
+        uint64_t computed_hash = xxhash64_capsule(payload, (size_t)desc->length);
+
+        if (computed_hash != desc->content_hash) {
+            return CAPSULE_ERR_HASH_MISMATCH;
+        }
+
+        /* Also verify capsule_id == content_hash (content-addressed invariant) */
+        if (desc->capsule_id != desc->content_hash) {
+            return CAPSULE_ERR_HASH_MISMATCH;
+        }
+    }
+
+    return CAPSULE_VALID;
+}
+
+/* capsule_find_by_id, capsule_get_payload, capsule_find_mama_init are in capsule_find.c */