Update naming in docs | update AGFIs

This commit is contained in:
Jerry Zhao 2020-02-25 10:17:05 +00:00
parent 70fc43259b
commit 68d8a54ae2
7 changed files with 34 additions and 44 deletions

View File

@ -11,7 +11,7 @@ This changelog follows the format defined here: https://keepachangelog.com/en/1.
* Unification of Configs/Tops between Chipyard and FireSim. Arbitrary Chipyard designs can be imported into FireSim
* Users can define a FireSim version of a Chipyard config by specifying WithFireSimDefaultBridges, WithFireSimDefaultMemModel, and WithFireSimConfigTweaks
* FireSimHarness moved to FireChip. Harness now uses Chipyard's BuildTop key to control which Top to build
* AGFI naming scheme changed. FireSim -> chipyard-rocket, FireBoom -> chipyard-boom
* AGFI naming scheme changed. firesim -> firesim-rocket, fireboom -> firesim-boom
* BridgeBinders field now replaced with generalized chipyard.IOBinders field.
### Deprecated

View File

@ -36,7 +36,7 @@ deploytriplet=None
# Single-core, BOOM-based targets
[firesim-boom-singlecore-no-nic-l2-llc4mb-ddr3]
[firesim-boom-singlecore-nic-l2-llc4mb-ddr3]
DESIGN=FireSim
TARGET_CONFIG=WithNIC_DDR3FRFCFSLLC4MB_FireSimLargeBoomConfig
PLATFORM_CONFIG=F75MHz_BaseF1Config
@ -52,8 +52,8 @@ deploytriplet=None
# Supernode configurations -- multiple instances of an SoC in a single simulator
[firesim-rocket-supernode-singlecore-nic-l2-lbp]
DESIGN=FireSimSupernode
[firesim-supernode-rocket-singlecore-nic-l2-lbp]
DESIGN=FireSim
TARGET_CONFIG=WithNIC_SupernodeFireSimRocketConfig
PLATFORM_CONFIG=F85MHz_BaseF1Config
instancetype=z1d.2xlarge

View File

@ -8,48 +8,38 @@
# Only AGFIs for the latest release of FireSim are guaranteed to be available.
# If you are using an older version of FireSim, you will need to generate your
# own images.
[firesim-quadcore-nic-llc4mb-ddr3]
agfi=agfi-05830297afff02ee6
[firesim-boom-singlecore-nic-l2-llc4mb-ddr3]
agfi=agfi-0bedd9d961b95d378
deploytripletoverride=None
customruntimeconfig=None
[firesim-quadcore-no-nic-llc4mb-ddr3]
agfi=agfi-05830297afff02ee6
[firesim-boom-singlecore-no-nic-l2-llc4mb-ddr3]
agfi=agfi-0082a83896f248f4a
deploytripletoverride=None
customruntimeconfig=None
[fireboom-singlecore-no-nic-llc4mb-ddr3]
agfi=agfi-05830297afff02ee6
[firesim-boom-singlecore-no-nic-l2-llc4mb-ddr3-ramopts]
agfi=agfi-0cdf4190534280297
deploytripletoverride=None
customruntimeconfig=None
[fireboom-singlecore-nic-llc4mb-ddr3]
agfi=agfi-05830297afff02ee6
[firesim-rocket-quadcore-nic-l2-llc4mb-ddr3]
agfi=agfi-0e2ce70fa9b061c84
deploytripletoverride=None
customruntimeconfig=None
[firesim-supernode-singlecore-nic-lbp]
agfi=agfi-05830297afff02ee6
[firesim-rocket-quadcore-no-nic-l2-llc4mb-ddr3]
agfi=agfi-0f18bdbffc415001d
deploytripletoverride=None
customruntimeconfig=None
[fireboom-singlecore-no-nic-l2-llc4mb-ddr3-ramopts]
agfi=agfi-05830297afff02ee6
[firesim-rocket-singlecore-gemmini-no-nic-l2-llc4mb-ddr3]
agfi=agfi-0a1de8a7a12eec950
deploytripletoverride=None
customruntimeconfig=None
[firesim-singlecore-gemmini-no-nic-llc4mb-ddr3]
agfi=agfi-05830297afff02ee6
deploytripletoverride=None
customruntimeconfig=None
[firesim-singlecore-sha3-no-nic-llc4mb-ddr3]
agfi=agfi-05830297afff02ee6
deploytripletoverride=None
customruntimeconfig=None
[firesim-singlecore-sha3-no-nic-print-llc4mb-ddr3]
agfi=agfi-05830297afff02ee6
[firesim-supernode-rocket-singlecore-nic-l2-lbp]
agfi=agfi-00a4f39aaa0a22e68
deploytripletoverride=None
customruntimeconfig=None

View File

@ -331,7 +331,7 @@ configuration in ``config_hwdb.ini``. For example, to share the hardware config:
::
[firesim-quadcore-nic-llc4mb-ddr3]
[firesim-rocket-quadcore-nic-l2-llc4mb-ddr3]
# this is a comment that describes my favorite configuration!
agfi=agfi-0a6449b5894e96e53
deploytripletoverride=None
@ -342,7 +342,7 @@ you would use:
::
[agfistoshare]
firesim-quadcore-nic-llc4mb-ddr3
firesim-rocket-quadcore-nic-l2-llc4mb-ddr3
``[sharewithaccounts]``
@ -377,7 +377,7 @@ you made up). Such a section must contain the following fields:
"""""""""""""""""""""""""""""
This specifies the basic target design that will be built. Unless you
are defining a custom system, this should either be ``FireSim``. These
are defining a custom system, this should either ``FireSim``. These
are defined in ``firesim/sim/src/main/scala/firesim/Targets.scala``. We
describe this in greater detail in :ref:`Generating Different
Targets<generating-different-targets>`).
@ -457,7 +457,7 @@ these as necessary:
::
[firesim-quadcore-nic-llc4mb-ddr3]
[firesim-rocket-quadcore-nic-l2-llc4mb-ddr3]
# this is a comment that describes my favorite configuration!
agfi=agfi-0a6449b5894e96e53
deploytripletoverride=None
@ -466,7 +466,7 @@ these as necessary:
``[NAME_GOES_HERE]``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In this example, ``firesim-quadcore-nic-llc4mb-ddr3`` is the name that will be
In this example, ``firesim-rocket-quadcore-nic-l2-llc4mb-ddr3`` is the name that will be
used to reference this hardware design in other configuration locations. The following
items describe this hardware configuration:

View File

@ -45,7 +45,7 @@ different build instance type keep in mind that Vivado will consume in excess
of 32 GiB for large designs.
To start out, let's build a simple design, ``firesim-quadcore-no-nic-llc4mb-ddr3``.
To start out, let's build a simple design, ``firesim-rocket-quadcore-no-nic-l2-llc4mb-ddr3``.
This is a design that has four cores, no nic, and uses the 4MB LLC + DDR3 memory model.
To do so, comment out all of the other build entries in ``deploy/config_build.ini``, besides the one we want.. So, you should
end up with something like this (a line beginning with a ``#`` is a comment):
@ -55,7 +55,7 @@ end up with something like this (a line beginning with a ``#`` is a comment):
[builds]
# this section references builds defined in config_build_recipes.ini
# if you add a build here, it will be built when you run buildafi
firesim-quadcore-no-nic-llc4mb-ddr3
firesim-rocket-quadcore-no-nic-l2-llc4mb-ddr3
Running a Build

View File

@ -73,7 +73,7 @@ we want. Let's outline the important parameters:
* ``linklatency=6405``: This models a network with 6405 cycles of link latency. Since we are modeling processors running at 3.2 Ghz, 1 cycle = 1/3.2 ns, so 6405 cycles is roughly 2 microseconds.
* ``switchinglatency=10``: This models switches with a minimum port-to-port latency of 10 cycles.
* ``netbandwidth=200``: This sets the bandwidth of the NICs to 200 Gbit/s. Currently you can set any integer value less than this without making hardware modifications.
* ``defaulthwconfig=firesim-quadcore-nic-llc4mb-ddr3``: This tells the manager to use a quad-core Rocket Chip configuration with 512 KB of L2, 4 MB of L3 (LLC) and 16 GB of DDR3, with a NIC, for each of the simulated nodes in the topology.
* ``defaulthwconfig=firesim-rocket-quadcore-nic-l2-llc4mb-ddr3``: This tells the manager to use a quad-core Rocket Chip configuration with 512 KB of L2, 4 MB of L3 (LLC) and 16 GB of DDR3, with a NIC, for each of the simulated nodes in the topology.
You'll see other parameters here, like ``runinstancemarket``,
``spotinterruptionbehavior``, and ``spotmaxprice``. If you're an experienced
@ -95,7 +95,7 @@ As a final sanity check, your ``config_runtime.ini`` file should now look like t
.. attention::
**[Advanced users] Simulating BOOM instead of Rocket Chip**: If you would like to simulate a single-core `BOOM <https://github.com/ucb-bar/riscv-boom>`__ as a target, set ``defaulthwconfig`` to ``fireboom-singlecore-nic-llc4mb-ddr3``.
**[Advanced users] Simulating BOOM instead of Rocket Chip**: If you would like to simulate a single-core `BOOM <https://github.com/ucb-bar/riscv-boom>`__ as a target, set ``defaulthwconfig`` to ``firesim-boom-singlecore-nic-l2-llc4mb-ddr3``.
Launching a Simulation!
@ -168,7 +168,7 @@ For a complete run, you should expect output like the following:
FireSim Manager. Docs: http://docs.fires.im
Running: infrasetup
Building FPGA software driver for FireSim-FireSimQuadRocketConfig-BaseF1Config_F90MHz
Building FPGA software driver for FireSim-FireSimQuadRocketConfig-F90MHz_BaseF1Config
Building switch model binary for switch switch0
[172.30.2.178] Executing task 'instance_liveness'
[172.30.2.178] Checking if host instance is up...

View File

@ -94,15 +94,15 @@ to change a few items in this section:
# This references a section from config_hwconfigs.ini
# In homogeneous configurations, use this to set the hardware config deployed
# for all simulators
defaulthwconfig=firesim-quadcore-no-nic-llc4mb-ddr3
defaulthwconfig=firesim-rocket-quadcore-no-nic-l2-llc4mb-ddr3
Note that we changed three of the parameters here: ``topology`` is now set to
``no_net_config``, indicating that we do not want a network. Then,
``no_net_num_nodes`` is set to ``1``, indicating that we only want to simulate
one node. Lastly, we changed ``defaulthwconfig`` from
``firesim-quadcore-nic-llc4mb-ddr3`` to
``firesim-quadcore-no-nic-llc4mb-ddr3``. Notice the subtle difference in this
``firesim-rocket-quadcore-nic-l2-llc4mb-ddr3`` to
``firesim-rocket-quadcore-no-nic-l2-llc4mb-ddr3``. Notice the subtle difference in this
last option? All we did is switch to a hardware configuration that does not
have a NIC. This hardware configuration models a Quad-core Rocket Chip with 4
MB of L2 cache and 16 GB of DDR3, and **no** network interface card.
@ -141,7 +141,7 @@ As a final sanity check, your ``config_runtime.ini`` file should now look like t
# This references a section from config_hwconfigs.ini
# In homogeneous configurations, use this to set the hardware config deployed
# for all simulators
defaulthwconfig=firesim-quadcore-no-nic-llc4mb-ddr3
defaulthwconfig=firesim-rocket-quadcore-no-nic-l2-llc4mb-ddr3
[workload]
workloadname=linux-uniform.json
@ -150,7 +150,7 @@ As a final sanity check, your ``config_runtime.ini`` file should now look like t
.. attention::
**[Advanced users] Simulating BOOM instead of Rocket Chip**: If you would like to simulate a single-core `BOOM <https://github.com/ucb-bar/riscv-boom>`__ as a target, set ``defaulthwconfig`` to ``fireboom-singlecore-no-nic-llc4mb-ddr3``.
**[Advanced users] Simulating BOOM instead of Rocket Chip**: If you would like to simulate a single-core `BOOM <https://github.com/ucb-bar/riscv-boom>`__ as a target, set ``defaulthwconfig`` to ``firesim-boom-singlecore-no-nic-l2-llc4mb-ddr3``.
Launching a Simulation!
@ -224,7 +224,7 @@ For a complete run, you should expect output like the following:
FireSim Manager. Docs: http://docs.fires.im
Running: infrasetup
Building FPGA software driver for FireSim-FireSimQuadRocketConfig-BaseF1Config_F90MHz
Building FPGA software driver for FireSim-FireSimQuadRocketConfig-F90MHz_BaseF1Config
[172.30.2.174] Executing task 'instance_liveness'
[172.30.2.174] Checking if host instance is up...
[172.30.2.174] Executing task 'infrasetup_node_wrapper'