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,169 @@
|
||||
/*
|
||||
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.
|
||||
|
||||
*/
|
||||
|
||||
/**
|
||||
* parity.h - Parity packet for VM validation
|
||||
*
|
||||
* Defines structures and functions for comparing hosted vs kernel VM state.
|
||||
* Parity is verified via canonical dictionary hash, not raw memory comparison.
|
||||
*
|
||||
* M7 Normative Rules:
|
||||
* - word_id is monotonic creation index starting at 0
|
||||
* - Dictionary traversal is creation order (oldest to newest)
|
||||
* - Hash excludes pointers, padding, runtime fields
|
||||
* - Colon bodies are hashed as word_id sequences, not addresses
|
||||
*/
|
||||
|
||||
#ifndef STARKERNEL_PARITY_H
|
||||
#define STARKERNEL_PARITY_H
|
||||
|
||||
#include <stdint.h>
|
||||
#include <stddef.h>
|
||||
|
||||
/**
|
||||
* Bootstrap result codes
|
||||
*/
|
||||
#define SK_BOOTSTRAP_OK 0
|
||||
#define SK_BOOTSTRAP_ARENA_FAIL 1
|
||||
#define SK_BOOTSTRAP_INIT_FAIL 2
|
||||
#define SK_BOOTSTRAP_DICT_FAIL 3
|
||||
|
||||
/**
|
||||
* ParityPacket - Summary of VM state for comparison
|
||||
*
|
||||
* M7.1a fields are sufficient for bootstrap validation.
|
||||
* M7.1b fields are added for POST validation.
|
||||
*/
|
||||
typedef struct {
|
||||
/* === M7.1a: Bootstrap Parity === */
|
||||
uint32_t word_count; /* Number of dictionary entries */
|
||||
uint32_t here_offset; /* vm->here (bytes used in dictionary) */
|
||||
uint32_t latest_word_id; /* vm->latest->word_id (stable ID) */
|
||||
uint64_t header_hash64; /* Canonical dictionary hash (FNV-1a) */
|
||||
|
||||
/* === M7.1b: POST Parity === */
|
||||
uint32_t tests_total; /* Total tests executed */
|
||||
uint32_t tests_passed; /* Tests passed */
|
||||
uint32_t tests_failed; /* Tests failed */
|
||||
uint32_t tests_skipped; /* Tests skipped */
|
||||
uint32_t tests_errors; /* Tests with errors */
|
||||
|
||||
/* === Optional: Rolling Window Hash === */
|
||||
uint64_t window_hash64; /* Hash of execution history (if deterministic) */
|
||||
|
||||
/* === Status === */
|
||||
int bootstrap_result; /* SK_BOOTSTRAP_* code */
|
||||
} ParityPacket;
|
||||
|
||||
/**
|
||||
* Forward declaration of VM struct
|
||||
*/
|
||||
struct VM;
|
||||
|
||||
/*
|
||||
* sk_parity_collect - Collect parity data from VM
|
||||
*
|
||||
* Traverses dictionary in creation order, computes canonical hash.
|
||||
* Does NOT include runtime fields (execution_heat, physics, etc.).
|
||||
*
|
||||
* @param vm Pointer to VM instance
|
||||
* @param out Pointer to ParityPacket to fill
|
||||
*/
|
||||
void sk_parity_collect(struct VM *vm, ParityPacket *out);
|
||||
|
||||
/*
|
||||
* sk_parity_print - Print parity packet to console
|
||||
*
|
||||
* Output format:
|
||||
* PARITY:M7.1a word_count=N here=0xHHHH latest_id=N hash=0xHHHHHHHHHHHHHHHH
|
||||
* PARITY:M7.1b tests=N pass=N fail=N skip=N err=N
|
||||
*
|
||||
* @param pkt Pointer to ParityPacket to print
|
||||
*/
|
||||
void sk_parity_print(const ParityPacket *pkt);
|
||||
|
||||
/*
|
||||
* sk_dict_canonical_hash - Compute canonical dictionary hash
|
||||
*
|
||||
* Hashes structural fields only:
|
||||
* - flags, name_len, name[], acl_default, word_id
|
||||
* - For colon words: body as word_id sequence
|
||||
*
|
||||
* Excludes:
|
||||
* - link (pointer)
|
||||
* - func (function pointer)
|
||||
* - execution_heat (runtime)
|
||||
* - physics (runtime)
|
||||
* - transition_metrics (pointer)
|
||||
*
|
||||
* @param vm Pointer to VM instance
|
||||
* @return 64-bit FNV-1a hash
|
||||
*/
|
||||
uint64_t sk_dict_canonical_hash(struct VM *vm);
|
||||
|
||||
/*
|
||||
* sk_dict_word_count - Count dictionary entries
|
||||
*
|
||||
* Traverses from vm->latest to NULL.
|
||||
*
|
||||
* @param vm Pointer to VM instance
|
||||
* @return Number of dictionary entries
|
||||
*/
|
||||
uint32_t sk_dict_word_count(struct VM *vm);
|
||||
|
||||
/**
|
||||
* FNV-1a constants
|
||||
*/
|
||||
#define FNV1A_64_OFFSET_BASIS 0xCBF29CE484222325ULL
|
||||
#define FNV1A_64_PRIME 0x100000001B3ULL
|
||||
|
||||
/*
|
||||
* fnv1a_64 - FNV-1a 64-bit hash function
|
||||
*
|
||||
* @param data Pointer to data to hash
|
||||
* @param len Length of data
|
||||
* @param hash Current hash value (use FNV1A_64_OFFSET_BASIS for initial)
|
||||
* @return Updated hash value
|
||||
*/
|
||||
uint64_t fnv1a_64(const uint8_t *data, size_t len, uint64_t hash);
|
||||
|
||||
#endif /* STARKERNEL_PARITY_H */
|
||||
Reference in New Issue
Block a user