F# RISC-V Instruction Set formal specification
MIT License
Copyright © Evgeny Ukhanov
This is a formal (and executable) specification for the RISC-V ISA (Instruction Set Architecture), written in F# purely functional style. We deliberately choose an "extremely elementary" implementation of F# to make it readable and usable by wide audience who do not know F# and who do not plan to learn F#.
This is a work-in-progress, one of several similar concurrent efforts within the ISA Formal Specification Technical Group constituted by The RISC-V Foundation (https://riscv.org). We welcome your feedback, comments and suggestions.
rv32ui-p-*, rv64ui-p-*
(Base instruction set)rv32um-p-*, rv64um-p-*
(M extension)rv32ua-p-*, rv64ua-p-*
(A extension)rv32uc-p-*, rv64uc-p-*
(C extension)We expect that many people might use this as a reading reference (whether or not they build and execute it) to clarify their understanding of RISC-V ISA semantics.
Main part for reading Specification:
Decode*.fs
Decodes contain decoders for specific instructions set
and notified with instruction/extension set symbol. For example DecodeI.fs
Execute*.fs
Executes contain executions for specific instructions set
and notified with instruction/extension set symbol. For example ExecuteI.fs
Utilities:
CLI.fs
Contain helper function and types for building effective CLI commands and options.
Bits.fs
Basic type specific functions for
manipulations with bits
.
Run.fs
Basic Run flow - fetch, decode, execute, logging execution flow.
Architecture
Arch.fs
Basic architecture types for RISC-V specification.
MachineState.fs
Basic type and functions described RISC-V machine state.
Main app
Program.fs
Main application to execute RISC-V simulator/emulator.
Test
Test/*.fs
Contain unit-tests for instructions set and extensions
Test/asm/
Contain Assembler test programs for
manual testing RISC-V CPI implementation.
It depend on risc-v toolchain and
it has special auto-build Makefile
.
Application can be executed as a sequential RISC-V simulator (sequential, one-instruction-at-a-time semantics), by building and executing it as a standard F# program.
Supported OS:
Supported .NET SDK:
For Windows preferred way to use Visual Studio.
Other examples will be for Linux. Please follow to instruction https://dotnet.microsoft.com/download
For Ubuntu:
$ wget -q https://packages.microsoft.com/config/ubuntu/16.04/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
$ sudo dpkg -i packages-microsoft-prod.deb
$ sudo apt-get update
$ sudo apt-get install apt-transport-https
$ sudo apt-get update
$ sudo apt-get install dotnet-sdk-3.0
To check installation:
$ dotnet --version
will tell you what version of dotnet
you have.
You can build the application executable with:
$ dotnet build
Most simple way to run immediately run
(without
additional build
command) to see command-line
options on the executable:
$ dotnet run -- --help
If you run the application without option:
$ dotnet run
you'll receive error message:
Wrong parameters put --help to get more information
Example to run specific ISA with extensions, verbosity output and ELF file for execution in RISC-V CPI simulator:
$ dotnet run -- -A rv32i -v myapp.elf
Please read file CONTRIBUTING.md
MIT License