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
@@ -0,0 +1,255 @@
|
||||
/*
|
||||
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 VM Feature Configuration
|
||||
*
|
||||
* This header is the single source of truth for VM build-time defaults.
|
||||
* Build systems may override any option via -D<FLAG>=<value>, but every
|
||||
* translation unit sees these defaults even if no -D is provided.
|
||||
*
|
||||
* Hosted + kernel builds both force-include this header (see Makefiles),
|
||||
* so new toggles belong here with a documented owner.
|
||||
*/
|
||||
|
||||
#ifndef STARFORTH_CONFIG_H
|
||||
#define STARFORTH_CONFIG_H
|
||||
|
||||
/* Base defaults (match 2025-12-26 hosted baseline) */
|
||||
#define STARFORTH_CONFIG_STRICT_PTR_DEFAULT 1
|
||||
#define STARFORTH_CONFIG_ENABLE_HOTWORDS_CACHE_DEFAULT 0
|
||||
#define STARFORTH_CONFIG_ENABLE_PIPELINING_DEFAULT 0
|
||||
#define STARFORTH_CONFIG_ROLLING_WINDOW_SIZE_DEFAULT 4096
|
||||
#define STARFORTH_CONFIG_TRANSITION_WINDOW_SIZE_DEFAULT 8
|
||||
#define STARFORTH_CONFIG_ADAPTIVE_SHRINK_RATE_DEFAULT 50
|
||||
#define STARFORTH_CONFIG_ADAPTIVE_MIN_WINDOW_SIZE_DEFAULT 256
|
||||
#define STARFORTH_CONFIG_ADAPTIVE_CHECK_FREQUENCY_DEFAULT 512
|
||||
#define STARFORTH_CONFIG_ADAPTIVE_GROWTH_THRESHOLD_DEFAULT 5
|
||||
#define STARFORTH_CONFIG_INITIAL_DECAY_SLOPE_Q48_DEFAULT 21845
|
||||
#define STARFORTH_CONFIG_DECAY_MIN_INTERVAL_DEFAULT 1000ULL
|
||||
#define STARFORTH_CONFIG_DECAY_RATE_PER_US_Q16_DEFAULT 1
|
||||
#define STARFORTH_CONFIG_HEARTBEAT_THREAD_ENABLED_DEFAULT 1
|
||||
#define STARFORTH_CONFIG_HEARTBEAT_TICK_NS_DEFAULT 10000ULL
|
||||
#define STARFORTH_CONFIG_HEARTBEAT_INFERENCE_FREQUENCY_DEFAULT 1000
|
||||
#define STARFORTH_CONFIG_STADIUM_VM_MEMORY_PERCENT_DEFAULT 50
|
||||
#define STARFORTH_CONFIG_STADIUM_CONTAINS_DEPTH_MAX_DEFAULT 5
|
||||
#define STARFORTH_CONFIG_STADIUM_CAPACITY_TICK_DEFAULT 4000
|
||||
#define STARFORTH_CONFIG_STADIUM_MEMORY_PERCENT_DEFAULT 1
|
||||
#define STARFORTH_CONFIG_STADIUM_WORD_HEAT_QUANTUM_DEFAULT 2048
|
||||
#define STARFORTH_CONFIG_STADIUM_WORD_COOL_RATE_Q48_DEFAULT 21845
|
||||
#define STARFORTH_CONFIG_STADIUM_BLOCK_HEAT_QUANTUM_DEFAULT 2048
|
||||
#define STARFORTH_CONFIG_STADIUM_BLOCK_COOL_RATE_Q48_DEFAULT 21845
|
||||
#define STARFORTH_CONFIG_STADIUM_BLOCK_TRACK_CAP_MULT_DEFAULT 2
|
||||
#define STARFORTH_CONFIG_HEARTBEAT_CHECK_FREQUENCY_DEFAULT 256
|
||||
#define STARFORTH_CONFIG_HEARTBEAT_WINDOW_TUNING_FREQUENCY_DEFAULT 1000
|
||||
#define STARFORTH_CONFIG_HEARTBEAT_SLOPE_VALIDATION_FREQUENCY_DEFAULT 5000
|
||||
#define STARFORTH_CONFIG_SSM_ENTROPY_HIGH_THRESHOLD_DEFAULT 0.75
|
||||
#define STARFORTH_CONFIG_SSM_CV_HIGH_THRESHOLD_DEFAULT 0.15
|
||||
#define STARFORTH_CONFIG_SSM_TEMPORAL_DECAY_THRESHOLD_DEFAULT 0.5
|
||||
#define STARFORTH_CONFIG_SSM_TEMPORAL_DECAY_LOW_THRESHOLD_DEFAULT 0.3
|
||||
#define STARFORTH_CONFIG_SSM_HYSTERESIS_TICKS_DEFAULT 5
|
||||
#define STARFORTH_CONFIG_SPECULATION_THRESHOLD_Q48_DEFAULT (0x8000LL)
|
||||
#define STARFORTH_CONFIG_SPECULATION_DEPTH_DEFAULT 1
|
||||
#define STARFORTH_CONFIG_MIN_SAMPLES_FOR_SPECULATION_DEFAULT 10
|
||||
#define STARFORTH_CONFIG_MISPREDICTION_COST_Q48_DEFAULT (25LL << 16)
|
||||
/* 1.10 in Q48.16 (1.10 * 65536 = 72089.6, rounds to 0x1199A). Was shipped
|
||||
* for years as 0x11999AL (an extra hex digit, ~17.6 in Q48.16, an order of
|
||||
* magnitude off from the documented 1.10 intent) -- found while migrating
|
||||
* this constant to Kconfig (see rev x in
|
||||
* docs/working/architecture/VM-FLEET-ATTRACTOR-DESIGN-20260705.md) and
|
||||
* fixed on Bob's explicit instruction (rev y). */
|
||||
#define STARFORTH_CONFIG_MINIMUM_PREFETCH_ROI_DEFAULT (0x1199AL)
|
||||
|
||||
/* Public macros (overridable via -D) */
|
||||
#ifndef STRICT_PTR
|
||||
#define STRICT_PTR STARFORTH_CONFIG_STRICT_PTR_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef VM_STRICT_PTR
|
||||
#define VM_STRICT_PTR STRICT_PTR
|
||||
#endif
|
||||
|
||||
#ifndef ENABLE_HOTWORDS_CACHE
|
||||
#define ENABLE_HOTWORDS_CACHE STARFORTH_CONFIG_ENABLE_HOTWORDS_CACHE_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef ENABLE_PIPELINING
|
||||
#define ENABLE_PIPELINING STARFORTH_CONFIG_ENABLE_PIPELINING_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef ROLLING_WINDOW_SIZE
|
||||
#define ROLLING_WINDOW_SIZE STARFORTH_CONFIG_ROLLING_WINDOW_SIZE_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef TRANSITION_WINDOW_SIZE
|
||||
#define TRANSITION_WINDOW_SIZE STARFORTH_CONFIG_TRANSITION_WINDOW_SIZE_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef ADAPTIVE_SHRINK_RATE
|
||||
#define ADAPTIVE_SHRINK_RATE STARFORTH_CONFIG_ADAPTIVE_SHRINK_RATE_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef ADAPTIVE_MIN_WINDOW_SIZE
|
||||
#define ADAPTIVE_MIN_WINDOW_SIZE STARFORTH_CONFIG_ADAPTIVE_MIN_WINDOW_SIZE_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef ADAPTIVE_CHECK_FREQUENCY
|
||||
#define ADAPTIVE_CHECK_FREQUENCY STARFORTH_CONFIG_ADAPTIVE_CHECK_FREQUENCY_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef ADAPTIVE_GROWTH_THRESHOLD
|
||||
#define ADAPTIVE_GROWTH_THRESHOLD STARFORTH_CONFIG_ADAPTIVE_GROWTH_THRESHOLD_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef INITIAL_DECAY_SLOPE_Q48
|
||||
#define INITIAL_DECAY_SLOPE_Q48 STARFORTH_CONFIG_INITIAL_DECAY_SLOPE_Q48_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef DECAY_MIN_INTERVAL
|
||||
#define DECAY_MIN_INTERVAL STARFORTH_CONFIG_DECAY_MIN_INTERVAL_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef DECAY_RATE_PER_US_Q16
|
||||
#define DECAY_RATE_PER_US_Q16 STARFORTH_CONFIG_DECAY_RATE_PER_US_Q16_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef HEARTBEAT_THREAD_ENABLED
|
||||
#define HEARTBEAT_THREAD_ENABLED STARFORTH_CONFIG_HEARTBEAT_THREAD_ENABLED_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef HEARTBEAT_TICK_NS
|
||||
#define HEARTBEAT_TICK_NS STARFORTH_CONFIG_HEARTBEAT_TICK_NS_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef HEARTBEAT_INFERENCE_FREQUENCY
|
||||
#define HEARTBEAT_INFERENCE_FREQUENCY STARFORTH_CONFIG_HEARTBEAT_INFERENCE_FREQUENCY_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef STADIUM_VM_MEMORY_PERCENT
|
||||
#define STADIUM_VM_MEMORY_PERCENT STARFORTH_CONFIG_STADIUM_VM_MEMORY_PERCENT_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef STADIUM_CONTAINS_DEPTH_MAX
|
||||
#define STADIUM_CONTAINS_DEPTH_MAX STARFORTH_CONFIG_STADIUM_CONTAINS_DEPTH_MAX_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef STADIUM_CAPACITY_TICK
|
||||
#define STADIUM_CAPACITY_TICK STARFORTH_CONFIG_STADIUM_CAPACITY_TICK_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef STADIUM_MEMORY_PERCENT
|
||||
#define STADIUM_MEMORY_PERCENT STARFORTH_CONFIG_STADIUM_MEMORY_PERCENT_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef STADIUM_WORD_HEAT_QUANTUM
|
||||
#define STADIUM_WORD_HEAT_QUANTUM STARFORTH_CONFIG_STADIUM_WORD_HEAT_QUANTUM_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef STADIUM_WORD_COOL_RATE_Q48
|
||||
#define STADIUM_WORD_COOL_RATE_Q48 STARFORTH_CONFIG_STADIUM_WORD_COOL_RATE_Q48_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef STADIUM_BLOCK_HEAT_QUANTUM
|
||||
#define STADIUM_BLOCK_HEAT_QUANTUM STARFORTH_CONFIG_STADIUM_BLOCK_HEAT_QUANTUM_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef STADIUM_BLOCK_COOL_RATE_Q48
|
||||
#define STADIUM_BLOCK_COOL_RATE_Q48 STARFORTH_CONFIG_STADIUM_BLOCK_COOL_RATE_Q48_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef STADIUM_BLOCK_TRACK_CAP_MULT
|
||||
#define STADIUM_BLOCK_TRACK_CAP_MULT STARFORTH_CONFIG_STADIUM_BLOCK_TRACK_CAP_MULT_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef HEARTBEAT_CHECK_FREQUENCY
|
||||
#define HEARTBEAT_CHECK_FREQUENCY STARFORTH_CONFIG_HEARTBEAT_CHECK_FREQUENCY_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef HEARTBEAT_WINDOW_TUNING_FREQUENCY
|
||||
#define HEARTBEAT_WINDOW_TUNING_FREQUENCY STARFORTH_CONFIG_HEARTBEAT_WINDOW_TUNING_FREQUENCY_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef HEARTBEAT_SLOPE_VALIDATION_FREQUENCY
|
||||
#define HEARTBEAT_SLOPE_VALIDATION_FREQUENCY STARFORTH_CONFIG_HEARTBEAT_SLOPE_VALIDATION_FREQUENCY_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef SSM_ENTROPY_HIGH_THRESHOLD
|
||||
#define SSM_ENTROPY_HIGH_THRESHOLD STARFORTH_CONFIG_SSM_ENTROPY_HIGH_THRESHOLD_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef SSM_CV_HIGH_THRESHOLD
|
||||
#define SSM_CV_HIGH_THRESHOLD STARFORTH_CONFIG_SSM_CV_HIGH_THRESHOLD_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef SSM_TEMPORAL_DECAY_THRESHOLD
|
||||
#define SSM_TEMPORAL_DECAY_THRESHOLD STARFORTH_CONFIG_SSM_TEMPORAL_DECAY_THRESHOLD_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef SSM_TEMPORAL_DECAY_LOW_THRESHOLD
|
||||
#define SSM_TEMPORAL_DECAY_LOW_THRESHOLD STARFORTH_CONFIG_SSM_TEMPORAL_DECAY_LOW_THRESHOLD_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef SSM_HYSTERESIS_TICKS
|
||||
#define SSM_HYSTERESIS_TICKS STARFORTH_CONFIG_SSM_HYSTERESIS_TICKS_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef SPECULATION_THRESHOLD_Q48
|
||||
#define SPECULATION_THRESHOLD_Q48 STARFORTH_CONFIG_SPECULATION_THRESHOLD_Q48_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef SPECULATION_DEPTH
|
||||
#define SPECULATION_DEPTH STARFORTH_CONFIG_SPECULATION_DEPTH_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef MIN_SAMPLES_FOR_SPECULATION
|
||||
#define MIN_SAMPLES_FOR_SPECULATION STARFORTH_CONFIG_MIN_SAMPLES_FOR_SPECULATION_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef MISPREDICTION_COST_Q48
|
||||
#define MISPREDICTION_COST_Q48 STARFORTH_CONFIG_MISPREDICTION_COST_Q48_DEFAULT
|
||||
#endif
|
||||
|
||||
#ifndef MINIMUM_PREFETCH_ROI
|
||||
#define MINIMUM_PREFETCH_ROI STARFORTH_CONFIG_MINIMUM_PREFETCH_ROI_DEFAULT
|
||||
#endif
|
||||
|
||||
#endif /* STARFORTH_CONFIG_H */
|
||||
Reference in New Issue
Block a user