From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 3E8B1C433EF for ; Fri, 25 Feb 2022 14:10:17 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 4BB568D0003; Fri, 25 Feb 2022 09:10:16 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 4695E8D0001; Fri, 25 Feb 2022 09:10:16 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 330238D0003; Fri, 25 Feb 2022 09:10:16 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (relay.a.hostedemail.com [64.99.140.24]) by kanga.kvack.org (Postfix) with ESMTP id 23E898D0001 for ; Fri, 25 Feb 2022 09:10:16 -0500 (EST) Received: from smtpin07.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay06.hostedemail.com (Postfix) with ESMTP id EF597243CE for ; Fri, 25 Feb 2022 14:10:15 +0000 (UTC) X-FDA: 79181486790.07.8E4CFA8 Received: from ams.source.kernel.org (ams.source.kernel.org [145.40.68.75]) by imf31.hostedemail.com (Postfix) with ESMTP id 3580320012 for ; Fri, 25 Feb 2022 14:10:15 +0000 (UTC) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ams.source.kernel.org (Postfix) with ESMTPS id 8798AB82FEA; Fri, 25 Feb 2022 14:10:12 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 4C45EC340E7; Fri, 25 Feb 2022 14:10:10 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1645798211; bh=Z3SoVbshXHos/cxfHhG7VB/RjM15UbqMfAWm6h5edEc=; h=From:To:Cc:Subject:Date:In-Reply-To:From; b=fEtfDh/kgr/urn/ouoDc5KE2TL3KYk0dea3qzIAxfrKN47ER1UTMzw3/QtRRLzRrX E2Wobtdz2m2U3ScMr/t4p8y8Vw4z921L6X0tS4Jam/UvKfcRowa8PQ4EwVsiCZJB1W 2WsqFgu1VmZMBzhgphOGFGGPnKvX6ITVcWC/ZUkmAcBU6g9jMrgFOFbl2uvjYwCgE0 NMFA2in/hIXv12FPkWfqs2romvSO5YFwGGdQnp/IeLGoS8VhKCRJM4fcGhLc45rb4Z SU3qlleupDTMNtcAhy54J9Y+sC5ShnJIzS7mIpaEJ9CBwmjopkj73JYFGtoTkTZhCa fipmvdb1cATkQ== From: SeongJae Park To: SeongJae Park Cc: Greg KH , akpm@linux-foundation.org, corbet@lwn.net, skhan@linuxfoundation.org, rientjes@google.com, xhao@linux.alibaba.com, linux-damon@amazon.com, linux-mm@kvack.org, linux-doc@vger.kernel.org, linux-kselftest@vger.kernel.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH v2 13/13] Docs/ABI/testing: Add DAMON sysfs interface ABI document Date: Fri, 25 Feb 2022 14:10:07 +0000 Message-Id: <20220225141007.12974-1-sj@kernel.org> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20220225132300.12767-1-sj@kernel.org> Authentication-Results: imf31.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b="fEtfDh/k"; dmarc=pass (policy=none) header.from=kernel.org; spf=pass (imf31.hostedemail.com: domain of sj@kernel.org designates 145.40.68.75 as permitted sender) smtp.mailfrom=sj@kernel.org X-Rspam-User: X-Rspamd-Server: rspam10 X-Rspamd-Queue-Id: 3580320012 X-Stat-Signature: zeopd3r7wbw1ar5oboacgbobh6i7m6bq X-HE-Tag: 1645798215-80695 X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: Hello Gregg, On Fri, 25 Feb 2022 13:23:00 +0000 SeongJae Park wrote: > On Fri, 25 Feb 2022 14:18:59 +0100 Greg KH 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 > > > --- > > > .../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 > > > +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 +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 +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 +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//state +Date: Feb 2022 +Contact: SeongJae Park +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//pid +Date: Feb 2022 +Contact: SeongJae Park +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//contexts/nr_contexts +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//operations +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//monitoring_attrs/intervals/sample_us +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//monitoring_attrs/intervals/aggr_us +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//monitoring_attrs/intervals/update_us +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//monitoring_attrs/nr_regions/min + +WDate: Feb 2022 +Contact: SeongJae Park +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//contexts//monitoring_attrs/nr_regions/max +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//targets/nr_targets +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//targets//pid_target +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//targets//regions/nr_regions +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//targets//regions//start +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//targets//regions//end +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes/nr_schemes +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes//action +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes//access_pattern/sz/min +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes//access_pattern/sz/max +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes//access_pattern/nr_accesses/min +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes//access_pattern/nr_accesses/max +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes//access_pattern/age/min +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes//access_pattern/age/max +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes//quotas/ms +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes//quotas/bytes +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes//quotas/reset_interval_ms +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes//quotas/weights/sz_permil +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes//quotas/weights/nr_accesses_permil +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes//quotas/weights/age_permil +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes//watermarks/metric +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes//watermarks/interval_us +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes//watermarks/high +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes//watermarks/mid +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes//watermarks/low +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes//stats/nr_tried +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes//stats/sz_tried +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes//stats/nr_applied +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes//stats/sz_applied +Date: Feb 2022 +Contact: SeongJae Park +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//contexts//schemes//stats/qt_exceeds +Date: Feb 2022 +Contact: SeongJae Park +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