From patchwork Thu Dec 26 22:14:44 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 13921485 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 72B2AE77188 for ; Thu, 26 Dec 2024 22:15:22 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id C25116B0099; Thu, 26 Dec 2024 17:15:11 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id BAF3F6B009A; Thu, 26 Dec 2024 17:15:11 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 9B4386B009B; Thu, 26 Dec 2024 17:15:11 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0014.hostedemail.com [216.40.44.14]) by kanga.kvack.org (Postfix) with ESMTP id 71E1B6B0099 for ; Thu, 26 Dec 2024 17:15:11 -0500 (EST) Received: from smtpin15.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay06.hostedemail.com (Postfix) with ESMTP id 2F47FB15E3 for ; Thu, 26 Dec 2024 22:15:11 +0000 (UTC) X-FDA: 82938515772.15.E77D688 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by imf03.hostedemail.com (Postfix) with ESMTP id 6A1F020005 for ; Thu, 26 Dec 2024 22:14:50 +0000 (UTC) Authentication-Results: imf03.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=RyBTRG7q; spf=pass (imf03.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=1735251289; 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=IPzv9GXiWf0zCJUq16MnTusT+5CPQ3yH/5vyLEA9UM8=; b=gX+nhKYFqstnSBaL9HHI3GShbeN8he6ofXsz5g63e3wOGYXB+c6apZaf1O+iP8kCOFe9Pu TfDVk1jQxvSeeD0qwMg4oaeb+BifBT3j3OlSOOyjbixWgB8QiPRi01AI0MJTH/O+oo1vJv nwViN6LPfkib4lrKKIyWNmTEGrjcRMU= ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1735251289; a=rsa-sha256; cv=none; b=m+yaX/pJvUp02YDUjw+r8Ago6gHCK+iqDCTJTtoY1FU/YN9oQpSr4I0GnUskvnJ3yv92a7 syN4xMgYeyjGzzdPz9KYdtsiRYwaIue+akcgHRV1FabeVz12YaapF4Or0T3T50Q2x0Kfru GiqpWJsY6mtTZUE39i4HOEMZUyDRcck= ARC-Authentication-Results: i=1; imf03.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=RyBTRG7q; spf=pass (imf03.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 Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by dfw.source.kernel.org (Postfix) with ESMTP id 3B60F5C61FB; Thu, 26 Dec 2024 22:14:27 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 6E298C4CEDD; Thu, 26 Dec 2024 22:15:08 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1735251308; bh=0f0Lpal72vM2StRK6no1fT4yLv96CM7EUNHKZOxnDlE=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=RyBTRG7qaa8/dvTMhhcXh0+PZx946PmFR323CgbNSzEerJ1xkQT+X3v3GUZHtdewq S2AeFgRWfgiblLpevzE5ynWM+e4IY9n015Bq1o+edkeNioQ0NwUA1oH7YPV6N0KGpO KsOCJaiY7PMTkiM02GUWGCY5CZlCNq30x8d7Bn9gum2FSYqPKpKO/FKt9iHxKFeMur HvxnFxUIyLfB3XPz9cypDj1V5D6pbTTNlrTH3AH9zvCImIiWjwGuw0UPytZtQ01vQA sy8hHGrqZo0YgsxXZRxkN7GsIWIdOREQpJh+ene0uKuwewpcmmwCCm6Mcrh2PcNByG JatB1vN1zjG/A== From: SeongJae Park To: Cc: SeongJae Park , Andrew Morton , Jonathan Corbet , damon@lists.linux.dev, kernel-team@meta.com, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-mm@kvack.org Subject: [RFC PATCH 09/10] Docs/admin-guide/mm/damon/usage: omit DAMOS filter details in favor of design doc Date: Thu, 26 Dec 2024 14:14:44 -0800 Message-Id: <20241226221445.78433-10-sj@kernel.org> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20241226221445.78433-1-sj@kernel.org> References: <20241226221445.78433-1-sj@kernel.org> MIME-Version: 1.0 X-Rspamd-Server: rspam10 X-Rspamd-Queue-Id: 6A1F020005 X-Stat-Signature: ydejjkrd5k3qw4yr8e9ap8kojtf193ee X-Rspam-User: X-HE-Tag: 1735251290-18671 X-HE-Meta: U2FsdGVkX1+yyh7yXAF1M7ZS6xNIO8gNcY9d02U83lxg+cCmdMQVmXjtATCCQ7aavd3jgqjQGIYhFhE9iGI9or6cK8pE5keiIYl2cOU6OhbCAzqVxTIYiXTfEopOnO4kEszgjd9Pa0TzLlZ1kRwVNOo675BJ1jRtshLWZAY4jmFSF5XeZyT0a3dEGdoWIEyGprDMrmaU164Au600/cdNw0b6D7bb1+RBfmvOyE77wDjgcOAF6XRp2Sc5DNJb2cf7Ws8+S0aLOlsbeJcopH3FlfJiZDW7NUKqSHxD4PvSgnLCfmHiGeRs8NbKKCE91ZIVj+oULR2i6bMuAWqUHYTQP0Mw5+VDgNkBUN/uBfWpv8WDOkK3eQPj5H/1KHdjUi1q3K+tLMmtb/xxsQ+zGgn1vqVNw/sgc3z3ETOKqmndl4gf20THV6e+qDOetXYpHHUxpyS4Tu8wM8gNptSAJYUO3Ca+YUMMxZd7/22EzaPm/NF9gegx7UHrwXFFaS10o8170nsLfKMRvwXVL8ElapalLqWVWXhvtYkXMA7n2g6JEuM6HgFmzvTZJigKgm698MdNxBNs7o3atNw+R6lg44yPADpxIG6ID8oC3gubGJLECXihro1PZT3AtRCFyh0tM66gm6y2RcPSDRNz8V8BFa7+AFkoJHF+X3P0WKnAkqzF2li3OQvvc+c9+bT99R6ddRCZvlOXMThkIyCec20ocoyr63RDxrSlMOk+dIlG5YFRqQNuDWq4Bxqx3eJC5ACOY2Vtdv7Rah9dGKX5TbXK25caZ0vIesPPYAs8+uDUIDdL7D0A037PQARzESpgIBoGesS6JFtez6F4VAidCV0sxDsK3JIjlfdQAO7eYl6dxWvShIOtkMufFBuGqW2pQP9z7KIZPqv5GR1sYRjuyKjz3vM/8Zi/JdE6zJe/If90s5p/KL8eoYh7eog4r1jo9mgT0jUOgA7OkPysh26mERjbVt6 PsnN59VX X4gqzty9r4afDtdM2/1hqxSG3Eh68wdQioQjVQkknC850kc184Rx07B6QmyiQUZX+nzU4WTTSdxm9Obi3bm2yaMZuRwGtljDAf98a9VtCGdlBedzEBGR6s1eUG131Uhe1wA3cEgsTXpfGL3gfnzUZ+DKvkO0rB1CY13IP7nqd0k0EHe21K1PDykK0rgFHdJvI9GHX21jBm9z7kF7hOT7lsi2/pQBsAzObmcsgkgtRDZ/Dfg9vIWqDJvlLdWNncpJFzMDBtPf55e+WJDs= 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: DAMON usage document is describing some details about DAMOS filters, which are also documented on the design doc. Deduplicate the details in favor of the design doc. Signed-off-by: SeongJae Park --- Documentation/admin-guide/mm/damon/usage.rst | 29 ++++++++++---------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst index a891e830c2a1..fa8a5e4199b1 100644 --- a/Documentation/admin-guide/mm/damon/usage.rst +++ b/Documentation/admin-guide/mm/damon/usage.rst @@ -417,13 +417,17 @@ Each filter directory contains six files, namely ``type``, ``matcing``, file, you can write one of five special keywords: ``anon`` for anonymous pages, ``memcg`` for specific memory cgroup, ``young`` for young pages, ``addr`` for specific address range (an open-ended interval), or ``target`` for specific -DAMON monitoring target filtering. In case of the memory cgroup filtering, you -can specify the memory cgroup of the interest by writing the path of the memory -cgroup from the cgroups mount point to ``memcg_path`` file. In case of the -address range filtering, you can specify the start and end address of the range -to ``addr_start`` and ``addr_end`` files, respectively. For the DAMON -monitoring target filtering, you can specify the index of the target between -the list of the DAMON context's monitoring targets list to ``target_idx`` file. +DAMON monitoring target filtering. Meaning of the types are same to the +description on the :ref:`design doc `. + +In case of the memory cgroup filtering, you can specify the memory cgroup of +the interest by writing the path of the memory cgroup from the cgroups mount +point to ``memcg_path`` file. In case of the address range filtering, you can +specify the start and end address of the range to ``addr_start`` and +``addr_end`` files, respectively. For the DAMON monitoring target filtering, +you can specify the index of the target between the list of the DAMON context's +monitoring targets list to ``target_idx`` file. + You can write ``Y`` or ``N`` to ``matching`` file to filter out pages that does or does not match to the type, respectively. Then, the scheme's action will not be applied to the pages that specified to be filtered out. @@ -440,14 +444,9 @@ pages of all memory cgroups except ``/having_care_already``.:: echo /having_care_already > 1/memcg_path echo Y > 1/matching -Note that ``anon`` and ``memcg`` filters are currently supported only when -``paddr`` :ref:`implementation ` is being used. - -Also, memory regions that are filtered out by ``addr`` or ``target`` filters -are not counted as the scheme has tried to those, while regions that filtered -out by other type filters are counted as the scheme has tried to. The -difference is applied to :ref:`stats ` and -:ref:`tried regions `. +Refer to the :ref:`DAMOS filters design documentation +` for more details including when each of the +filters are supported and differences on stats. .. _sysfs_schemes_stats: