From patchwork Mon Jul 1 19:27:01 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 13718588 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 8C956C2BD09 for ; Mon, 1 Jul 2024 19:27:29 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 11D926B00B4; Mon, 1 Jul 2024 15:27:20 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 0A5986B00B5; Mon, 1 Jul 2024 15:27:19 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id D79C46B00B6; Mon, 1 Jul 2024 15:27:19 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0017.hostedemail.com [216.40.44.17]) by kanga.kvack.org (Postfix) with ESMTP id B4EF36B00B5 for ; Mon, 1 Jul 2024 15:27:19 -0400 (EDT) Received: from smtpin27.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay05.hostedemail.com (Postfix) with ESMTP id 56A9B410CA for ; Mon, 1 Jul 2024 19:27:19 +0000 (UTC) X-FDA: 82292167398.27.2A67ECD Received: from sin.source.kernel.org (sin.source.kernel.org [145.40.73.55]) by imf19.hostedemail.com (Postfix) with ESMTP id 5E26A1A0008 for ; Mon, 1 Jul 2024 19:27:16 +0000 (UTC) Authentication-Results: imf19.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b="acEBW/Cf"; dmarc=pass (policy=none) header.from=kernel.org; spf=pass (imf19.hostedemail.com: domain of sj@kernel.org designates 145.40.73.55 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=1719862013; 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=460fOOV9VzOiiQsx1FOiAgYjZDCfOqJZvpe2TAHd9W4=; b=doZHd2KpGLDhqRPKSL8oGlS0TjzCIS9Wu1p3rKCsO47AnO6xyuQ5scvcsaeDZGmd0F9JO5 BIczZe7PTQaEw9+jz3VEoBwC8zMuAgwv58pAfgmlbMAoTUlQ44Ky4Yn+CXXiYVOIZx0Mox LJXarm/IW2BpRaXSRmOLZvIgqt2A1Ck= ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1719862013; a=rsa-sha256; cv=none; b=iTmXAokQXoLGqsPFnzkUy2IILxVK9CCA6CatIQ4gdNhfxKO8SexZ8RZfGrxylckvJfUWAo MNKWN5rXAARBGRFsG/rGw7jv0yRI21J7bubpHZZ9gUjhpZEdencu70k8Bv1CcJNnjavaW9 W9u7wVr+iVjsGaQi7xEcy2XQFc5PjZQ= ARC-Authentication-Results: i=1; imf19.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b="acEBW/Cf"; dmarc=pass (policy=none) header.from=kernel.org; spf=pass (imf19.hostedemail.com: domain of sj@kernel.org designates 145.40.73.55 as permitted sender) smtp.mailfrom=sj@kernel.org Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by sin.source.kernel.org (Postfix) with ESMTP id 87119CE1AC9; Mon, 1 Jul 2024 19:27:14 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id AC91CC32786; Mon, 1 Jul 2024 19:27:13 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1719862034; bh=KZDwSh9p7bgKe4AljWzfhXg05QxoAGNbBrR/qAsRtMM=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=acEBW/CfXYpxJ7Qs4Hki2GqyCzUUrPw4pqEv3Nlh57QhGTmKz28R5rbpX5MY2czmS q9DDEMMHeykfSZN5ecFSIgfCjSl8dMqFEawJFaG/X2Rx6omwQBB5WjyJB6jmvfaZhf vBg8NNBZijEK6ydJeaz7l7CgJyXoA/OF3cPuLhNrTf+Ioml4t7W/SsHyA0XiqZEqnu 8uQ/n/1WNwUKR2oGEji4eLpUyXjY92uWAdBU7b5ka9byhyJN/Pw+2ppDu/1R9GlcF9 v/kmZGNwOf62Pl3G8xNksQuc3hf3pcoHdh7Eg68z/t9/Ei9NrmTWc5vBBCNR3EXPVb qJf9xR92LDAbg== 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 4/9] Docs/mm/damon/design: add links from overall architecture to sections of details Date: Mon, 1 Jul 2024 12:27:01 -0700 Message-Id: <20240701192706.51415-5-sj@kernel.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20240701192706.51415-1-sj@kernel.org> References: <20240701192706.51415-1-sj@kernel.org> MIME-Version: 1.0 X-Rspamd-Server: rspam07 X-Rspamd-Queue-Id: 5E26A1A0008 X-Stat-Signature: bimuztxzz8ci3hijuf3m54kh4rueopyd X-Rspam-User: X-HE-Tag: 1719862036-537129 X-HE-Meta: U2FsdGVkX1+sqkOcWWSoSbMaA3iBBts1m3BTorzuNvexZuCCgV9fdTONbBd0gvPOBU0jQAEZs8D00rdCMrD3DZQs2KimIh4MZ7guqZFdrNWzjhlFJaaAMN0loRVexPtD4vONnJAkMEK3KHej7nDnpgG1XP5JDdSZpEs+6Pv1YrqVEPIPQIeiYz2Pmx3N+1FpEpZcYy+FVlMfuFydZiGIfaN04v6ElO+0h8O2zUY4/E4sKtsBjIT9sYd+46XfTMV2FY21PcXTlm/48rQH9SvNMqtiWc+FK1/o9kvIpbRwjGqOlcS7TukFl+OEsDh4dudWxXAb3ouLvc4Q3Bjd28YMSXK6HvMGcFKQ510ecVNFGeFaaHK0RjTg9poRcfHnnHD3i/mYliGmyvy/Z2txr4Q8YG4gczEs7Dla5I3xdCwaWgZqgTwaEmXgsV+H7o9WtpRxoSfFxZkjBOiwyF09O/Ac5tY/XFOhL6tZUtNLXNPXpHRPCr0IXakdB8uszPoF7ZSisgt22wTh9T/gy0A/UuenaPmCsTb69SCM4y+iJP+KJOj1WYWrZZlSw9tZojnnb4ZJT3YaV3D6OrI1yIFtOSTgQJoLpzwvHwkiaO0SAR5Sc3BMRPiTgjqGLcu72Du+AErs2a7gBkrQsdqbgXWa4qgQWBQ1DmOn4VmZeZHq6tppI4kvlzspvSCBcwSLGY2J8JIpDKnYqWglXod15+BYYAKyX/FqNAYXfeTTLAsY3hHl+p0Nyk5gWBHAO2sIyYE6nLO6cVBuqTBep0wSJyZf9Z/u4+keS5LSTu9942LVSxEtZnUGXsUyQpVYp7EoeUWt90HJx+ivpmHawbHpaigQkGil41l2DJ7pXBHpYMWV8BZIc93L3dG/iEd+BgzgZtVSMdAKpf7p94H+faW9jixyc9T4kz8rkRUGO67ijIByJcfeLhMyW10bQ/aKxLeu8V6T9HSbJkbQB6nOupBgWFLGHUH ooRPvbg8 6kDBtBRU922HpJtXh09oM0Bu2KrnNfobGO8cDvDgyghu+7KZULG8QPHVW9YENUc8QP4DfwYD46nFq2ENtx7ZweDqBNVZiomROEH+csKq67YiKI7QsswSjS5RDpCKlsaGL7V5nAsn2UcWe01AZND4UN++axBiodmWukUtCCjlRQKx86NKZO2/ialEW4JIKlOfRnH2sdgSv4H4iGtaSslckIJhXQF6f3tbuv3WL7F4biN08eDBvuAq88jCvmXUE5Id8lvR+e7b7LSURKWc= 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 design document briefly explains the overall layers architecture first, and then provides detailed explanations of each layer with dedicated sections. Letting readers go directly to the detailed sections for specific layers could help easy browsing of the not-very-short document. Add links from the overall summary to the sections of details. Signed-off-by: SeongJae Park --- Documentation/mm/damon/design.rst | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/Documentation/mm/damon/design.rst b/Documentation/mm/damon/design.rst index fe08a3796e60..991839200f80 100644 --- a/Documentation/mm/damon/design.rst +++ b/Documentation/mm/damon/design.rst @@ -22,13 +22,15 @@ Overall Architecture DAMON subsystem is configured with three layers including -- Operations Set: Implements fundamental operations for DAMON that depends on - the given monitoring target address-space and available set of - software/hardware primitives, -- Core: Implements core logics including monitoring overhead/accuracy control - and access-aware system operations on top of the operations set layer, and -- Modules: Implements kernel modules for various purposes that provides - interfaces for the user space, on top of the core layer. +- :ref:`Operations Set `: Implements fundamental + operations for DAMON that depends on the given monitoring target + address-space and available set of software/hardware primitives, +- :ref:`Core `: Implements core logics including monitoring + overhead/accuracy control and access-aware system operations on top of the + operations set layer, and +- :ref:`Modules `: Implements kernel modules for various + purposes that provides interfaces for the user space, on top of the core + layer. .. _damon_design_configurable_operations_set: @@ -140,6 +142,8 @@ conflict with the reclaim logic using ``PG_idle`` and ``PG_young`` page flags, as Idle page tracking does. +.. _damon_core_logic: + Core Logics =========== @@ -512,6 +516,8 @@ interface, namely ``include/linux/damon.h``. Please refer to the API :doc:`document ` for details of the interface. +.. _damon_modules: + Modules =======