From patchwork Tue Oct 15 17:54:07 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 13836802 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 99D27D1D88B for ; Tue, 15 Oct 2024 17:54:29 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 4218D6B0089; Tue, 15 Oct 2024 13:54:27 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 35B4A6B008A; Tue, 15 Oct 2024 13:54:27 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 1B0C96B008C; Tue, 15 Oct 2024 13:54:27 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0013.hostedemail.com [216.40.44.13]) by kanga.kvack.org (Postfix) with ESMTP id CA8EC6B0089 for ; Tue, 15 Oct 2024 13:54:26 -0400 (EDT) Received: from smtpin09.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay06.hostedemail.com (Postfix) with ESMTP id 9AFACAC02E for ; Tue, 15 Oct 2024 17:54:08 +0000 (UTC) X-FDA: 82676585754.09.D8E211B Received: from nyc.source.kernel.org (nyc.source.kernel.org [147.75.193.91]) by imf04.hostedemail.com (Postfix) with ESMTP id D68894000D for ; Tue, 15 Oct 2024 17:54:14 +0000 (UTC) Authentication-Results: imf04.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=IN553IGY; spf=pass (imf04.hostedemail.com: domain of sj@kernel.org designates 147.75.193.91 as permitted sender) smtp.mailfrom=sj@kernel.org; dmarc=pass (policy=quarantine) header.from=kernel.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1729014721; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=Kskcbc7hF0S38MBLuYBf/K164z9dWeGQGyEFSweVtNw=; b=i9XZzkv+s0pSoZL/NWsLPYWAC5lCOaT3LKzITnpSiqiKD+yXNDBDYlynZM1dZ0uDaJI/cv 37T7LPGioMg0IdrgWp3oL9noUEIO4uhND/+Prbs7WH1jPBCXezRrLqSRbWfjdVIiELD18u Kh67MXdLURjDfeseFFLsbRHWol24Y2E= ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1729014721; a=rsa-sha256; cv=none; b=L16R4Ljbq4rg+D36YylwjzGIEpNoDCDAIapcWoW/eY/wFXJtjPKMmnAOjWXRU/DKvOkLj4 w/rH0oKs/9X6r74oahAA3z+4+ke+wseFQ/t5CebxC98ZKhcnjZz18F4p6o0yUvH9eZmH2R EGIFXScxx8Ycewz7VsMUNJiuJkJgqX4= ARC-Authentication-Results: i=1; imf04.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=IN553IGY; spf=pass (imf04.hostedemail.com: domain of sj@kernel.org designates 147.75.193.91 as permitted sender) smtp.mailfrom=sj@kernel.org; dmarc=pass (policy=quarantine) header.from=kernel.org Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by nyc.source.kernel.org (Postfix) with ESMTP id 21320A43358; Tue, 15 Oct 2024 17:54:15 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id B8FACC4CEC6; Tue, 15 Oct 2024 17:54:23 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1729014863; bh=wNqTcFJIxQW0DGiFjvquOYDznG7ET2BviVO3AFzePVw=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=IN553IGYCEU2daGjInivP6wG0GqSAzY1UIjJtoUptobp/Mi1e1SbYGZ8c4FCruTm/ qtklAPy3K+bvswTj4bT2cK8UcYo4ZqYGYn38LIzSYHJxpWBj5AEOi3Ijba8AE2PLW4 SKVTgx9GC6L2qKGAsYaYEr6akbFYH74Sgna3lEReGrulejAW95EsdPLDpN2cnkguSs zvldwUqzg77Ayt+TqxcrMl8pXczmm0hwtKydMSW6w56qSBhyPljk6mlEDKADUaBu7T OdMJHJAVLYmvWdrccFdnWpQPnk7As+zzqBH7d8KVPruAmReCP1sgUOA41v8MnjR7eF sdZVR9Jm02dRg== From: SeongJae Park To: Cc: SeongJae Park , Andrew Morton , Jonathan Corbet , damon@lists.linux.dev, linux-mm@kvack.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [RFC PATCH 2/7] Docs/mm/damon/design: update for removal of DAMON debugfs interface Date: Tue, 15 Oct 2024 10:54:07 -0700 Message-Id: <20241015175412.60563-3-sj@kernel.org> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20241015175412.60563-1-sj@kernel.org> References: <20241015175412.60563-1-sj@kernel.org> MIME-Version: 1.0 X-Rspam-User: X-Rspamd-Server: rspam04 X-Rspamd-Queue-Id: D68894000D X-Stat-Signature: ysj9mwmjtsrpjsq41af1n1byspkmdzba X-HE-Tag: 1729014854-371667 X-HE-Meta: U2FsdGVkX1+qacwpDvKi16PYAFwOlHAShiHQ31cmoM2gZRECVzrpujbfOgTEoGY6sHffrh2lmXu0frvlOSudC1u3TdDy/4ai73QW4ZFpPoAcDiIs0sy63MUPE1725U4V/Ix+/WaUGi9J8JAYQziTHfhrhzF3jGzovYF7sHDIVWbIm8kn3gUPXDnGjMZbaIUrTwG0PuBQRxRQO483Y08La1mlUKnBAky01IbiIxF7TNv4xvScvW7+MJ0EkhSm9sKp111Cr4AAxeUHX1MVgKY8bVLhQFL4PAVurS9Ixt2rZeBVnGqKPchq0/cGHnDozvGhvMUSwbyS6g7+Odqnbe6BS5gNZW/71AVaRn/WVA9ooKsPfy8wCNryIbJ4fQuf++tU0n0GWEY+B5HhyM+f2bNGIH46JXQ8BbMR41so3vqtQ5rswWu+d00h77bTN9PvrvEa5SBj/kq5QQo+XhbnG2qGRGrCBiMy+Isi9t6PS/2cZqja6/QDwSxoIhRTQzrDykb/axhK1vS5MjpZtPsKMV/l6pSL7sBDPhH/bTtHspxN2AcnBHxN494ZwU99x89uWA6NwWhjaGGyfONG4sMCbSyhdRua1jWrkvRqvz2Kl1fTCN9D9zwe9VRkIGJEEJrbNQw16tSTeiGB2FQKpSfLq8e4GgaaEEACelv/ZWNjamricF8gp0nQfocW9v419p3lbxZiTvJ1qlMy7Xi5j6g1s28H+y+Arv3PuTePGwWSCSifKV9QubNgG3ACTWY6Me5d7qipHHY1GLiXPDPDyihYv+oo984UU0xuu+DtCvSGgSuyAcowcxWpql+7aHPRXGO5H2jMetG57Dc4HTnkQzb6hzDT/iHP1cP62zs+q1P/orN49wpL+9nw99holdzwrDUCY0N4QphQTxAl/ZQe0HFtxbrg6dfn9JrPYB/c8onnl/Bff8clggwm7+0Bz/i7WBouCsTLBcOJqfQ1gKq9/bB6X4y FDoFnGVK Bq6Nj1Bdqg1IUpAaVB2Vtcdyp8p0QC20A1PglYaQzRRur6hfhNuLGmSChAjquUbSGveFQWQLAwzWjFJOZn+KgjOIGePWoQ6LJpzTmtm3bN8dZWSOGfKgjs8kV3rU7HaDXoGma80tGy1riYHwbgE0+55epWOpVZXxPIndFSSJBc0MXPqSdCQchZyfKhPVlN8uT93WTZAGq7fpbaViC0c4q4J2PUqrwTvnx/nVSlmJYrDDStc9pV2UG0qHXdDIWFXleDtnT2T1n/gXBU9RJRcbkThzmFOJH3C+hXqTGHCYszxMzM6s9aKituBfw0UkJ8rpXmCEKfGkZj76UVWcaW/MZJ4v+/w== 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: List-Subscribe: List-Unsubscribe: It's time to remove DAMON debugfs interface, which has deprecated long before in February 2023. Read the cover letter of this patch series for more details. Update DAMON design documentation to stop mentioning about the interface, to avoid unnecessary confuses. Signed-off-by: SeongJae Park --- Documentation/mm/damon/design.rst | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/Documentation/mm/damon/design.rst b/Documentation/mm/damon/design.rst index f9c50525bdbf..1c8a43b07b00 100644 --- a/Documentation/mm/damon/design.rst +++ b/Documentation/mm/damon/design.rst @@ -573,15 +573,11 @@ General Purpose User Interface Modules DAMON modules that provide user space ABIs for general purpose DAMON usage in runtime. -DAMON user interface modules, namely 'DAMON sysfs interface' and 'DAMON debugfs -interface' are DAMON API user kernel modules that provide ABIs to the -user-space. Please note that DAMON debugfs interface is currently deprecated. - -Like many other ABIs, the modules create files on sysfs and debugfs, allow -users to specify their requests to and get the answers from DAMON by writing to -and reading from the files. As a response to such I/O, DAMON user interface -modules control DAMON and retrieve the results as user requested via the DAMON -API, and return the results to the user-space. +Like many other ABIs, the modules create files on pseudo file systems like +'sysfs', allow users to specify their requests to and get the answers from +DAMON by writing to and reading from the files. As a response to such I/O, +DAMON user interface modules control DAMON and retrieve the results as user +requested via the DAMON API, and return the results to the user-space. The ABIs are designed to be used for user space applications development, rather than human beings' fingers. Human users are recommended to use such @@ -590,8 +586,9 @@ Github (https://github.com/damonitor/damo), Pypi (https://pypistats.org/packages/damo), and Fedora (https://packages.fedoraproject.org/pkgs/python-damo/damo/). -Please refer to the ABI :doc:`document ` for -details of the interfaces. +Currently, one module for this type, namely 'DAMON sysfs interface' is +available. Please refer to the ABI :ref:`doc ` for details of +the interfaces. Special-Purpose Access-aware Kernel Modules @@ -599,8 +596,8 @@ Special-Purpose Access-aware Kernel Modules DAMON modules that provide user space ABI for specific purpose DAMON usage. -DAMON sysfs/debugfs user interfaces are for full control of all DAMON features -in runtime. For each special-purpose system-wide data access-aware system +DAMON user interface modules are for full control of all DAMON features in +runtime. For each special-purpose system-wide data access-aware system operations such as proactive reclamation or LRU lists balancing, the interfaces could be simplified by removing unnecessary knobs for the specific purpose, and extended for boot-time and even compile time control. Default values of DAMON