From patchwork Mon Jan 6 19:19:36 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 13927773 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 B4949E77188 for ; Mon, 6 Jan 2025 19:19:57 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id AF19A6B0093; Mon, 6 Jan 2025 14:19:54 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id A7BF76B0095; Mon, 6 Jan 2025 14:19:54 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 8CFC16B0096; Mon, 6 Jan 2025 14:19:54 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0015.hostedemail.com [216.40.44.15]) by kanga.kvack.org (Postfix) with ESMTP id 6C2686B0093 for ; Mon, 6 Jan 2025 14:19:54 -0500 (EST) Received: from smtpin06.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay02.hostedemail.com (Postfix) with ESMTP id 1C2AF120266 for ; Mon, 6 Jan 2025 19:19:54 +0000 (UTC) X-FDA: 82977991908.06.1077031 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by imf28.hostedemail.com (Postfix) with ESMTP id 617D6C0012 for ; Mon, 6 Jan 2025 19:19:52 +0000 (UTC) Authentication-Results: imf28.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=GmPu+efe; spf=pass (imf28.hostedemail.com: domain of sj@kernel.org designates 139.178.84.217 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=1736191192; a=rsa-sha256; cv=none; b=y3xU9z4f57cpmtLdBdUWQmVVCfNBuklU3tPEMDbwuYgGSRRlBmS2QiCdH7aXRX8rxqHi4A DHo4vI9GP/BrkOaIac3MgaEgE0H9O0PRESxHcNRjobEm4DY1UYRw+GDR+ZF/6aUCd3R3/n XSD6tYLFljllouQkK67jZHrTkWtgrTc= ARC-Authentication-Results: i=1; imf28.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=GmPu+efe; spf=pass (imf28.hostedemail.com: domain of sj@kernel.org designates 139.178.84.217 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=1736191192; 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=0BbdYqd0MkNLZPG0Kepw4tnO5fyV230JfZZWIPWh8Gw=; b=zYSH6g5Lk9EpMfGE5xD15UFK+ZbL/wMzkKo0Gb6Pe6CXwYOgQDA6EeFLz+Y4520Fy4tt/r 1v/VYsJaWgcMoszH1SaLWZjOWPzp89Lf8LwhIUfO2d8CZlzF5rTkSOh7SVSV8st8VY7kME XahxJbafqr0w/Fbd2d4J5YsrQOtywQs= Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by dfw.source.kernel.org (Postfix) with ESMTP id 39B575C5975; Mon, 6 Jan 2025 19:19:10 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id E968CC4CED2; Mon, 6 Jan 2025 19:19:50 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1736191191; bh=5+ILY6AWLzSiGMYwsHx0+z4eLxwhpFGbZnepiwaDSm0=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=GmPu+efeoqikvP1zk66C6wepvQMNgRqweO36kmpptHzpBTfI5raPgt9l4iTKjih7v n0X/ErppPDIXQjurzFYWed2Ow60ezLNo0CdpzpddrBLf6hhw40hot7CZiR50n1TIYO TmtEjJU2w0nmCSse8TveeP+IdR2TMJd6+s9D/Na4eLaz9gwpZ6ATm4f2gGgUnvHdMZ MB64IAxu+7Uc+zOIBrvlJHuX6S5odNIyMgyYKGz2QjZnlYRazLHpw16lHezsDe5uQ9 IGpMBllE1OhDc/NmLNCqTkMtqU3owKyS4YLGX1u8FuMMY6jQJu8/mPuzfhtPVRkVqJ i/IgEwykZFaMg== 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 v2 3/8] Docs/mm/damon/design: update for removal of DAMON debugfs interface Date: Mon, 6 Jan 2025 11:19:36 -0800 Message-Id: <20250106191941.107070-4-sj@kernel.org> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20250106191941.107070-1-sj@kernel.org> References: <20250106191941.107070-1-sj@kernel.org> MIME-Version: 1.0 X-Rspamd-Queue-Id: 617D6C0012 X-Stat-Signature: tatd5k7fashcrn9xdxx3z8qrbnie6sy7 X-Rspam-User: X-Rspamd-Server: rspam09 X-HE-Tag: 1736191192-414648 X-HE-Meta: U2FsdGVkX196xg+kRYEqYhIzQOMGouVpZ8vKmvo5S/hh95WC1aPK+3EDlgp0FCiHIVX2ktGhI/MhQZ1BI43GEY3h07fPWu3TsSw2V5cF762iulqLbV/4906vHQtlXxJDb68a1xp243fWo/n0i6IdjD1igilwP//rA1pdO/35xZT/NLFhWb8scr5u/BOVYs2e0KP10Kdnq055WTeXb2v3vGm+2DTAv1wNx4GbegAW984dm+KoLWeAhUnnVKcR/9iChdnNIa2/gz27kb+84pOBPa2ilJqU96DuxO7FdUOnk2T/S9MMRJSKsZz4cm03cmm4bozwUi4ZctzXPSkQ/CgkvgNO1f7+zws8DmkFaLlMTwD+ER+F3lStV1/5nlyJOp1KY3MTv1Boz2KwU6mdfY9+pu/laY6QVW/2K/pjZ+Hhei5R93fN/wSdPYF5bdLvqFsrgBwcYXaR8HMuEMr7C+qgh7UrLs9fCGBaQYCzwThhfnTLXSCvjESEZiXS7niBKFBVndHjWUlCcao3V8SgsvYYm9q6UG3W8SuFy/ZnpwFZDOdMcMZln1SnvAmTDsemHkRPcw23MpyK3stv9FhRSsk4EpZutmbefooS1mlteZqNG8PjU7qXAPw6dd6kNHpE5fuPhV3L+B66bPLErnYPo+AF//toIAzQ0ia5q4o3v4LkUV+/Ygj+N1pvXLYTPvi318PwNAvIXVCgx5aSxaDevdteCMkfs0G7UbLCLNRXXX0SMAJKisR4icrbfrs3b7bOKfiZygHHrH/mpk0HPH/aUBQofN+BUjUfBSBljk7pQPUIYkO1oBio96Hiij8YXzbC5SBtS3ajP60z42vQxpawS0XHzf6viPOZaH3LSzAJb7FccMov/uRE/y5m5QCJcMlABUkRT63UPCF+brVrPojw01zKASbEajqsoIOhCB6HU1TyeRsik8Y3ebZ7EDNj9e5Yq7CG5aGCiyIA3ZI/3FDpGDv QCodId+E EylaDo5VWuyoyGG4Un10s+JQyM1pLJAbkqAJ6sBq2kvwadUrbQU7T1+/GqEoa+SfTKiQ3WH3TOeunr+HyP77kV6mlzERJl+TXNWFF2F9el02w+2XTRTHG9Cw/L7UPPTMtq22UBhOXkx3TvylAtojQbNrpHdC9+7YEXgw7w6MvjuFqssF4+wJcahgIfaqoT2qsQXV8DZ0z/u+4KXdmky9tDd1KbFpCa2JdjNxSlD2INs1JgDQSxMypoy7AfXiHUJmcf6pPY2i0q7eR0YIcJFQ1eC70TxluoAAextYd2v9SDCdu1pCpUaqEVJSZFg7Vx8OHOB/NSpCR+Ioitur7AVFsIt+dfA== 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 a577ae40e71c..5385ea04c2fd 100644 --- a/Documentation/mm/damon/design.rst +++ b/Documentation/mm/damon/design.rst @@ -584,15 +584,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 @@ -601,8 +597,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 @@ -610,8 +607,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