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
42 creates multiple directories and files under its sysfs directory,
44 from the files under the directory.
56 Files Hierarchy
59 The files hierarchy of DAMON sysfs interface is shown below.  In the below
61 directory is having ``/`` suffix, and files in each directory are separated by
107 has one directory named ``admin``.  The directory contains the files for
116 Under the ``admin`` directory, one directory, ``kdamonds``, which has files for
129 In each kdamond directory, two files (``state`` and ``pid``) and one directory
139 - ``commit``: Read the user inputs in the sysfs files except ``state`` file
143 - ``update_schemes_stats``: Update the contents of stats files for each
152   files.
159 ``contexts`` directory contains files for controlling the monitoring contexts
179 In each context directory, two files (``avail_operations`` and ``operations``)
206 Files for specifying attributes of the monitoring including required quality
211 Under ``intervals`` directory, three files for DAMON's sampling interval
214 writing to and reading from the files.
216 Under ``nr_regions`` directory, two files for the lower-bound and upper-bound
219 writing to and rading from the files.
263 as they want, by writing proper values to the files under this directory.
274 In each region directory, you will find two files (``start`` and ``end``).  You
276 region by writing to and reading from the files, respectively.
288 writing to files under this directory.
300 ``watermarks``, ``filters``, ``stats``, and ``tried_regions``) and two files
339 ``nr_accesses``, and ``age``) each having two files (``min`` and ``max``)
341 to and reading from the ``min`` and ``max`` files under ``sz``,
353 Under ``quotas`` directory, three files (``ms``, ``bytes``,
357 ``reset interval`` in milliseconds by writing the values to the three files,
364 Under ``weights`` directory, three files (``sz_permil``,
368 in per-thousand unit by writing the values to the three files under the
385 Each goal directory contains two files, namely ``target_value`` and
386 ``current_value``.  Users can set and get any number to those files to set the
401 Under the watermarks directory, five files (``metric``, ``interval_us``,
404 get the five values by writing to the files, respectively.
427 Each filter directory contains six files, namely ``type``, ``matcing``,
436 ``addr_start`` and ``addr_end`` files, respectively.  For the DAMON monitoring
474 The statistics can be retrieved by reading the files under ``stats`` directory
476 ``qt_exceeds``), respectively.  The files are not updated in real time, so you
477 should ask DAMON sysfs interface to update the content of the files for the
492 directory contains files exposing detailed information about each of the memory
516 In each region directory, you will find four files (``start``, ``end``,
517 ``nr_accesses``, and ``age``).  Reading the files will show the start and end
559 the files as above.  Above is only for an example.
631 DAMON exports eight files, ``attrs``, ``target_ids``, ``init_regions``,
849 Setting the files as described above doesn't incur effect unless you explicitly
863 Please note that you cannot write to the above-mentioned debugfs files while
864 the monitoring is turned on.  If you write to the files while DAMON is running,
890 the ``mk_contexts`` and ``rm_contexts`` files.
894 DAMON debugfs files for the context. ::
910 Note that ``mk_contexts``, ``rm_contexts``, and ``monitor_on`` files are in the