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,144 @@
+/*
+  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.
+
+ */
+
+#include "../include/repl.h"
+#include "../include/log.h"
+#include "../include/vm.h"
+#include <stdio.h>
+
+/**
+ * @brief Extension point for non-recoverable VM errors (weak symbol).
+ *
+ * Called by the REPL when @c EMERGENCY_CONSOLE_ENABLED = 0 and an error
+ * occurs. The default implementation logs the fault at @c LOG_ERROR level
+ * and sets @c vm->halted = 1, causing the REPL loop to exit cleanly.
+ *
+ * Platforms that need hardware reset, watchdog kick, or JTAG debug-probe
+ * integration should provide a strong definition in a platform-specific file
+ * (e.g., @c starkernel/hal/fault.c) to override this weak default.
+ *
+ * @param vm Active VM whose @c vm->error triggered the fault path
+ */
+__attribute__((weak)) void vm_fault_handler(VM *vm) {
+    log_message(LOG_ERROR, "VM fault — emergency console disabled; halting");
+    vm->halted = 1;
+}
+
+/**
+ * @brief Starts the Forth REPL (Read-Eval-Print Loop)
+ *
+ * @param vm Pointer to the VM structure
+ * @param script_mode If 1, suppress prompts and "ok" output (for piped input)
+ *
+ * @details This function implements an interactive REPL for the Forth interpreter.
+ * It continuously reads input from the user, interprets it, and prints the result
+ * until the VM is halted or an error occurs.
+ *
+ * In interactive mode (script_mode=0):
+ *   - Prints colored prompt "ok> "
+ *   - Acknowledges successful commands with " ok"
+ *   - Reports errors with " ERROR"
+ *
+ * In script mode (script_mode=1):
+ *   - Suppresses all prompts and status messages
+ *   - Suitable for piped input (heredoc, pipes, redirects)
+ */
+void vm_repl(VM *vm, int script_mode) {
+    if (!script_mode) {
+        log_message(LOG_INFO, "Starting Forth REPL");
+    }
+
+    char input[256];
+    while (!vm->halted && !vm->error) {
+        /* Print prompt only in interactive mode */
+        if (!script_mode) {
+            if (vm->zuse_session)
+                printf("\033[36mzuse)ok>\033[0m \033[92m");
+            else
+                printf("\033[36mok>\033[0m \033[92m");
+            fflush(stdout);
+        }
+
+        if (!fgets(input, sizeof(input), stdin)) {
+            if (!script_mode) {
+                printf("\033[0m");
+                fflush(stdout);
+            }
+            break;
+        }
+
+        if (!script_mode) {
+            printf("\033[0m");
+            fflush(stdout);
+        }
+
+        vm_interpret(vm, input);
+
+        /* ABORT stops mid-line (see vm_interpret/execute_colon_word) but the
+         * flag is left set for the caller to consume -- this REPL line is
+         * that boundary. Clear it here so the next line isn't silently
+         * refused by vm_interpret's own abort_requested check. */
+        vm->abort_requested = 0;
+
+        if (!script_mode) {
+            /* Print status only in interactive mode */
+            if (!vm->error) {
+                printf(" ok\n");
+            } else {
+                printf(" ERROR\n");
+#if EMERGENCY_CONSOLE_ENABLED
+                vm->error = 0; /* recover: allow next input */
+#else
+                vm_fault_handler(vm); /* non-recoverable: extension point */
+#endif
+            }
+        } else {
+            if (vm->error) {
+#if EMERGENCY_CONSOLE_ENABLED
+                vm->error = 0;
+#else
+                vm_fault_handler(vm);
+#endif
+            }
+        }
+    }
+}