Update DAMON usage document for the newly added report producer control sysfs files. Signed-off-by: SJ Park --- Documentation/admin-guide/mm/damon/usage.rst | 35 ++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst index 6093b1c8fbfd9..644250c7bd681 100644 --- a/Documentation/admin-guide/mm/damon/usage.rst +++ b/Documentation/admin-guide/mm/damon/usage.rst @@ -115,6 +115,10 @@ comma (","). │ │ │ │ │ │ ... │ │ │ │ ... │ │ ... + │ reports/ + │ │ producers/nr_producers + │ │ │ 0/report_type,producer_state + │ │ │ ... .. _sysfs_root: @@ -729,6 +733,37 @@ Please note that it's highly recommended to use user space tools like `damo `_ rather than manually reading and writing the files as above. Above is only for an example. +.. _damon_usage_sysfs_reports_producers: + +reports/producers/ +------------------ + +Under the `admin/` directory, ``reports/producers/`` directory exists. This +directory is for configuring :ref:`DAMON report producers +`. The file below exists in the directory. + +``nr_producers`` file is for generating report producers setup files. Writing +an integer ``N`` to the file creates the number of directories named ``0`` to +``N-1``. Each number-named directory is for configuring each report producer +and called "producer directory". + +reports/producers// +---------------------- + +Files below exist in each producer directory. + +``report_type`` file is for setting the type of the report to produce. Users +can set the type by writing the type name to the file. Reading the file shows +the last successfully written input. Refer to the :ref:`design document +` for the list of supported report types. + +``producer_state`` file is for reading and updating the state. Reading it +shows ``on`` or ``off`` if the producer is enabled or disabled, respectively. +Users can write below keywords for the producer to the file. + +- ``on``: Enable the producer. +- ``off``: Disable the producer. + .. _tracepoint: Tracepoints for Monitoring Results -- 2.47.3