From patchwork Sat Feb 17 00:58:40 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 13561142 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 99F2EC48260 for ; Sat, 17 Feb 2024 00:58:57 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 782476B008C; Fri, 16 Feb 2024 19:58:53 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 6B91D6B0092; Fri, 16 Feb 2024 19:58:53 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 534596B0093; Fri, 16 Feb 2024 19:58:53 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0010.hostedemail.com [216.40.44.10]) by kanga.kvack.org (Postfix) with ESMTP id 40A3D6B008C for ; Fri, 16 Feb 2024 19:58:53 -0500 (EST) Received: from smtpin30.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay09.hostedemail.com (Postfix) with ESMTP id 4E99A80119 for ; Sat, 17 Feb 2024 00:58:52 +0000 (UTC) X-FDA: 81799486104.30.FFD4738 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by imf19.hostedemail.com (Postfix) with ESMTP id BC3441A000F for ; Sat, 17 Feb 2024 00:58:49 +0000 (UTC) Authentication-Results: imf19.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=V1LRIars; dmarc=pass (policy=none) 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=1708131529; 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=vmxiajUirsBDl1M6sqXQnv4umdkdvmXO8tcQkVWhVto=; b=acaiLD3nsC/mv7MuO1RBphIaJW7FctcSQIsKHsHdEjBtJl/BAd8b+K0jlO2cczzGBLEA76 ULFVWYzAI2vYAhjhR8TPiFq8YV4djWFXIHCGvKeLM4BwdKbn6LzNjKvK77+LNeG3zCZL/v v3QuKSTMAh7mgO3zL1/LWfLy4y2al10= ARC-Authentication-Results: i=1; imf19.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=V1LRIars; dmarc=pass (policy=none) 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=1708131529; a=rsa-sha256; cv=none; b=OANFgbe71149rKXMJMQ+JPVDvBeXeOAFz6tr/YLh4wcKe2PUdLSshe8fn2EG5BE7Ml6Q4w LmgKOk6FwuS38SoS5MhIZyzvPvY+w8MHBfOWdPf6LL1l6Mq49j3F7dTXMUhNURiRh8sXXM fMmuhdBDVNPRIvt6TsPObzgHDizWssM= Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by dfw.source.kernel.org (Postfix) with ESMTP id 039566208F; Sat, 17 Feb 2024 00:58:49 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 3E7F1C43390; Sat, 17 Feb 2024 00:58:48 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1708131528; bh=PHukevGUaPQZ0Um8hgVXJLMqOMYMR4EFewceSXfTR20=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=V1LRIarsi4JEdp5awudjc8ZjiK4TTDFQvBacB7HgvC9og6SplSDfSj8p9vx7Nj1vU MXt6mtUIt/A3GuCr60Kt4C+LT1P/BFtsSq+1sFP5SzhpblfgpDJHEx1coctwHfxF4Y 1aflAnUaAPr8y286nDAaC2Bx03T5qXXnXP06wYAtuL//9xKsm8/mbH/ZdM2H3zWRAm 4fW0ZDYAO0hI2FGOwq5MynjPnqmI6ulZsgjSumQuTmBN1vesW0pIRAvRFhu216FWyw w0N6B3qOo/dajkSf/2tCIL8phQRnHhfS9cwp+sb++optf0lUc91VHsTIbSMYg2mbVc vi47D6ILa3s6g== From: SeongJae Park To: Andrew Morton Cc: SeongJae Park , Jonathan Corbet , damon@lists.linux.dev, linux-mm@kvack.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH 3/5] Docs/mm/damon: move DAMON operation sets list from the usage to the design document Date: Fri, 16 Feb 2024 16:58:40 -0800 Message-Id: <20240217005842.87348-4-sj@kernel.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20240217005842.87348-1-sj@kernel.org> References: <20240217005842.87348-1-sj@kernel.org> MIME-Version: 1.0 X-Rspamd-Queue-Id: BC3441A000F X-Rspam-User: X-Rspamd-Server: rspam05 X-Stat-Signature: 3o76e3skm95zmmj9nsyb96mzm5tycbyd X-HE-Tag: 1708131529-509958 X-HE-Meta: U2FsdGVkX19vELmYXjiVlcAuFsJfoVBMSU3dg+LNFy6zgI7S1kyvSJF7MN9DShElMZBGM35ln5x/0aJIEUkuVc/jv1auAjsrUwlLdpAJi3LSuhAfNQc2/tNG76IBXbRVAtg+i4+lP9RxqSreFS9WBVf3cRGCWo2zEpOSY+Mz7z3qCs67fjZdzkdRPREgZjS7NjGa9oZiNqlLu80lYygOogOaakGB6UnCsRd8H75aOgfsghGB25PYc07XY9cnHTZlPjef0Tfx/gWrTkG8c9kYTL+u+09B/3J+q5O1LSQAYRP6Bh/y3IIlQN6j4fVS/dlB0jSxmNFx3W3ueOWKvooRpQSHlsVPjNu3cyRBXwWgbjWl2Dsegl/p9rMYblhzKpb9wqdJEbZcsJTuYWlRDNoNCCHLO7yalhTM/6Jp+6U0bnUjG7siVdwP9FgRatchm2W6JyZ17iG3t0Zoa+cPniws98HzwPeqq9HNuK5atoL24kPcAKATeCKJyoaP/FD5ly3hJwJ4THrrxbv0TS1GR2cHSH239/EmzqixfjxMAlPmNQyPbJS1oAmUAalBFqmeYrDbPggWb3L1+3TG/mtjrxR1PwkhISRh1CO/7Z6qnG42cuhicrWvFBWIQBnggR9D6Ku34X5CQjbIxwVFuvC88o2eQ7iWw95GJrgtTNNgPr1lozfhMHkqxIV/+BEmxvpf39uB8H9G+PKsemq4E1uEkhSi5ujlTlZkTgdBDZKwoBAut0fDI6gXW5Fvg4HHcF/A0dtS7CvbUw0ewojEC7AD5Ol0eCjzASpeHP8q7HRzVCV0yc8W7PSkEOGhSJ+G0jXQrd8x1n++kZV/qL3dWY4SvAnS43SHECb5Huw/m1tsZm0MURXM0r96PC0s11tPNGxUTmkWiex2jW+tweNzMoAokDbrDejqnhXiTbwA9j0GgpITmaR1fS4x0K6bWg== 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: The list of DAMON operation sets and their explanation, which may better to be on design document, is written on the usage document. Move the detail to design document and make the usage document only reference the design document. Signed-off-by: SeongJae Park --- Documentation/admin-guide/mm/damon/usage.rst | 19 +++++++------------ Documentation/mm/damon/design.rst | 12 ++++++++++-- 2 files changed, 17 insertions(+), 14 deletions(-) diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst index 0335d584956b..be0924f47a42 100644 --- a/Documentation/admin-guide/mm/damon/usage.rst +++ b/Documentation/admin-guide/mm/damon/usage.rst @@ -180,19 +180,14 @@ In each context directory, two files (``avail_operations`` and ``operations``) and three directories (``monitoring_attrs``, ``targets``, and ``schemes``) exist. -DAMON supports multiple types of monitoring operations, including those for -virtual address space and the physical address space. You can get the list of -available monitoring operations set on the currently running kernel by reading +DAMON supports multiple types of :ref:`monitoring operations +`, including those for virtual address +space and the physical address space. You can get the list of available +monitoring operations set on the currently running kernel by reading ``avail_operations`` file. Based on the kernel configuration, the file will -list some or all of below keywords. - - - vaddr: Monitor virtual address spaces of specific processes - - fvaddr: Monitor fixed virtual address ranges - - paddr: Monitor the physical address space of the system - -Please refer to :ref:`regions sysfs directory ` for detailed -differences between the operations sets in terms of the monitoring target -regions. +list different available operation sets. Please refer to the :ref:`design +` for the list of all available operation sets and their +brief explanations. You can set and get what type of monitoring operations DAMON will use for the context by writing one of the keywords listed in ``avail_operations`` file and diff --git a/Documentation/mm/damon/design.rst b/Documentation/mm/damon/design.rst index 9f16c4e62e72..6abf976dd71f 100644 --- a/Documentation/mm/damon/design.rst +++ b/Documentation/mm/damon/design.rst @@ -31,6 +31,8 @@ DAMON subsystem is configured with three layers including interfaces for the user space, on top of the core layer. +.. _damon_design_configurable_operations_set: + Configurable Operations Set --------------------------- @@ -63,6 +65,8 @@ modules that built on top of the core layer using the API, which can be easily used by the user space end users. +.. _damon_operations_set: + Operations Set Layer ==================== @@ -71,8 +75,12 @@ The monitoring operations are defined in two parts: 1. Identification of the monitoring target address range for the address space. 2. Access check of specific address range in the target space. -DAMON currently provides the implementations of the operations for the physical -and virtual address spaces. Below two subsections describe how those work. +DAMON currently provides below three operation sets. Below two subsections +describe how those work. + + - vaddr: Monitor virtual address spaces of specific processes + - fvaddr: Monitor fixed virtual address ranges + - paddr: Monitor the physical address space of the system VMA-based Target Address Range Construction