rajamesandJunie
a8b70e88d3
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>
120 lines
3.7 KiB
C
120 lines
3.7 KiB
C
/*
|
||
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.
|
||
|
||
*/
|
||
|
||
#ifndef LOG_H
|
||
#define LOG_H
|
||
|
||
/* Maximum log line size for persistent logging */
|
||
/* Renamed from LOG_LINE_MAX: vm.h owns that name for the persistent
|
||
* block-log line width (64, unrelated concept). This is the in-memory log
|
||
* message-formatting line length; keeping a distinct name removes the
|
||
* include-order collision that forced a fragile "vm.h before log.h"
|
||
* convention across the kernel (kernel_main.c/shim.c/capsule_birth.c). */
|
||
#ifndef LOG_MSG_LINE_MAX
|
||
#define LOG_MSG_LINE_MAX 256
|
||
#endif
|
||
|
||
/* Forward declaration */
|
||
struct VM;
|
||
|
||
|
||
/**
|
||
* @brief Logging level enumeration
|
||
*
|
||
* Defines the available logging levels in order of increasing verbosity.
|
||
*/
|
||
typedef enum {
|
||
LOG_NONE = -1, /**< Completely disable all logging */
|
||
LOG_ERROR = 0, /**< Error messages only */
|
||
LOG_WARN, /**< Warning and error messages */
|
||
LOG_INFO, /**< Informational, warning and error messages */
|
||
LOG_TEST, /**< Test results_run_01_2025_12_08 and all previous levels */
|
||
LOG_DEBUG /**< Debug messages and all previous levels */
|
||
} LogLevel;
|
||
|
||
/**
|
||
* @brief Test result type enumeration
|
||
*
|
||
* Defines the possible outcomes of test execution.
|
||
*/
|
||
typedef enum {
|
||
TEST_PASS = 0, /**< Test completed successfully */
|
||
TEST_FAIL, /**< Test failed */
|
||
TEST_SKIP, /**< Test was skipped */
|
||
TEST_ERROR /**< Test encountered an error during execution */
|
||
} TestResult;
|
||
|
||
/**
|
||
* @brief Set the global logging level
|
||
* @param level The new logging level to set
|
||
* @note Default level is LOG_INFO
|
||
*/
|
||
void log_set_level(LogLevel level);
|
||
|
||
/**
|
||
* @brief Get the current logging level
|
||
* @return The current logging level
|
||
*/
|
||
LogLevel log_get_level(void);
|
||
|
||
/**
|
||
* @brief Log a formatted message at the specified level
|
||
* @param level The logging level for this message
|
||
* @param fmt Printf-style format string
|
||
* @param ... Variable arguments for format string
|
||
*/
|
||
void log_message(LogLevel level, const char *fmt, ...);
|
||
|
||
/**
|
||
* @brief Log a test result with colored output
|
||
* @param word_name Name of the word being tested
|
||
* @param result Result of the test execution
|
||
*/
|
||
void log_test_result(const char *word_name, TestResult result);
|
||
|
||
/**
|
||
* @brief Set the VM instance for persistent logging
|
||
* @param vm VM instance to use for persistent logging (NULL to disable)
|
||
*/
|
||
void log_set_vm(struct VM *vm);
|
||
|
||
#endif /* LOG_H */ |