mm/damon/usage.rst

19   features by reading from and writing to special sysfs files.  Therefore,
21   reads/writes the sysfs files instead of you.  The `DAMON user space tool
36 creates multiple directories and files under its sysfs directory,
38 from the files under the directory.
50 Files Hierarchy
53 The files hierarchy of DAMON sysfs interface is shown below.  In the below
55 directory is having ``/`` suffix, and files in each directory are separated by
102 has one directory named ``admin``.  The directory contains the files for
111 Under the ``admin`` directory, one directory, ``kdamonds``, which has files for
124 In each kdamond directory, two files (``state`` and ``pid``) and one directory
134 - ``commit``: Read the user inputs in the sysfs files except ``state`` file
137   ``aggr_us`` files of the kdamond with the auto-tuning applied ``sampling
138   interval`` and ``aggregation interval`` for the files.  Please refer to
143 - ``update_schemes_stats``: Update the contents of stats files for each
152   files.
157   ``effective_bytes`` files for each DAMON-based operation scheme of the
162 ``contexts`` directory contains files for controlling the monitoring contexts
182 In each context directory, two files (``avail_operations`` and ``operations``)
204 Files for specifying attributes of the monitoring including required quality
209 Under ``intervals`` directory, three files for DAMON's sampling interval
212 writing to and reading from the files.
214 Under ``nr_regions`` directory, two files for the lower-bound and upper-bound
217 writing to and rading from the files.
229 Under the directory, four files for the auto-tuning control, namely
233 mechanism.  Reading and writing the four files under ``intervals_goal``
238 ``sample_us`` and ``aggr_us`` files after writing ``update_tuned_intervals`` to
274 as they want, by writing proper values to the files under this directory.
285 In each region directory, you will find two files (``start`` and ``end``).  You
287 region by writing to and reading from the files, respectively.
299 writing to files under this directory.
312 ``tried_regions``) and three files (``action``, ``target_nid`` and
336 ``nr_accesses``, and ``age``) each having two files (``min`` and ``max``)
338 to and reading from the ``min`` and ``max`` files under ``sz``,
350 Under ``quotas`` directory, four files (``ms``, ``bytes``,
355 ``reset interval`` in milliseconds by writing the values to the three files,
372 Under ``weights`` directory, three files (``sz_permil``,
376 in per-thousand unit by writing the values to the three files under the
393 Each goal directory contains three files, namely ``target_metric``,
397 of the files.  Note that users should further write
409 Under the watermarks directory, five files (``metric``, ``interval_us``,
412 get the five values by writing to the files, respectively.
434 installed before those of ``filters``.  All three directories have same files.
437 filters with the files under directory bit confusing.  Users are hence
446 Each filter directory contains nine files, namely ``type``, ``matching``,
456 files, respectively.  For ``hugepage_size`` type, you can specify the minimum
457 and maximum size of the range (closed interval) to ``min`` and ``max`` files,
496 The statistics can be retrieved by reading the files under ``stats`` directory
498 ``sz_ops_filter_passed``, and ``qt_exceeds``), respectively.  The files are not
500 content of the files for the stats by writing a special keyword,
514 directory contains files exposing detailed information about each of the memory
538 In each region directory, you will find five files (``start``, ``end``,
539 ``nr_accesses``, ``age``, and ``sz_filter_passed``).  Reading the files will
581 the files as above.  Above is only for an example.