Repository files navigation

FireMarshal is a workload generation tool for RISC-V based systems that automates constructing boot binaries and filesystem images and their evaluation.

• Stable Documentation:https://firemarshal.readthedocs.io/en/latest/index.html
• Paper Publication:https://ieeexplore.ieee.org/document/9408192
• Bugs and Feature Requests:https://github.com/firesim/FireMarshal/issues
• General Questions, Help, Discussion:https://groups.google.com/forum/#!forum/firesim
• Want to contribute?:https://github.com/firesim/FireMarshal/blob/master/CONTRIBUTING.md

The easiest way to use FireMarshal is to run it viaChipyard orFireSim.However, this is not required.To run FireMarshal independently, follow along from the next section (Standalone setup).

FireMarshal uses theConda package manager to help manage system dependencies.This allows users to create an "environment" that holds system dependencies likemake,git, etc.

Next you can run the following commands to create a FireMarshal environment calledfiremarshal with a RISC-V compatible toolchain:

./scripts/setup-conda.sh --conda-env-name firemarshal

To enter this environment, you then run theactivate command.Note that this command should be run whenever you want to use FireMarshal so that packages can be properly be added to yourPATH.

conda activate firemarshal# or whatever name/prefix you gave during environment creation

In addition to standard packages added in the conda environment, you will need the RISC-V ISA simulator (Spike).To install Spike, please refer tohttps://github.com/riscv-software-src/riscv-isa-sim.

Finally, if you are running as a user on a machine withoutsudo access it is required for you to installguestmount for disk manipulation.You can install this through your default package manager (for ex.apt oryum).You can also follow along with theguestmountinstallation instructions found in the FireSim project.

If you only want to build bare-metal workloads, you can skip updating submodules.Otherwise, you should update the required submodules by running:

./init-submodules.sh

Building workloads:

./marshal build br-base.json

To run in qemu:

./marshal launch br-base.json

To install into FireSim (assuming FireMarshal is setup within a Chipyard/FireSim installation):

./marshal install br-base.json

Be advised that FireMarshal will run initialization scripts provided by workloads.These scripts will have all the permissions your user has, be sure to read all workloads carefully before building them.

The master branch of this project contains the latest unstable version of FireMarshal.It should generally work correctly, but it may contain bugs or other inconsistencies from time to time.For stable releases, see the release git tags or GitHub releases page.