From patchwork Fri Dec 27 21:08:18 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 13922143 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 3A42DE7718B for ; Fri, 27 Dec 2024 21:08:50 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 515366B0098; Fri, 27 Dec 2024 16:08:39 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 3F72F6B009A; Fri, 27 Dec 2024 16:08:39 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 1FEBE6B009B; Fri, 27 Dec 2024 16:08:39 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0011.hostedemail.com [216.40.44.11]) by kanga.kvack.org (Postfix) with ESMTP id F42266B0098 for ; Fri, 27 Dec 2024 16:08:38 -0500 (EST) Received: from smtpin15.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay01.hostedemail.com (Postfix) with ESMTP id B0E111C7FD5 for ; Fri, 27 Dec 2024 21:08:38 +0000 (UTC) X-FDA: 82941976866.15.11435F7 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by imf10.hostedemail.com (Postfix) with ESMTP id 1DE81C0010 for ; Fri, 27 Dec 2024 21:08:17 +0000 (UTC) Authentication-Results: imf10.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=tzYuJeoj; spf=pass (imf10.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=1735333687; 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=kERhCYb4TzE4sPY6+ZGyDiSysPS2uX6mTS7DINm2vZJUtBkrG/Gh/cuitnvaFxZuoH3Ex3 8Q16J267BkLOzFPNQi6CCpuo6iLRI6xbiAn0ENFqn+16U879vtwZyb/FDvvyrUjV3EOF9c D6OcH4LKYHGJVZoslwGLGz9vt5cOBZA= ARC-Authentication-Results: i=1; imf10.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=tzYuJeoj; spf=pass (imf10.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=1735333687; a=rsa-sha256; cv=none; b=KHxy/BP3MlYJ5Je/Indn5gMVFUPcGBGvp4GgXvCnTu2nTIa+vy01+ekvFq3UbnYMQzgKWK iFbe5TQQJUrQ9Kvgf9soojbLznd4QwkEGfVDA3FSYUzEquvkkiJ48TtVHFwEe8wAGX5W9Z rfuQiVfmlfhvLHocGW3rNKg169tWRSY= Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by dfw.source.kernel.org (Postfix) with ESMTP id 31EB15C5F8C; Fri, 27 Dec 2024 21:07:55 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 658FFC4CED0; Fri, 27 Dec 2024 21:08:36 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1735333716; bh=0f0Lpal72vM2StRK6no1fT4yLv96CM7EUNHKZOxnDlE=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=tzYuJeojgz6j6mJfTpQyOG4GrL1j41APF9tsSPSYFQMX0DRnSeBmavDD/7J/0/A69 AlAbH/E30qYO/C4wnJEZQjluLnWJUNF2/Ouoc/IbtS/FvYMYWvJXCVRpZAbK49Z9f7 bMWp+d+KqNhLT5aABhtLng25SkuvJL/ozeazzuc/oSNMBTfC9PdRZExmDViMp+0Lob n3toGZI8sjyyZpS7epAyEkSebAciE67v+CJt7vPdFnqtKadshGuq5tgg55c8Bktikh pBhUrrf2YHV8j1e19xhg0/dQF20QW8l3J/JKoXo1ujbba8Li9ykDVaNmIm7ulStnjs CRcSYClGGGNdw== 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 v2 09/10] Docs/admin-guide/mm/damon/usage: omit DAMOS filter details in favor of design doc Date: Fri, 27 Dec 2024 13:08:18 -0800 Message-Id: <20241227210819.63776-10-sj@kernel.org> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20241227210819.63776-1-sj@kernel.org> References: <20241227210819.63776-1-sj@kernel.org> MIME-Version: 1.0 X-Rspamd-Server: rspam05 X-Stat-Signature: ww1wzcegrk59mf7yy7azc9iawg7iroys X-Rspamd-Queue-Id: 1DE81C0010 X-Rspam-User: X-HE-Tag: 1735333697-148180 X-HE-Meta: U2FsdGVkX18p5u7X1Ozy1vlOrQmw4Vs9G9U2JkRnAKZeDsoBi9AghwTpO9Fg+6+Ly0OuQZe66jl/OWvTJ5rKy8s7v2QLuZeqMJ+Tnw+CbRNGGtSOIqJuCmYf5V0WrSILnezecpUYyndcgFg4lL60LZVRePGaI6op0Puu5TU68lDHmSzux5ar+RLn3cVkeBXX5q0oDObtIzrLp5uN2Q1uCIjMbeX+mwWKHDhnDM8rui2A+qYy6AQsIe5unMJWxsn7NAZRav3QZyHiOLayTDYqbjyLpT3A+iNFNIGpfeoDjgnYyOSyPceEYl0kGmSbF/T7kL5HTxriJN0k4oAlDx9stgUZHZ/CWXt59ORUNZeCtp/+VN1rgr4zLZBoH1AT0+I0i+aF8vrM5yDWMHoiO31lXR1xqVMKd8pLZlfFC7mF0fx1wAEnbucgxFxZaxraaQZitorWNcvwf+MIe7F7EdLJqRAAWBeLf+2a+l/ss6S8K07ISw12nHnbRUG9e34QPfRXM+OkHdqM/sIjI0DurIx2q2aOqNXeprsXPqfhJCVO8KRbWt2DKoMnO3Qfjm87vjmWSFgyalFssCI7y5SWkxwBlXRPevrZP0FPf/ss5mJy/mIgVV6BabE4Lsxk0y8Xh3MaODYHnW1Pj47ZMpO9QKtLhXgXZfo2u4mi7D2XZnQXbRkelNjiEUzoldog2ix0B2Zmc2UJvGuiqgrPMllVl+2ESTutrEtIfZ8k0iw57DJ/3JwnxIBxztHvnUHoetoCfONkQUB4zBbJhA52km5tbm5F+rkuKsFu+oEUI5CANJz4H/W1fc2SE9NzB1d6u5WQuMGjR2FTdWsZVVKpecMB/tEh0Iz1dQouQ/XeaOVPXECx2N8yoYW/4+OsoMbn8TPn1JOlwtJL5ODb/dNFRZ29Bp+gngjoQ9ZC1MXGLCmKBOLRX2Nr/56+b5w9Nit3eUmuOw8GjMIT8NhqTxANrEw7ynY STxzD3Xn Pg8nFdPf7tB9xpN3oVFN8nTHk0WtDsZFXwhDlZT6DFomMDIjTjO1JStMPB2ii64f3NxLGkuatcDUFg06MPj6cOM3nju9sZvjbeASDRwBtTQLFHZUVMF4hNJR2E+/egllpcAFwbTymwIwmDwRCkFIRyWZnSP7mHtXYs721GwO6EJj1i3MSDaYVQeE809YmGKL/gnPNo0fnWNaVMGTBO01VRxihVQ0oj5dtaQ9x00I9uddKtNnHXevCtzhSln8y+ayEr+MY8lYHf/2Q9SQ= 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: