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,111 @@
+/*
+  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.
+
+ 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.
+
+ */
+
+/*
+                                  ***   StarForth   ***
+
+  physics_metadata.h - Physics metadata helpers for dictionary entries
+
+  Phase 1 implements lightweight thermodynamic signals that inform scheduling
+  and storage placement while keeping the runtime overhead minimal.
+*/
+
+#ifndef STARFORTH_PHYSICS_METADATA_H
+#define STARFORTH_PHYSICS_METADATA_H
+
+#include <stdint.h>
+#include "vm.h"
+
+/* L8 FINAL INTEGRATION: L1 heat tracking always-on */
+
+/* ============================================================================
+ * INTENT: Atomic heat increment for FL1 feedback loop
+ * FL1: Heat accumulation - called on every word execution by inner interpreter
+ * WHY: Atomic operations prevent race conditions when multiple execution paths
+ *      (e.g., heartbeat thread + main interpreter) touch execution_heat
+ *      RELAXED memory order is sufficient (no ordering dependencies)
+ * ============================================================================ */
+static inline void physics_execution_heat_increment(DictEntry *entry)
+{
+    if (!entry) return;
+#if defined(__GNUC__)
+    __atomic_fetch_add(&entry->execution_heat, 1, __ATOMIC_RELAXED);
+#else
+    entry->execution_heat++;
+#endif
+}
+
+static inline cell_t physics_execution_heat_load(const DictEntry *entry)
+{
+    if (!entry) return 0;
+#if defined(__GNUC__)
+    return __atomic_load_n(&entry->execution_heat, __ATOMIC_RELAXED);
+#else
+    return entry->execution_heat;
+#endif
+}
+
+static inline uint64_t physics_decay_slope_load(const VM *vm)
+{
+#if defined(__GNUC__)
+    return __atomic_load_n(&vm->decay_slope_q48, __ATOMIC_RELAXED);
+#else
+    return vm->decay_slope_q48;
+#endif
+}
+
+void physics_metadata_init(DictEntry *entry, uint32_t header_bytes);
+
+void physics_metadata_set_mass(DictEntry *entry, uint32_t total_bytes);
+
+void physics_metadata_touch(DictEntry *entry, cell_t execution_heat, uint64_t now_ns);
+
+void physics_metadata_refresh_state(DictEntry * entry);
+
+void physics_metadata_record_latency(DictEntry *entry, uint64_t sample_ns);
+
+void physics_metadata_apply_seed(DictEntry * entry);
+
+/* L8 FINAL INTEGRATION: L3 linear decay always-on */
+void physics_metadata_apply_linear_decay(DictEntry *entry, uint64_t elapsed_ticks, VM *vm);
+
+#endif /* STARFORTH_PHYSICS_METADATA_H */