From patchwork Tue Jan 7 20:17:38 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 13929585 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 44D06E77198 for ; Tue, 7 Jan 2025 20:18:33 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 81D776B00A1; Tue, 7 Jan 2025 15:18:21 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 7CD8E6B00A2; Tue, 7 Jan 2025 15:18:21 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 66D786B00A4; Tue, 7 Jan 2025 15:18:21 -0500 (EST) 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 405976B00A1 for ; Tue, 7 Jan 2025 15:18:21 -0500 (EST) Received: from smtpin29.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay06.hostedemail.com (Postfix) with ESMTP id EE431B02EC for ; Tue, 7 Jan 2025 20:18:20 +0000 (UTC) X-FDA: 82981767960.29.E36F634 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by imf27.hostedemail.com (Postfix) with ESMTP id 5B8CA40006 for ; Tue, 7 Jan 2025 20:18:19 +0000 (UTC) Authentication-Results: imf27.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=rRBPMc02; spf=pass (imf27.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=1736281099; 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=cJ0bsAZLGHO/ui9QK+muosvWX50TfLnI6ItwdWh/3g4=; b=oY0m8JawojYg++QMsbCCkfStkSt3afELZ+FtvFmq/lLgYqdrKa7et9GGVmVWv4S+bJ8Jg1 4oO9RF261K17DpPdoKcQDBdv2TbL/tmv2zfw4QKgaDnYaT9+NT5lP5QD6X8VDsNpdoKVNF EtrggZPTtyyoe+Gkm4k8oBp4GJhAcpk= ARC-Authentication-Results: i=1; imf27.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=rRBPMc02; spf=pass (imf27.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=1736281099; a=rsa-sha256; cv=none; b=6USB/Yb+r43YiXV6Ot9mUm+T7rfPpNp7oiv9CjqEH2F/+n/Hx7vEgjFwFpIYBFW60oWswu z01CEj4pxDjfPoZ74Of0VYhA70VTotWjck1XKBy+VpC92s39y45fS0S5yqYIt2XqmgYLHs QBx6omiyffR1uSNwXflUqHew3Si9rQA= Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by dfw.source.kernel.org (Postfix) with ESMTP id 8018C5C5E3C; Tue, 7 Jan 2025 20:17:37 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 3FD29C4CEDD; Tue, 7 Jan 2025 20:18:18 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1736281098; bh=jufb0sHL1L5krYu5xZ9uPN7YQ+OC0Evk60XYWVCJy7g=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=rRBPMc02CwogiTNi5E146sB1ifHgBJA2nZgVoBsESH66eEv+lycI38Q0SlqUy/xOb NMjHjZ2SEar/bVvmTWvwe3wt+Ux5Q844tzODLcdHJIrM4z5n4hz46NI0Io8laCjXPv ihZwM/eHP4dY8rtp+QXrFDijR6eGOxOw/OfKBab9RajpdYr5N+dkpD1hdDn9DeY1BM 7sw5pC7TaW6wJY0E2yUVytvSrPLTWV0C3GQTVMQh54VcSxYJq/qQ/wgbqx81AtrBiW jCYlXyACtoCqGDvcV2hLKxjDlfpI/SDXQ2UJ/ad0hTi6/yF0bHa6KpNFi83UWmk1wv af20A1eVXJHSg== 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 09/10] Docs/admin-guide/mm/damon/usage: omit DAMOS filter details in favor of design doc Date: Tue, 7 Jan 2025 12:17:38 -0800 Message-Id: <20250107201739.79484-10-sj@kernel.org> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20250107201739.79484-1-sj@kernel.org> References: <20250107201739.79484-1-sj@kernel.org> MIME-Version: 1.0 X-Rspamd-Queue-Id: 5B8CA40006 X-Stat-Signature: 7gge34j86zuftykqus33585wjqbhzsg1 X-Rspam-User: X-Rspamd-Server: rspam11 X-HE-Tag: 1736281099-498285 X-HE-Meta: U2FsdGVkX19ZhqK9pgpGVNFrzBqJZvWt/IR0kzM49ZcaiEZWkVjiaLLgPS/D+Og/+85EjKBUZ1RGn5/DsUpPJh4KgJ3eBiW0mTH4l7+BIAt8iZbQ7YwHEAWPn/cKVAdmgt9ywLyHvDvze/pVH+UfA9QpSm43DLZqLkiEG2dUY85doBA3AEuOW23LCaiFCsWiWrgG/TA9QTZolDV/piCZLAZnlQcqI1h3Xu4LHduZVt4egx2Djgxh2hY780r+MbZY3po6a2dxVu1irujzfW4hC4zJXqGEdLrnlLpwiL3uiVGzHMeSR7TfLT3RgMFNIWxUlWPSha2jNfM6oGcEybrNw2d+HCrOGDcUWdOL8RejEQdKJcqYEBUFkOijlF4ZJKDBFUDjDhWa7ViZa3twlXUq7u0Te49Zg+CgeWkworbGi3gaGpQZ3Y4YX6hvZKo9mKajdwMy1UYz0UUdXO9eWikBmQdB59zZsQPmWr0r9ta3kt/KcCZD9BohzDXX3Nhj9TErj+SvxMSdY2kChYexZYxmD+eoW+4gdMpc111hZy99PAmUQ6q+chhbiP8Z5DhHcDLQJunYSaux1hd83QIM+5UIdB5X2FM4uCn+U54l7ChebyWA1GxJy/yWh9OtbvVXVQA3EzlTr7mLLwqIH0ctnb1WGpST6tplBXhcpa4OLqSFDQk8Tdrp2CyPbhCgYXXMd7mHCGFbkmWVRZFNygEMHWeRNwrq2FjWPnm+35ONsXGaZdaq3ZrjpMDcYvWC/BR8fOEkfJYwK3zicx7QV/0n5eZO768I5P0OlfG12DCgp4ytLlczhDLLRdR5cO3G6TS4I+CoDyrahdH2ad3CKmYglUK4W4o4GOn63U6EsfSqP28UsasW+WttGfX1R21QvnDdOArOZO+3sy8opzB/MlaM4Ox8syvyd6iVek4cJ/t17e1P7pmK8r5n/mQmcTJrILYgSWIg6Y7KslePl5ArfMsi5VE /YSDOKj8 bQ5ycP4s8rnT9P10hOWULEH0ZUDIX/dzJ+R12HW9xK9mEwdKsMJtcSJp1VJuShi8e5qLH605QlIbW7PbQ/8pHS3HZEidxkZhVuYrBBxaqSm1BNrSWYcrke8NyMIh47wyVwUqbaDVwsvU9EAkwtwIJEIyr/29fmmXahihP8uNzMcqyXfPeBfoZTpq08tWvQvRIc+RSnT3QZ1LVD6g6GlL2+BbNvskzcxly4iibg6MJu2CsjlszhBldwcqjfHKKe4uNSbZKKj3NaqfB8ss= 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 71cf29ae8502..8df3357dcfa3 100644 --- a/Documentation/admin-guide/mm/damon/usage.rst +++ b/Documentation/admin-guide/mm/damon/usage.rst @@ -411,13 +411,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. @@ -434,14 +438,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: