linux-kernel - Re: [PATCH v2 13/13] Docs/ABI/testing: Add DAMON sysfs interface ABI document

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-Id: <20220225141007.12974-1-sj@kernel.org>
Date:   Fri, 25 Feb 2022 14:10:07 +0000
From:   SeongJae Park <sj@...nel.org>
To:     SeongJae Park <sj@...nel.org>
Cc:     Greg KH <gregkh@...uxfoundation.org>, akpm@...ux-foundation.org,
        corbet@....net, skhan@...uxfoundation.org, rientjes@...gle.com,
        xhao@...ux.alibaba.com, linux-damon@...zon.com, linux-mm@...ck.org,
        linux-doc@...r.kernel.org, linux-kselftest@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2 13/13] Docs/ABI/testing: Add DAMON sysfs interface ABI document

Hello Gregg,


On Fri, 25 Feb 2022 13:23:00 +0000 SeongJae Park <sj@...nel.org> wrote:

> On Fri, 25 Feb 2022 14:18:59 +0100 Greg KH <gregkh@...uxfoundation.org> wrote:
> 
> > On Fri, Feb 25, 2022 at 01:07:12PM +0000, SeongJae Park wrote:
> > > This commit adds DAMON sysfs interface ABI document under
> > > Documentation/ABI/testing.
> > > 
> > > Signed-off-by: SeongJae Park <sj@...nel.org>
> > > ---
> > >  .../ABI/testing/sysfs-kernel-mm-damon         | 276 ++++++++++++++++++
> > >  MAINTAINERS                                   |   1 +
> > >  2 files changed, 277 insertions(+)
> > >  create mode 100644 Documentation/ABI/testing/sysfs-kernel-mm-damon
> > > 
> > > diff --git a/Documentation/ABI/testing/sysfs-kernel-mm-damon b/Documentation/ABI/testing/sysfs-kernel-mm-damon
> > > new file mode 100644
> > > index 000000000000..11984c3a4b55
> > > --- /dev/null
> > > +++ b/Documentation/ABI/testing/sysfs-kernel-mm-damon
> > > @@ -0,0 +1,276 @@
> > > +what:		/sys/kernel/mm/damon/
> > > +Date:		Feb 2022
> > > +Contact:	SeongJae Park <sj@...nel.org>
> > > +Description:	Interface for Data Access MONitoring (DAMON).
> > > +		See Documentation/admin-guide/mm/damon/index.rst for details.
> > 
> > Ick, no.  Put the real details in here please.  That way it works with
> > our tools.
> 
> Ok, thanks for the quick comment!

Before sending the full series again, I'd like to get your comment if you're
ok.  What do you think about below?

diff --git a/Documentation/ABI/testing/sysfs-kernel-mm-damon b/Documentation/ABI/testing/sysfs-kernel-mm-damon
new file mode 100644
index 000000000000..11984c3a4b55
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-kernel-mm-damon
@@ -0,0 +1,276 @@
+what:		/sys/kernel/mm/damon/
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	Interface for Data Access MONitoring (DAMON).
+		See Documentation/admin-guide/mm/damon/index.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	Interface for privileged users of DAMON.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/nr_kdamonds
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	Writing a number to this file creates the number of kdamond
+		directories under the kdamonds/ directory.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/state
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the current state of the kdamond.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/pid
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for getting the pid of the kdamond.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/nr_contexts
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	Writing a number to this file creates the number of DAMON
+		context directories under the contexts/ directory.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/operations
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the monitoring operations set to
+		use for the context.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/monitoring_attrs/intervals/sample_us
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the sampling interval for the
+		context in micro-seconds.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/monitoring_attrs/intervals/aggr_us
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the aggregation interval for the
+		context in micro-seconds.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/monitoring_attrs/intervals/update_us
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the update interval for the
+		context in micro-seconds.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/monitoring_attrs/nr_regions/min
+
+WDate:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the minimum number of monitoring
+		regions for the context.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/monitoring_attrs/nr_regions/max
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the maximum number of monitoring
+		regions for the context.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/targets/nr_targets
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	Writing a number to this file creates the number of monitoring
+		target directories under the targets/ directory.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/targets/<T>/pid_target
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the pid of the target process if
+		the context is for virtual address spaces monitoring.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/targets/<T>/regions/nr_regions
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	Writing a number to this file creates the number of monitoring
+		region directories under the regions/ directory.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/targets/<T>/regions/<R>/start
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the start address of the
+		monitoring region.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/targets/<T>/regions/<R>/end
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the end address of the monitoring
+		region.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/nr_schemes
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	Writing a number to this file creates the number of DAMON-based
+		operation scheme directories under the schemes/ directory.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/action
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the action of the scheme.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/sz/min
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the mimimum size of the scheme's
+		target region.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/sz/max
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the maximum size of the scheme's
+		target region.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/nr_accesses/min
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the mimimum 'nr_accesses' of the
+		scheme's target region.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/nr_accesses/max
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the maximum 'nr_accesses' of the
+		scheme's target region.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/age/min
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the mimimum 'age' of the scheme's
+		target region.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/age/max
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the mimimum 'age' of the scheme's
+		target region.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/quotas/ms
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the time quota of the scheme.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/quotas/bytes
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the size quota of the scheme.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/quotas/reset_interval_ms
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the quota charge reset interval.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/quotas/weights/sz_permil
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the under-quota regions
+		prioritization weight for 'nr_accesses'.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/quotas/weights/nr_accesses_permil
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the under-quota regions
+		prioritization weight for 'nr_accesses'.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/quotas/weights/age_permil
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the under-quota regions
+		prioritization weight for 'age'.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/watermarks/metric
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the metric of the watermarks for
+		the scheme.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/watermarks/interval_us
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the metric check interval of the
+		watermarks for the scheme.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/watermarks/high
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the high watermark of the scheme.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/watermarks/mid
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the mid watermark of the scheme.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/watermarks/low
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for setting and getting the low watermark of the scheme.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/stats/nr_tried
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for getting the number of regions that the action of the
+		scheme has tried.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/stats/sz_tried
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for getting the total size of regions that the action of
+		the scheme has tried.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/stats/nr_applied
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for getting the number of regions that the action of the
+		scheme has successfully applied.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/stats/sz_applied
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for getting the total size of regions that the action of
+		the scheme has successfully applied.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.
+
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/stats/qt_exceeds
+Date:		Feb 2022
+Contact:	SeongJae Park <sj@...nel.org>
+Description:	File for getting the number of the exceed events of the
+		scheme's quota.
+		See Documentation/admin-guide/mm/damon/usage.rst for details.


Thanks,
SJ

> 
> 
> Thanks,
> SJ
> 
> > 
> > thanks,
> > 
> > greg k-h