From patchwork Wed Jan 1 21:35:22 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 13924276 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 E593BE7718B for ; Wed, 1 Jan 2025 21:35:43 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id A499B6B0085; Wed, 1 Jan 2025 16:35:40 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 9D2616B0088; Wed, 1 Jan 2025 16:35:40 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 84B0C6B0089; Wed, 1 Jan 2025 16:35:40 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0017.hostedemail.com [216.40.44.17]) by kanga.kvack.org (Postfix) with ESMTP id 6B40F6B0085 for ; Wed, 1 Jan 2025 16:35:40 -0500 (EST) Received: from smtpin22.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay08.hostedemail.com (Postfix) with ESMTP id 10E42140880 for ; Wed, 1 Jan 2025 21:35:40 +0000 (UTC) X-FDA: 82960188570.22.5D43C70 Received: from nyc.source.kernel.org (nyc.source.kernel.org [147.75.193.91]) by imf16.hostedemail.com (Postfix) with ESMTP id 084D5180005 for ; Wed, 1 Jan 2025 21:34:47 +0000 (UTC) Authentication-Results: imf16.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=UHhA5gxk; spf=pass (imf16.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=1735767304; 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=1DahIBWEzklQXNN0BrxsoSCAC2kTtTN2KH4/9+YnDHWV38Gkj/5U269FzpfLkjGjOYcQzg Xr6esMdtcxdQpzNHY9N0chN5U0y5D+ruCmrABL6hdeNSoKWunT2UatgeVVJTiSIAsXsO3l i9ZFP0rZl7BPmBxLr3ZLzgTWaVl/PBM= ARC-Authentication-Results: i=1; imf16.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=UHhA5gxk; spf=pass (imf16.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-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1735767304; a=rsa-sha256; cv=none; b=FeqROKMc91+UPOlOJ0nhVgpBt9vrXDzjZBDTCs2Gn3Y6lXKdwq5dkGoQWeaAfXPXF3PW90 W1bIgAR+TXuEcEXO2LaZhMb6fZokklcvXcnfo+PSemMks5oNdj0RsnpEwgY4Z6wy3pco7v njkKjbZ5Hlb0aahPgn4KxDvJMbbWkOg= Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by nyc.source.kernel.org (Postfix) with ESMTP id 899E5A40BDE; Wed, 1 Jan 2025 21:33:48 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 85C76C4CEDD; Wed, 1 Jan 2025 21:35:37 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1735767337; bh=wNqTcFJIxQW0DGiFjvquOYDznG7ET2BviVO3AFzePVw=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=UHhA5gxk1kOay39rsNUMKcL5VNJIKngUbHyRxQ9Q1uNVT9bpE167KT+wbWqY7jeXE Q6VljzQGUcn31tWCvYMnC42Y9dqiQwIkgNpKoMGY5K7XPlboVZia/IAq060pbGC08g m6R6JSOsavS5oJwxWrI/7qjrHltRR5jz79FNGq1CAslofemo5IM0mChUMidBNFescB 11B/VEeCQIdXETPDq2ypVc5GKvRoflw4GhiCqkBZvc7OqHoHhRQe7PJmzqG07GHm0c +h5rA9hIPz/ZjNY6p6lLVSG8kEQLtZZO5p+xkJqFmnqgSOL5/9bxMM9+JyUTQHqQCB tmrn/SSH3DCQQ== From: SeongJae Park To: Andrew Morton Cc: SeongJae Park , Jonathan Corbet , damon@lists.linux.dev, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-mm@kvack.org Subject: [PATCH 2/7] Docs/mm/damon/design: update for removal of DAMON debugfs interface Date: Wed, 1 Jan 2025 13:35:22 -0800 Message-Id: <20250101213527.74203-3-sj@kernel.org> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20250101213527.74203-1-sj@kernel.org> References: <20250101213527.74203-1-sj@kernel.org> MIME-Version: 1.0 X-Rspamd-Server: rspam05 X-Stat-Signature: 8a1wzcb33zndsncfmamrzjx6gyhhjroq X-Rspamd-Queue-Id: 084D5180005 X-Rspam-User: X-HE-Tag: 1735767287-128255 X-HE-Meta: U2FsdGVkX1/Cj0EZGgVhS9j+flZ/w7Q2J0htdYHLV37v++DOt2xQ/A7fOtMeiIADknD8mrh46r8f7L4lMsY8fpOpDD7qVRZdazyouCjKzYMMyA2sWWVCWXigb0QclSjYRR3Q847shoDXW374Jx6mfjT0VBkj+DY8U3UQ1l6V7Plwz8NUFT+4JY7cuAsvNReZzDmMDt5ap50AVvdxjSIEUe9jdVjvN7hIra504vhJTXMa6AsCUXFs+VeNdyVUJsub7KGoVQ7J5/qTZ/sTQMjndvlrMwDno4QvL970lNNPAYL6lMsIWsTOweEmElb0vqk6cUV0W5i0O4am/Gk0hGPUZRiz94auIgNpqPNRNqSkywXoJ9mmgNGPk9cATcNtGzJxClYMSUSAAI0cozyghpoyVJ8DI2+e1wAiwXESw7q7E84LArl1Vkw4bTtnd58SDGhBiRMeZfiOhGQCAYrVHBJi6TaU/nXgufkIcZpT+5OWd8aLE4Xe2EQFzT/9xV1DeIgyyC/Jxo+r5P/NVaO2Hb+fSdToQWBScq98hvw02uEpxlBSrehXSdfC8n8hBtVMuSJ5G/JSwq9bnRZ2hGauVQlow1TBBr+IbwAPb8+on/lWQHxIl7ZJr0dTA2xjmcphpyzRVfCNlKBvZOgYLk8QdzIgJQ8CUHCe67N9VeDg0bSjh/JbNOYHZ7SPFf+Af4wRyTTcl0ukxad7/1NmLBUGQD2Hr9dxgNJXiw8MUPwgXQ+3njthZwWBiDpumI6JbE7FKD/d4NaTke6+HYji3VW7UoC9yiUNtFBV+iPyKT5NIu0u6RyFTfXEq+JWDfcrV/8W7zhpxwQZOfscr21zDPfn+TpLNbb5TTDohZ7uCQg6fivz68Rr8ef868O2sybcpwWXkwug0b9rFX5/w641jHJbyu5mjKpXF0q2j2go2KOUBxmnWqYuIyRLOA+3y3OC7SDZAP2RAhujhoMDmP0Im3reZ3y VG3YmMZF f6ddrXQ4u8+MtUYQ2RT1ZNwsWqYV73PfTZb9bM0sUBwdud5LinkRN1e3+Z658CIUbEcCxQtTn+j1r6JXnRAyPhrGgptu+4g+gpWxuFVq/Rl6+YMBAttpVh9ETDkgw3l9u261YegrC/7Ki/c0kirNGe+NS1oDwpDS6E2Ei1oGcLunXiaOhSG9EpDPkwrzali2UWEH+4a8Fz8H27qOx/WFQAmuhAEQkDTkDOQmQ+JHmpPic06UvyjLyuimBDdNceU4EwQ2yiQcStbWaPWcrVatjqNMgsxDzLIHyHi6FQtOpFkDLbRzdUUXYVApFj2hFAD6HfuxMcMJgtC1c8rcAYeXtDNz6Ww== 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