replica
/
firesim
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[docs] Update docs to reflect new hwdb convention

This commit is contained in:
David Biancolin 2019-10-06 23:32:48 +00:00
parent 180fbb7d6e
commit 44b56ad23e
5 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/Advanced-Usage/Debugging/TracerV.rst
View File

@ -37,7 +37,7 @@ In config_build_recipes.ini:
.. code-block:: ini
[firesim-quadcore-traced-nic-ddr3-llc4mb]
[firesim-quadcore-traced-nic-l2-llc4mb-ddr3]
DESIGN=FireSim
TARGET_CONFIG=FireSimRocketChipQuadCoreTracedConfig
PLATFORM_CONFIG=FireSimDDR3FRFCFSLLC4MBConfig
@ -49,14 +49,14 @@ In config_build.ini:
.. code-block:: ini
[builds]
firesim-quadcore-traced-nic-ddr3-llc4mb
firesim-quadcore-traced-nic-l2-llc4mb-ddr3
Then run "firesim buildafi" to build an FPGA image. Add the resulting AGFI as
a new entry in config_hwdb.ini.
.. code-block:: ini
[firesim-quadcore-traced-nic-ddr3-llc4mb]
[firesim-quadcore-traced-nic-l2-llc4mb-ddr3]
agfi=agfi-XXXXX
deploytripletoverride=None
customruntimeconfig=None

8
docs/Advanced-Usage/Manager/Manager-Configuration-Files.rst
View File

@ -265,7 +265,7 @@ configuration in ``config_hwdb.ini``. For example, to share the hardware config:
::
[firesim-quadcore-nic-ddr3-llc4mb]
[firesim-quadcore-nic-l2-llc4mb-ddr3]
# this is a comment that describes my favorite configuration!
agfi=agfi-0a6449b5894e96e53
deploytripletoverride=None
@ -276,7 +276,7 @@ you would use:
::
[agfistoshare]
firesim-quadcore-nic-ddr3-llc4mb
firesim-quadcore-nic-l2-llc4mb-ddr3
``[sharewithaccounts]``
@ -392,7 +392,7 @@ these as necessary:
::
[firesim-quadcore-nic-ddr3-llc4mb]
[firesim-quadcore-nic-l2-llc4mb-ddr3]
# this is a comment that describes my favorite configuration!
agfi=agfi-0a6449b5894e96e53
deploytripletoverride=None
@ -401,7 +401,7 @@ these as necessary:
``[NAME_GOES_HERE]``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In this example, ``firesim-quadcore-nic-ddr3-llc4mb`` is the name that will be
In this example, ``firesim-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:

4
docs/Building-a-FireSim-AFI.rst
View File

@ -56,8 +56,8 @@ end up with something like this (a line beginning with a ``#`` is a comment):
firesim-singlecore-no-nic-lbp
#firesim-quadcore-nic-lbp
#firesim-quadcore-no-nic-lbp
#firesim-quadcore-nic-ddr3-llc4mb
#firesim-quadcore-no-nic-ddr3-llc4mb
#firesim-quadcore-nic-l2-llc4mb-ddr3
#firesim-quadcore-no-nic-l2-llc4mb-ddr3
Running a Build

4
docs/Running-Simulations-Tutorial/Running-a-Cluster-Simulation.rst
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-ddr3-llc4mb``: This tells the manager to use a quad-core Rocket Chip configuration with 4 MB of L2 and 16 GB of DDR3, with a NIC, for each of the simulated nodes in the topology.
* ``defaulthwconfig=firesim-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-ddr3-llc4mb``.
**[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-l2-llc4mb-ddr3``.
Launching a Simulation!

10
docs/Running-Simulations-Tutorial/Running-a-Single-Node-Simulation.rst
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-ddr3-llc4mb
defaulthwconfig=firesim-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-ddr3-llc4mb`` to
``firesim-quadcore-no-nic-ddr3-llc4mb``. Notice the subtle difference in this
``firesim-quadcore-nic-l2-llc4mb-ddr3`` to
``firesim-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-ddr3-llc4mb
defaulthwconfig=firesim-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-ddr3-llc4mb``.
**[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-l2-llc4mb-ddr3``.
Launching a Simulation!