Commit e06469cd authored by SeongJae Park's avatar SeongJae Park Committed by Andrew Morton
Browse files

Docs/admin-guide/mm/damon/usage: document obsolete_target file 

Document the newly added obsolete_target DAMON sysfs file.

Link: https://lkml.kernel.org/r/20251023012535.69625-5-sj@kernel.org


Signed-off-by: default avatarSeongJae Park <sj@kernel.org>
Reviewed-by: default avatarBijan Tabatabai <bijan311@gmail.com>
Cc: David Hildenbrand <david@redhat.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Liam Howlett <liam.howlett@oracle.com>
Cc: Lorenzo Stoakes <lorenzo.stoakes@oracle.com>
Cc: Michal Hocko <mhocko@suse.com>
Cc: Mike Rapoport <rppt@kernel.org>
Cc: Shuah Khan <shuah@kernel.org>
Cc: Suren Baghdasaryan <surenb@google.com>
Cc: Vlastimil Babka <vbabka@suse.cz>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
parent e35afdf2

Documentation/admin-guide/mm/damon/usage.rst

+10 −3
Original line number Diff line number Diff line
@@ -67,7 +67,7 @@ comma (","). 
    │ │ │ │ │ │ │ intervals_goal/access_bp,aggrs,min_sample_us,max_sample_us

    │ │ │ │ │ │ nr_regions/min,max

    │ │ │ │ │ :ref:`targets <sysfs_targets>`/nr_targets

    │ │ │ │ │ │ :ref:`0 <sysfs_target>`/pid_target

    │ │ │ │ │ │ :ref:`0 <sysfs_target>`/pid_target,obsolete_target

    │ │ │ │ │ │ │ :ref:`regions <sysfs_regions>`/nr_regions

    │ │ │ │ │ │ │ │ :ref:`0 <sysfs_region>`/start,end

    │ │ │ │ │ │ │ │ ...
@@ -265,13 +265,20 @@ to ``N-1``. Each directory represents each monitoring target. 
targets/<N>/

------------



In each target directory, one file (``pid_target``) and one directory

(``regions``) exist.

In each target directory, two files (``pid_target`` and ``obsolete_target``)

and one directory (``regions``) exist.



If you wrote ``vaddr`` to the ``contexts/<N>/operations``, each target should

be a process.  You can specify the process to DAMON by writing the pid of the

process to the ``pid_target`` file.



Users can selectively remove targets in the middle of the targets array by

writing non-zero value to ``obsolete_target`` file and committing it (writing

``commit`` to ``state`` file).  DAMON will remove the matching targets from its

internal targets array.  Users are responsible to construct target directories

again, so that those correctly represent the changed internal targets array.





.. _sysfs_regions:



targets/<N>/regions