update config_runtime docs

This commit is contained in:
Sagar Karandikar 2020-02-10 01:44:25 +00:00
parent 1d67d1dde9
commit a139dfc3b9
3 changed files with 46 additions and 0 deletions

View File

@ -1,3 +1,5 @@
.. _autocounter:
AutoCounter: Profiling with Out-of-Band Performance Counter Collection
========================================================================
@ -69,6 +71,7 @@ The following example will generate counters from cover functions within the Str
2. An input file with a list of module names. This input file is named ``autocounter-covermodules.txt``,
an includes a list of module names separated by new lines (no commas).
.. _autocounter-runtime-parameters:
AutoCounter Runtime Parameters
---------------------------------

View File

@ -28,6 +28,8 @@ enable it by attaching a TracerV Bridge to the RISC-V trace port of one-or-more
cores. By default, only the cycle number, instruction address, and valid bit
are collected.
.. _tracerv-enabling:
Enabling Tracing at Runtime
----------------------------
@ -53,6 +55,8 @@ add ``TRACEFILE*`` to your ``common_simulation_outputs`` or
:ref:`defining-custom-workloads` section for more information about these
options.
.. _tracerv-output-format:
Selecting a Trace Output Format
---------------------------------

View File

@ -135,6 +135,12 @@ In a networked simulation, this specifies the maximum output bandwidth that a
NIC is allowed to produce as an integer in Gbit/s. Currently, this must be a
number between 1 and 200, allowing you to model NICs between 1 and 200 Gbit/s.
``profileinterval``
"""""""""""""""""""""""""""""
TODO @biancolin
``defaulthwconfig``
"""""""""""""""""""""""""""""
@ -149,6 +155,39 @@ hardware configuration from ``config_hwdb.ini``, NOT the actual agfi itself
(NOT something like ``agfi-XYZ...``).
``[tracing]``
^^^^^^^^^^^^^^^^^^^
This section manages TracerV-based tracing at simulation runtime. For more
details, see the :ref:`tracerv` page for more details.
``enable``
""""""""""""""""""
This turns tracing on, when set to ``yes`` and off when set to ``no``. See the :ref:`tracerv-enabling`.
``output_format``
""""""""""""""""""""
This sets the output format for TracerV tracing. See the :ref:`tracerv-output-format` section.
``selector``, ``start``, and ``end``
"""""""""""""""""""""""""""""""""""""
These configure triggering for TracerV. See the :ref:`tracerv-trigger` section.
``[autocounter]``
^^^^^^^^^^^^^^^^^^^^^
This section configures AutoCounter. See the :ref:`autocounter` page for more details.
``readrate``
"""""""""""""""""
This sets the rate at which AutoCounters are read. See the :ref:`autocounter-runtime-parameters` section for more details.
``[workload]``
^^^^^^^^^^^^^^^^^^^