From patchwork Thu Dec 19 04:03:13 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 13914445 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 50CD2E77184 for ; Thu, 19 Dec 2024 04:03:51 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id A15FD6B008A; Wed, 18 Dec 2024 23:03:46 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 94FC06B008C; Wed, 18 Dec 2024 23:03:46 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 7C7D36B0092; Wed, 18 Dec 2024 23:03:46 -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 57ED86B008A for ; Wed, 18 Dec 2024 23:03:46 -0500 (EST) Received: from smtpin06.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay03.hostedemail.com (Postfix) with ESMTP id 17554A13E3 for ; Thu, 19 Dec 2024 04:03:46 +0000 (UTC) X-FDA: 82910363550.06.8AF35B2 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by imf29.hostedemail.com (Postfix) with ESMTP id C64A6120003 for ; Thu, 19 Dec 2024 04:02:58 +0000 (UTC) Authentication-Results: imf29.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=AlR11qQK; spf=pass (imf29.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=1734580988; 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=OCAiqK43y8Z+vTKc1SUu+jPej/COz8njgBO4zF7ZqwM=; b=ufUyRCoer4PVgBZdR1rLIzWJQHW/eVulb4HnMbFvdl6A1j6Z6DpqquWMKwhab0VAu+caDd DqKJYIJommvFgc3MQEszGg6Z7PAmmfGnxrjc0k2CVMBPIf6EvbXTRCXYDS5n6lVpqNc9Mz JtmsH9A72JDD1B4vOjVH1S72Vgl/OxI= ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1734580988; a=rsa-sha256; cv=none; b=VhyA4tGEzbwcMT+/Uf80O9KvYGf2+bhZunEVQLuxB2IVQkN6CBlRaLQThF/xrdbASScNXT QTQ/wRfkBRa3v3DOA5/1w/J1NTpQ87D+CSlJK2LCorXY8xkwW84UaLkaXNya6aiB5IpnVV DIVyOcr8Q9/GuYrRebfGlQcCR6CfmOc= ARC-Authentication-Results: i=1; imf29.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=AlR11qQK; spf=pass (imf29.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 AD6635C6640; Thu, 19 Dec 2024 04:03:01 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 636A9C4CED4; Thu, 19 Dec 2024 04:03:43 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1734581023; bh=870oJTBXZdVt9AT5feGTAshGBO42oNB2tnBh+kdf9pU=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=AlR11qQKkpzyBTQiNLszI6jcdKv/J1EWDO9SjdrivcgOlH5rxhbckRGbfZe2FbiaM a8x4tU2XvnmKsuiGDsK8gF/whIEhzVaXGsbJDgQk4AfZJrYbonz2kx8zbUAg13Kp2B 9TZwVLkhLuPW6CzZpL5Xw4rxSqaGTfgH0byKfAwsAR6agFFyc9LHSj1Y7FC0KUexGJ 70R0u8m3b2edUS2OxLyOMeWognAaGXuwyRsgB3LsoHGkiLiyKELVULuSsEhpg4nQew l8c22bHynMak/3i/RggiuhQUNOYJYzJJwGVn89+oD5LiGtvwE9z//yNT0t+ab5wcDe d4AHq3FbGrKCA== From: SeongJae Park To: Cc: kernel-team@meta.com, SeongJae Park , damon@lists.linux.dev, linux-mm@kvack.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [RFC PATCH 04/18] Docs/admin-guide/mm/damon/usage: link damos stat design doc Date: Wed, 18 Dec 2024 20:03:13 -0800 Message-Id: <20241219040327.61902-5-sj@kernel.org> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20241219040327.61902-1-sj@kernel.org> References: <20241219040327.61902-1-sj@kernel.org> MIME-Version: 1.0 X-Rspamd-Queue-Id: C64A6120003 X-Rspam-User: X-Rspamd-Server: rspam07 X-Stat-Signature: d5qhcurt81t83jjh8w9jequ6k5nqfwdw X-HE-Tag: 1734580978-973190 X-HE-Meta: U2FsdGVkX19swmkecBgzwGXLRjhKcz7PL0LnKlZbMpkjPxutETYb54g3KvrHP0hwj1K+VGa0UF2DmvjSL0ojKu4nSkaHPU3quycKwQVjAau2qlcIP3iHzIxE4HTdmNf3mblhgYU+6RADWh4S4/dBRX3TX7+kXofyqGb0qGE/PY9iIvpXMEZVX9W3pm3jcrqZ6LHj+ebOsqebkEIeI4nP+6MmozdHpxxTI/Bvba8vOr+kcczgQybvNYzKWwdenxWUmY7M9aUjpbKbMP/WCGVqGzjJKKeEFI3zF9MXo+w6urWPdIthKWRPHMILXQ6EQykXT5hqOoseDXWwB77GMYS/YpQjK8RCsgzSHLLkwQ8VfSQqqNXBiHWkOJkw2+lisg2l+Oo1up7j/ppFNXa+RzQ96Lq+HzMQSk5szhEUJb4HIWchcg5x42eI4HtD1dCf137/M1kokIEg+2x7QI4MLC1nc76XosFQBjY8LdFkjCqdOUFVKsx3XiyF6JM/0FkDei5HACjvTGk5U4EtF3/Idi81xIGr73z0xV4Ex/CtcCTJ/4Aq8wUD054Tbbq4r/koAHsYFrkDUYFXPwK2S/ebBXQBaSPRL9PQxA9ZPdVlaxQ7drTtQ1xumzgcpqIqF7iSF/fzE1dLCr4O9O0T+0+rNNYve62ocidUvALmEQOssxl/efaXCCMHA6hNfoHm0uY2yp8uE8r8tZ7GmwK6icZDBgGic5HJMv8yDL6d2qZ6DHoJNo0k7fQZmGTMn3ctClnzpEOgCOYJARCklL1Zeafb26QURmDS0LVBRnPHFvoywk6gkunBAK/K0QDKm1hiwggYpiD5AGTrc/bWksSEBbDkxWpAYrF8+ZfzX3wyzU6X8h43yoXFqdre2hf9dZcqYsYtyJwi7G08yLBAvxGPlChAzJ1Hz/cnEZpTxCTcMrLI696TcucDp9bVhZKRqQowuOhSEzGg+fgnY5f2EOJoBKyUpq8 M0E9TSgh AUP9eHBIACVmpDCmkKOUt4k/i5PCvPpbJv/f/bukU2CalG8emrUeQ30Ur6N6OkBAyJGov2vgd5ObwaeWcriZERuuvDBRhuTgWJF4B5d9mxxFkhvRX9Fi3nd+xYqgoSyHMlkkRXjbg7GsI8YFkAlFhS5MkaKU1NtUGx9usVlik00apyKuL2mAFjLminEiZ3/dZhXI0uMc7JdawFJqEbS0s2a/Zn703KRme1Mm1Hoj40YENzSOXQ69pC7oIv8xYEG0Zgna5FREkePQQk0c= 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 sysfs usage document should focus on usage, rather than the detail of the stat metric itself. Add a link to the design document on usage section for DAMOS stat. Signed-off-by: SeongJae Park --- Documentation/admin-guide/mm/damon/usage.rst | 3 ++- Documentation/mm/damon/design.rst | 2 ++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst index d9be9f7caa7d..af70f7244700 100644 --- a/Documentation/admin-guide/mm/damon/usage.rst +++ b/Documentation/admin-guide/mm/damon/usage.rst @@ -457,7 +457,8 @@ schemes//stats/ DAMON counts the total number and bytes of regions that each scheme is tried to be applied, the two numbers for the regions that each scheme is successfully applied, and the total number of the quota limit exceeds. This statistics can -be used for online analysis or tuning of the schemes. +be used for online analysis or tuning of the schemes. Refer to :ref:`design +doc ` for more details about the stats. The statistics can be retrieved by reading the files under ``stats`` directory (``nr_tried``, ``sz_tried``, ``nr_applied``, ``sz_applied``, and diff --git a/Documentation/mm/damon/design.rst b/Documentation/mm/damon/design.rst index 8710fa71ad71..e2666124e382 100644 --- a/Documentation/mm/damon/design.rst +++ b/Documentation/mm/damon/design.rst @@ -539,6 +539,8 @@ To know how user-space can set the watermarks via :ref:`DAMON sysfs interface `, refer to :ref:`filters ` part of the documentation. +.. _damon_design_damos_stat: + Statistics ~~~~~~~~~~