main: major overhaul of how __main__ works
Anton Lydike
1 year ago
parent
8ac4a56c08
commit
1c2dad94e2
@ -1,23 +1,23 @@
|
|||||||
; Example program (c) by Anton Lydike
|
// Example program (c) by Anton Lydike
|
||||||
; this calculates the fibonacci sequence and stores it in ram
|
// this calculates the fibonacci sequence and stores it in ram
|
||||||
|
|
||||||
.data
|
.data
|
||||||
fibs: .space 56
|
fibs: .space 56
|
||||||
|
|
||||||
.text
|
.text
|
||||||
main:
|
main:
|
||||||
addi s1, zero, 0 ; storage index
|
addi s1, zero, 0 // storage index
|
||||||
addi s2, zero, 56 ; last storage index
|
addi s2, zero, 56 // last storage index
|
||||||
addi t0, zero, 1 ; t0 = F_{i}
|
addi t0, zero, 1 // t0 = F_{i}
|
||||||
addi t1, zero, 1 ; t1 = F_{i+1}
|
addi t1, zero, 1 // t1 = F_{i+1}
|
||||||
loop:
|
loop:
|
||||||
sw t0, fibs(s1) ; save
|
sw t0, fibs(s1) // save
|
||||||
add t2, t1, t0 ; t2 = F_{i+2}
|
add t2, t1, t0 // t2 = F_{i+2}
|
||||||
addi t0, t1, 0 ; t0 = t1
|
addi t0, t1, 0 // t0 = t1
|
||||||
addi t1, t2, 0 ; t1 = t2
|
addi t1, t2, 0 // t1 = t2
|
||||||
addi s1, s1, 4 ; increment storage pointer
|
addi s1, s1, 4 // increment storage pointer
|
||||||
blt s1, s2, loop ; loop as long as we did not reach array length
|
blt s1, s2, loop // loop as long as we did not reach array length
|
||||||
; exit gracefully
|
// exit gracefully
|
||||||
addi a0, zero, 0
|
addi a0, zero, 0
|
||||||
addi a7, zero, 93
|
addi a7, zero, 93
|
||||||
scall ; exit with code 0
|
scall // exit with code 0
|
||||||
|
|||||||
@ -0,0 +1,44 @@
|
|||||||
|
// example of a simple memory allocation
|
||||||
|
// we use the mmap2 syscall for this
|
||||||
|
|
||||||
|
.text
|
||||||
|
// call mmap2
|
||||||
|
li a0, 0 // addr = 0, let OS choose address
|
||||||
|
li a1, 4096 // size
|
||||||
|
li a2, 3 // PROT_READ | PROT_WRITE
|
||||||
|
li a3, 5 // MAP_PRIVATE | MAP_ANONYMOUS
|
||||||
|
li a7, SCALL_MMAP2
|
||||||
|
ecall // invoke syscall
|
||||||
|
|
||||||
|
li t0, -1 // exit if unsuccessful
|
||||||
|
beq a0, t0, _exit
|
||||||
|
|
||||||
|
// print address
|
||||||
|
print.uhex a0
|
||||||
|
# we can look at the state of the mmu here:
|
||||||
|
ebreak
|
||||||
|
# > mmu.sections
|
||||||
|
# InstructionMemorySection[.text] at 0x00000100
|
||||||
|
# BinaryDataMemorySection[.stack] at 0x00000170
|
||||||
|
# BinaryDataMemorySection[.data.runtime-allocated] at 0x00080170
|
||||||
|
|
||||||
|
sw t0, 144(a0)
|
||||||
|
sw t0, 0(a0)
|
||||||
|
sw t0, 8(a0)
|
||||||
|
sw t0, 16(a0)
|
||||||
|
sw t0, 32(a0)
|
||||||
|
sw t0, 64(a0)
|
||||||
|
sw t0, 128(a0)
|
||||||
|
sw t0, 256(a0)
|
||||||
|
sw t0, 512(a0)
|
||||||
|
sw t0, 1024(a0)
|
||||||
|
sw t0, 2048(a0)
|
||||||
|
sw t0, 4000(a0)
|
||||||
|
|
||||||
|
lw t1, 128(a0)
|
||||||
|
print.uhex t0
|
||||||
|
ebreak
|
||||||
|
|
||||||
|
_exit:
|
||||||
|
li a7, 93
|
||||||
|
ecall
|
||||||
@ -0,0 +1,254 @@
|
|||||||
|
import argparse
|
||||||
|
import glob
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
from typing import List, Type
|
||||||
|
|
||||||
|
from riscemu import AssemblyFileLoader, __version__, __copyright__
|
||||||
|
from riscemu.types import CPU, ProgramLoader, Program
|
||||||
|
from riscemu.instructions import InstructionSet, InstructionSetDict
|
||||||
|
from riscemu.config import RunConfig
|
||||||
|
from riscemu.CPU import UserModeCPU
|
||||||
|
|
||||||
|
|
||||||
|
class RiscemuMain:
|
||||||
|
"""
|
||||||
|
This represents the riscemu API exposed to other programs for better
|
||||||
|
interoperability.
|
||||||
|
"""
|
||||||
|
|
||||||
|
available_ins_sets: dict[str, type[InstructionSet]]
|
||||||
|
available_file_loaders: list[type[ProgramLoader]]
|
||||||
|
|
||||||
|
cfg: RunConfig | None
|
||||||
|
cpu: CPU | None
|
||||||
|
|
||||||
|
input_files: list[str]
|
||||||
|
selected_ins_sets: list[Type[InstructionSet]]
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
self.available_ins_sets = dict()
|
||||||
|
self.selected_ins_sets = []
|
||||||
|
self.available_file_loaders = []
|
||||||
|
self.cfg: RunConfig | None = None
|
||||||
|
self.cpu: CPU | None = None
|
||||||
|
self.input_files = []
|
||||||
|
self.selected_ins_sets = []
|
||||||
|
|
||||||
|
def instantiate_cpu(self):
|
||||||
|
self.cpu = UserModeCPU(self.selected_ins_sets, self.cfg)
|
||||||
|
self.configure_cpu()
|
||||||
|
|
||||||
|
def configure_cpu(self):
|
||||||
|
assert self.cfg is not None
|
||||||
|
if isinstance(self.cpu, UserModeCPU) and self.cfg.stack_size != 0:
|
||||||
|
self.cpu.setup_stack(self.cfg.stack_size)
|
||||||
|
|
||||||
|
def register_all_arguments(self, parser: argparse.ArgumentParser):
|
||||||
|
parser.add_argument(
|
||||||
|
"files",
|
||||||
|
metavar="file.asm",
|
||||||
|
type=str,
|
||||||
|
nargs="+",
|
||||||
|
help="The assembly files to load, the last one will be run",
|
||||||
|
)
|
||||||
|
|
||||||
|
parser.add_argument(
|
||||||
|
"--options",
|
||||||
|
"-o",
|
||||||
|
action=OptionStringAction,
|
||||||
|
keys=(
|
||||||
|
"disable_debug",
|
||||||
|
"no_syscall_symbols",
|
||||||
|
"fail_on_ex",
|
||||||
|
"add_accept_imm",
|
||||||
|
"unlimited_regs",
|
||||||
|
"libc",
|
||||||
|
"ignore_exit_code",
|
||||||
|
),
|
||||||
|
help="""Toggle options. Available options are:
|
||||||
|
disable_debug: Disable ebreak instructions
|
||||||
|
no_syscall_symbols: Don't add symbols for SCALL_EXIT and others
|
||||||
|
fail_on_ex: If set, exceptions won't trigger the debugger
|
||||||
|
add_accept_imm: Accept "add rd, rs, imm" instruction (instead of addi)
|
||||||
|
unlimited_regs: Allow an unlimited number of registers
|
||||||
|
libc: Load a libc-like runtime (for malloc, etc.)
|
||||||
|
ignore_exit_code: Don't exit with the programs exit code.""",
|
||||||
|
)
|
||||||
|
|
||||||
|
parser.add_argument(
|
||||||
|
"--syscall-opts",
|
||||||
|
"-so",
|
||||||
|
action=OptionStringAction,
|
||||||
|
keys=("fs_access", "disable_input"),
|
||||||
|
)
|
||||||
|
|
||||||
|
parser.add_argument(
|
||||||
|
"--instruction-sets",
|
||||||
|
"-is",
|
||||||
|
action=OptionStringAction,
|
||||||
|
help="Instruction sets to load, available are: {}. All are enabled by default".format(
|
||||||
|
", ".join(self.available_ins_sets)
|
||||||
|
),
|
||||||
|
keys={k: True for k in self.available_ins_sets},
|
||||||
|
omit_empty=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
parser.add_argument(
|
||||||
|
"--stack_size",
|
||||||
|
type=int,
|
||||||
|
help="Stack size of loaded programs, defaults to 8MB",
|
||||||
|
nargs="?",
|
||||||
|
)
|
||||||
|
|
||||||
|
parser.add_argument(
|
||||||
|
"-v",
|
||||||
|
"--verbose",
|
||||||
|
help="Verbosity level (can be used multiple times)",
|
||||||
|
action="count",
|
||||||
|
default=0,
|
||||||
|
)
|
||||||
|
|
||||||
|
parser.add_argument(
|
||||||
|
"--interactive",
|
||||||
|
help="Launch the interactive debugger instantly instead of loading any "
|
||||||
|
"programs",
|
||||||
|
action="store_true",
|
||||||
|
)
|
||||||
|
|
||||||
|
parser.add_argument(
|
||||||
|
"--ignore-exit-code",
|
||||||
|
help="Ignore exit code of the program and always return 0 if the program ran to completion.",
|
||||||
|
action="store_true",
|
||||||
|
default=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
def register_all_isas(self):
|
||||||
|
self.available_ins_sets.update(InstructionSetDict)
|
||||||
|
|
||||||
|
def register_all_program_loaders(self):
|
||||||
|
self.available_file_loaders.append(AssemblyFileLoader)
|
||||||
|
|
||||||
|
def parse_argv(self, argv: list[str]):
|
||||||
|
parser = argparse.ArgumentParser(
|
||||||
|
description="RISC-V Userspace emulator",
|
||||||
|
prog="riscemu",
|
||||||
|
formatter_class=argparse.RawTextHelpFormatter,
|
||||||
|
)
|
||||||
|
if "--version" in argv:
|
||||||
|
print(
|
||||||
|
"riscemu version {}\n{}\n\nAvailable ISA: {}".format(
|
||||||
|
__version__, __copyright__, ", ".join(self.available_ins_sets)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
sys.exit()
|
||||||
|
|
||||||
|
self.register_all_arguments(parser)
|
||||||
|
|
||||||
|
# parse argv
|
||||||
|
args = parser.parse_args(argv)
|
||||||
|
|
||||||
|
# add ins
|
||||||
|
if not hasattr(args, "ins"):
|
||||||
|
setattr(args, "ins", {k: True for k in self.available_ins_sets})
|
||||||
|
|
||||||
|
# create RunConfig
|
||||||
|
self.cfg = self.config_from_parsed_args(args)
|
||||||
|
|
||||||
|
# set input files
|
||||||
|
self.input_files = args.files
|
||||||
|
|
||||||
|
# get selected ins sets
|
||||||
|
self.selected_ins_sets = list(
|
||||||
|
self.available_ins_sets[name]
|
||||||
|
for name, selected in args.ins.items()
|
||||||
|
if selected
|
||||||
|
)
|
||||||
|
|
||||||
|
# if use_libc is given, attach libc to path
|
||||||
|
if self.cfg.use_libc:
|
||||||
|
libc_path = os.path.join(
|
||||||
|
os.path.dirname(__file__),
|
||||||
|
"..",
|
||||||
|
"libc",
|
||||||
|
"*.s",
|
||||||
|
)
|
||||||
|
for path in glob.iglob(libc_path):
|
||||||
|
self.input_files.append(path)
|
||||||
|
|
||||||
|
def config_from_parsed_args(self, args: argparse.Namespace) -> RunConfig:
|
||||||
|
# create a RunConfig from the cli args
|
||||||
|
cfg_dict = dict(
|
||||||
|
stack_size=args.stack_size,
|
||||||
|
debug_instruction=not args.options["disable_debug"],
|
||||||
|
include_scall_symbols=not args.options["no_syscall_symbols"],
|
||||||
|
debug_on_exception=not args.options["fail_on_ex"],
|
||||||
|
add_accept_imm=args.options["add_accept_imm"],
|
||||||
|
unlimited_registers=args.options["unlimited_regs"],
|
||||||
|
scall_fs=args.syscall_opts["fs_access"],
|
||||||
|
scall_input=not args.syscall_opts["disable_input"],
|
||||||
|
verbosity=args.verbose,
|
||||||
|
use_libc=args.options["libc"],
|
||||||
|
ignore_exit_code=args.options["ignore_exit_code"],
|
||||||
|
)
|
||||||
|
for k, v in dict(cfg_dict).items():
|
||||||
|
if v is None:
|
||||||
|
del cfg_dict[k]
|
||||||
|
|
||||||
|
return RunConfig(**cfg_dict)
|
||||||
|
|
||||||
|
def load_programs(self):
|
||||||
|
for path in self.input_files:
|
||||||
|
for loader in self.available_file_loaders:
|
||||||
|
if not loader.can_parse(path):
|
||||||
|
continue
|
||||||
|
programs = loader.instantiate(path, {}).parse()
|
||||||
|
if isinstance(programs, Program):
|
||||||
|
programs = [programs]
|
||||||
|
for p in programs:
|
||||||
|
self.cpu.mmu.load_program(p)
|
||||||
|
|
||||||
|
def run(self, argv: list[str]):
|
||||||
|
# register everything
|
||||||
|
self.register_all_isas()
|
||||||
|
self.register_all_program_loaders()
|
||||||
|
|
||||||
|
# parse argv and set up cpu
|
||||||
|
self.parse_argv(argv)
|
||||||
|
self.instantiate_cpu()
|
||||||
|
self.load_programs()
|
||||||
|
|
||||||
|
# run the program
|
||||||
|
self.cpu.launch(self.cfg.verbosity > 1)
|
||||||
|
|
||||||
|
|
||||||
|
class OptionStringAction(argparse.Action):
|
||||||
|
def __init__(self, option_strings, dest, keys=None, omit_empty=False, **kwargs):
|
||||||
|
if keys is None:
|
||||||
|
raise ValueError('must define "keys" argument')
|
||||||
|
if isinstance(keys, dict):
|
||||||
|
keys_d = keys
|
||||||
|
elif isinstance(keys, (list, tuple)):
|
||||||
|
keys_d = {}
|
||||||
|
for k in keys:
|
||||||
|
if isinstance(k, tuple):
|
||||||
|
k, v = k
|
||||||
|
else:
|
||||||
|
v = False
|
||||||
|
keys_d[k] = v
|
||||||
|
else:
|
||||||
|
keys_d = dict()
|
||||||
|
super().__init__(option_strings, dest, default=keys_d, **kwargs)
|
||||||
|
self.keys = keys_d
|
||||||
|
self.omit_empty = omit_empty
|
||||||
|
|
||||||
|
def __call__(self, parser, namespace, values, option_string=None):
|
||||||
|
d = {}
|
||||||
|
if not self.omit_empty:
|
||||||
|
d.update(self.keys)
|
||||||
|
for x in values.split(","):
|
||||||
|
if x in self.keys:
|
||||||
|
d[x] = True
|
||||||
|
else:
|
||||||
|
raise ValueError("Invalid parameter supplied: " + x)
|
||||||
|
setattr(namespace, self.dest, d)
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
python3 -m riscemu "$@"
|
||||||
Loading…
Reference in New Issue