From patchwork Fri Dec 27 21:08:19 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 13922144 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 D358CE7718B for ; Fri, 27 Dec 2024 21:08:52 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 8DE7C6B009A; Fri, 27 Dec 2024 16:08:40 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 88EE26B009B; Fri, 27 Dec 2024 16:08:40 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 705636B009C; Fri, 27 Dec 2024 16:08:40 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0016.hostedemail.com [216.40.44.16]) by kanga.kvack.org (Postfix) with ESMTP id 509236B009A for ; Fri, 27 Dec 2024 16:08:40 -0500 (EST) Received: from smtpin25.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay02.hostedemail.com (Postfix) with ESMTP id C6B8F1214EF for ; Fri, 27 Dec 2024 21:08:39 +0000 (UTC) X-FDA: 82941976278.25.B0838A3 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by imf19.hostedemail.com (Postfix) with ESMTP id 1F8851A000E for ; Fri, 27 Dec 2024 21:07:52 +0000 (UTC) Authentication-Results: imf19.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=o5jlTrkx; dmarc=pass (policy=quarantine) header.from=kernel.org; spf=pass (imf19.hostedemail.com: domain of sj@kernel.org designates 139.178.84.217 as permitted sender) smtp.mailfrom=sj@kernel.org ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1735333677; a=rsa-sha256; cv=none; b=2TjiwMX6b3Zfu2eIbnpn4uNInfvfheZ/Lmp0dC1hXGSY0jxj7vs59kGDqewhmhjnhB5uY6 ljdGgqo62Se3vR9Nvci2VW+mUWZOidxqh9+B9ceRav0wXQ1bAP/Thk6HXM9TwjP3r+026C zD1j114ptuirXVxqB2bc2i+AVvBU3ZY= ARC-Authentication-Results: i=1; imf19.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=o5jlTrkx; dmarc=pass (policy=quarantine) header.from=kernel.org; spf=pass (imf19.hostedemail.com: domain of sj@kernel.org designates 139.178.84.217 as permitted sender) smtp.mailfrom=sj@kernel.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1735333677; 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-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=EKfy8EJizGx6z6bJOK97yIUerr1jg8sHqFfi0BrZy8s=; b=HbepbpMWfJJtZbCeEeh6f91eAoI8XcJaERjWojaAKvgg8HAuA+Mkr5f6tSE6k5vnBsCOog gEAPVS+1wUBonNGsGXFWaWeu1OZJZEsTR9/+DCGOg/Rk0kUUz4jm9EDSGzXrNaAkV1bY1U Ye+6JsY7A9epSX6skPMzkJ4M1bhrNVc= Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by dfw.source.kernel.org (Postfix) with ESMTP id 471195C6160; Fri, 27 Dec 2024 21:07:56 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 74C85C4CED6; Fri, 27 Dec 2024 21:08:37 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1735333717; bh=ZbbHwYTvObdK/b1twjLv8JU3nRNHBdenJ+FrDPH80HA=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=o5jlTrkx5zTKZTuesqU5n+9f0OdlVA6hmzTbZPvQ5JKsJVX4iiWKvrhvlnTRd7OI1 jMg2scciox/wPAFbbig/SR6u3qijlgCxEEwgwM3B/YUnHK4It0ucwis2zE64g0yKnl O4Pk/AaoN0liR3uJS5oabbMQA8hX1kHsOca2EXsUNaG05xng6BhB7HbMJfnxS2fkme swIsyhbsbQT8JA67gSg8xulL9WxUmLaRtujGTryjBLHFdZl7HSd2+JrJi0koki9Y/Q gX59WWnzh00P4rEsKygPW7X7H0VMXN9ENEovOPWSQWlGqR5Ex+JT/AMUvxB1TUnanB 9kZE6ytcH8XLA== 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 10/10] Docs/admin-guide/mm/damon/usage: document DAMOS filter 'pass' sysfs file Date: Fri, 27 Dec 2024 13:08:19 -0800 Message-Id: <20241227210819.63776-11-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-Stat-Signature: qbi6zecbccqeqpy3jejuinmpd8siam4k X-Rspam-User: X-Rspamd-Queue-Id: 1F8851A000E X-Rspamd-Server: rspam08 X-HE-Tag: 1735333672-601332 X-HE-Meta: U2FsdGVkX1/059XzTe3BpZXYw+xDeb9UxCX6GppEShRvLq+WDMLLDlN49ZFJtd+Ya1ojGQ+k5qf9X8aE8EoOfoy605ErP4swgwUMEjm33gvOhvpzpldzfe37CPKAqJHlnScoIPHoem2ejsOfL3wB6+gpsxdfOKoYNKpoaFzXcrqDn3DfyM/pG3MOHCBVHfkPXxvkPFe5kby4nSgsAx1fwokTProXDoUeucDUY7plasKLl3bt1L9JrJvHAU4ylSpRO7Z4+OL2mgB6ce6xfclPYuZN8gQMLtUxaKNOEvKGAigj1IfDcCD7wh+FmFH7ldjADi1bqFef9PQyV4n9UfIIlXNlyTQukspQ2Eoq/E68055jweFGiXpa1E3ZgmDuL11mmrPXI40opJ4Zu8Uane8c0SC0LD3d3ELBw8v61Y0cJ154mIQzu+qsHBw9GvIS0OtJBBTQswmwr/uZwLlUM7Tqoyva+67BprpLXAd2HEef6LK9N1zOsh5yyI4KJgG1yCvwDumUR7Idr3hdi2nmql+goHkkjgdlNcAF7pDhfFV3myst8WWrubEajU/1vcbok0SBxsBcwnbD4iUunUAalSm93PB9Jrg/o1FNgQQrJsNW4QT5pc3SawgoIzeCN7yL5h+xgET2DTHKEy2qn1h9b3avpfB1L71GfFzbjFGwnUIEiqAa/aYjmUKn5uL1NHnuCDiaCbtuVLWH/eCAiW82bhRBHR+HFU2ULfzEYDxWq7qoSQ8m5GMfCwYffWGWq2hFO9xwjVEDOEIpG7I6Zt+Mj8hqjdm7QotmdNmYDOey68B3TIHZngReYBaT35GECI04fKYQsWWjCfZlqRnpv32HpNhmGij3GOhx8EInwI/Vg5uCUXU34AtSW/WSguQh1ApFNFOD3LaN7yKVSn8ojkUYZ6lSCIdXT8uFdz8eqWiKu1Bukoyj9ZQdBuKdLIEYxSrrWJLajgXhP9i++jWaKWRSxyv vw0b4qCn xfrVPryajLNRb0dZoQyO1pKlQ6KLLLO0peUSE8JUXcq9uwuGwhAHzcmk6BQ0JcJ2W5nWfIQQVnErd8wBKyFSKBFok8a7a/4kDhl64cvrsyDSOgs8O65p6ng1XBGf0zfd16STs3cJlvwlb6YpdVa72WyCbjwPO2+GW/Rirrvs1JcTbgAs0gtrcYFTPGtIZYA8X/WXUmR2md+R35X+sRdbT0bbWyyuX7Ct0UFfQ8Y4ExMbKT7iG3sHRI7jmnTSYYIpmEPoP2iR/c+19CpGPuWc2ppPkWqyzorNTGC+FWzKaqXlau5W04+YFCKQSMA== 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: Update DAMON usage document for the newly added 'pass' sysfs file for DAMOS filters. Signed-off-by: SeongJae Park --- Documentation/admin-guide/mm/damon/usage.rst | 34 ++++++++++++-------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst index fa8a5e4199b1..ab343d6ac771 100644 --- a/Documentation/admin-guide/mm/damon/usage.rst +++ b/Documentation/admin-guide/mm/damon/usage.rst @@ -89,7 +89,7 @@ comma (","). │ │ │ │ │ │ │ │ │ 0/target_metric,target_value,current_value │ │ │ │ │ │ │ :ref:`watermarks `/metric,interval_us,high,mid,low │ │ │ │ │ │ │ :ref:`filters `/nr_filters - │ │ │ │ │ │ │ │ 0/type,matching,memcg_id + │ │ │ │ │ │ │ │ 0/type,matching,memcg_id,pass │ │ │ │ │ │ │ :ref:`stats `/nr_tried,sz_tried,nr_applied,sz_applied,sz_ops_filter_passed,qt_exceeds │ │ │ │ │ │ │ :ref:`tried_regions `/total_bytes │ │ │ │ │ │ │ │ 0/start,end,nr_accesses,age,sz_filter_passed @@ -412,13 +412,14 @@ number (``N``) to the file creates the number of child directories named ``0`` to ``N-1``. Each directory represents each filter. The filters are evaluated in the numeric order. -Each filter directory contains six files, namely ``type``, ``matcing``, -``memcg_path``, ``addr_start``, ``addr_end``, and ``target_idx``. To ``type`` -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. Meaning of the types are same to the -description on the :ref:`design doc `. +Each filter directory contains seven files, namely ``type``, ``matcing``, +``pass``, ``memcg_path``, ``addr_start``, ``addr_end``, and ``target_idx``. To +``type`` 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. 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 @@ -428,25 +429,30 @@ specify the start and end address of the range to ``addr_start`` and 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. +You can write ``Y`` or ``N`` to ``matching`` file to specify whether the filter +is for memory that matches the ``type``. You can write ``Y`` or ``N`` to +``pass`` file to specify should this filter let the memory that satisfies the +``type`` and ``matching`` pass though (allow) or be blocked by (reject) the +filter. Allowing means the scheme's action will be applied to the memory. For example, below restricts a DAMOS action to be applied to only non-anonymous pages of all memory cgroups except ``/having_care_already``.:: # echo 2 > nr_filters - # # filter out anonymous pages + # # block anonymous pages echo anon > 0/type echo Y > 0/matching + echo N > 0/pass # # further filter out all cgroups except one at '/having_care_already' echo memcg > 1/type echo /having_care_already > 1/memcg_path echo Y > 1/matching + echo N > 1/pass Refer to the :ref:`DAMOS filters design documentation -` for more details including when each of the -filters are supported and differences on stats. +` for more details including how multiple filters +of different ``pass`` works, when each of the filters are supported, and +differences on stats. .. _sysfs_schemes_stats: