Generate config files from YAML

Author: object-Object

.gitignore

@@ -10,6 +10,7 @@ debug.json
 /src/init.mlog
 /src/main.mlog
 /src/debugger.mlog
+/src/config/*.mlog
 
 node_modules/
 

Makefile

@@ -15,7 +15,7 @@ asm: $(ASM_PROGRAMS)
 rust: $(RUST_PROGRAMS)
 
 .PHONY: mlog
-mlog: $(MLOG_PROGRAMS)
+mlog: $(MLOG_PROGRAMS) mlog-configs
 
 .PHONY: coremark
 coremark:
@@ -49,7 +49,11 @@ build/%.o: asm/%.s | build
 	riscv32-unknown-elf-gcc --compile -march=rv32ima_zicsr -o build/$*.o asm/$*.s
 
 src/%.mlog: src/%.mlog.jinja
-	python -m mlogv32.preprocessor -o src/$*.mlog src/$*.mlog.jinja
+	python -m mlogv32.preprocessor file -o src/$*.mlog src/$*.mlog.jinja
+
+.PHONY: mlog-configs
+mlog-configs: src/config/configs.yaml
+	python -m mlogv32.preprocessor configs src/config/configs.yaml
 
 build:
 	mkdir -p build

nodemon.json

@@ -1,5 +1,5 @@
 {
     "watch": ["src", "python"],
-    "ext": "jinja,py",
-    "exec": "make mlog"
+    "ext": "jinja,py,yaml",
+    "exec": "make mlog || exit 1"
 }

pyproject.toml

@@ -11,6 +11,7 @@ dependencies = [
     "pydantic>=2.11.5",
     "pymsch>=0.0.11",
     "pyperclip>=1.9.0",
+    "pyyaml>=5.2",
     "riscof",
     "riscv-isac",
     "tqdm>=4.67.1",

python/src/mlogv32/preprocessor/app.py

@@ -1,6 +1,7 @@
 from pathlib import Path
-from typing import Annotated
+from typing import Annotated, Any, TypedDict
 
+import yaml
 from jinja2 import Environment, FileSystemLoader, StrictUndefined
 from typer import Option, Typer
 
@@ -13,15 +14,41 @@
 )
 
 
-@app.command()
-def main(
+@app.command(name="file")
+def command_file(
     path: Path,
     output: Annotated[Path | None, Option("-o", "--output")] = None,
 ):
     path = path.resolve()
 
+    env = create_jinja_env(path.parent)
+    template = env.get_template(path.name)
+    result = template.render()
+
+    if output:
+        output.parent.mkdir(parents=True, exist_ok=True)
+        output.write_text(result, "utf-8")
+    else:
+        print(result)
+
+
+@app.command()
+def configs(yaml_path: Path):
+    with yaml_path.open("rb") as f:
+        data: ConfigsYaml = yaml.load(f, yaml.Loader)
+
+    output_dir = yaml_path.parent
+    env = create_jinja_env(output_dir)
+    template = env.get_template(data["template"])
+
+    for name, args in data["configs"].items():
+        result = template.render(**data["defaults"], **args)
+        (output_dir / name).with_suffix(".mlog").write_text(result, "utf-8")
+
+
+def create_jinja_env(template_dir: Path):
     env = Environment(
-        loader=FileSystemLoader(path.parent),
+        loader=FileSystemLoader(template_dir),
         line_statement_prefix="#%",
         line_comment_prefix="#%#",
         autoescape=False,
@@ -37,15 +64,13 @@ def main(
         "quote": filters.quote,
         "csr": filters.csr,
     }
+    return env
 
-    template = env.get_template(path.name)
-    result = template.render()
 
-    if output:
-        output.parent.mkdir(parents=True, exist_ok=True)
-        output.write_text(result, "utf-8")
-    else:
-        print(result)
+class ConfigsYaml(TypedDict):
+    template: str
+    defaults: dict[str, Any]
+    configs: dict[str, dict[str, Any]]
 
 
 if __name__ == "__main__":

src/config/base.mlog.jinja

@@ -0,0 +1,34 @@
+    # per-world config options for mlogv32
+
+    # reloaded after unpausing
+    set TARGET_IPT {{#TARGET_IPT}}
+    set BREAKPOINT_ADDRESS {{#BREAKPOINT_ADDRESS}}
+
+    # loaded at reset only
+    set MEMORY_X_OFFSET {{#MEMORY_X_OFFSET}}  # x offset from this proc to bottom left memory proc
+    set MEMORY_Y_OFFSET {{#MEMORY_Y_OFFSET}}  # y offset from this proc to bottom left memory proc
+    set MEMORY_WIDTH {{#MEMORY_WIDTH}}  # physical width of the memory procs
+
+    set ROM_SIZE    {{#ROM_SIZE}}  # ROM size in bytes (rx)
+    set RAM_SIZE    {{#RAM_SIZE}}  # RAM size in bytes (rwx)
+    set ICACHE_SIZE {{#ICACHE_SIZE}}  # icache size in variables, or bytes of memory it can represent; 4x less dense than ROM/RAM
+
+    # computed values
+    op add MEMORY_X @thisx MEMORY_X_OFFSET
+    op add MEMORY_Y @thisy MEMORY_Y_OFFSET
+
+    stop
+
+#%- if false
+# {% raw %}
+set {{ null
+set TARGET_IPT TARGET_IPT
+set BREAKPOINT_ADDRESS BREAKPOINT_ADDRESS
+set MEMORY_WIDTH MEMORY_WIDTH
+set ROM_SIZE ROM_SIZE
+set RAM_SIZE RAM_SIZE
+set ICACHE_SIZE ICACHE_SIZE
+set MEMORY_X MEMORY_X
+set MEMORY_Y MEMORY_Y
+# {% endraw %}
+#% endif

src/config/configs.yaml

@@ -0,0 +1,14 @@
+template: base.mlog.jinja
+
+defaults:
+  TARGET_IPT: 500000
+  BREAKPOINT_ADDRESS: '0x'
+
+configs:
+  riscv-arch-test:
+    MEMORY_X_OFFSET: -11
+    MEMORY_Y_OFFSET: -26
+    MEMORY_WIDTH: 32
+    ROM_SIZE: '0x480000'
+    RAM_SIZE: '0x480000'
+    ICACHE_SIZE: '0xc0000'