From patchwork Mon Jul 1 19:27:05 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 13718591 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 BA245C3065B for ; Mon, 1 Jul 2024 19:27:37 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 8BDA06B007B; Mon, 1 Jul 2024 15:27:22 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 846026B0089; Mon, 1 Jul 2024 15:27:22 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 698D16B00B8; Mon, 1 Jul 2024 15:27:22 -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 4401B6B007B for ; Mon, 1 Jul 2024 15:27:22 -0400 (EDT) Received: from smtpin10.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay06.hostedemail.com (Postfix) with ESMTP id 04322A46D3 for ; Mon, 1 Jul 2024 19:27:22 +0000 (UTC) X-FDA: 82292167524.10.E519DB8 Received: from sin.source.kernel.org (sin.source.kernel.org [145.40.73.55]) by imf08.hostedemail.com (Postfix) with ESMTP id 074D4160003 for ; Mon, 1 Jul 2024 19:27:19 +0000 (UTC) Authentication-Results: imf08.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=IXU6KryR; spf=pass (imf08.hostedemail.com: domain of sj@kernel.org designates 145.40.73.55 as permitted sender) smtp.mailfrom=sj@kernel.org; dmarc=pass (policy=none) header.from=kernel.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1719862023; 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=5mZTw5XE+p6OCl5aq4Od67KjaMSKg+HsSzZk6Srpsck=; b=OGfHAVOe0XvZJW/1ExpHss9V2YrYJn51eZuMpmWZeE+I/Jcnn60iFs1OWdRqkfs6KHUcFB t5wSirEYVR7kK7MQ86rfxMvun8QcMu1ZPWyvifqIctkFTvX0mr+1Vr0wD4SCsKxJNOT70b BLRe20h3yVxIzHozkWRNrZ8rJVSVd7M= ARC-Authentication-Results: i=1; imf08.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=IXU6KryR; spf=pass (imf08.hostedemail.com: domain of sj@kernel.org designates 145.40.73.55 as permitted sender) smtp.mailfrom=sj@kernel.org; dmarc=pass (policy=none) header.from=kernel.org ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1719862023; a=rsa-sha256; cv=none; b=La/xPC8TnGviAuC2edJr14ZRcD2XJoXCzV0E1klwkGPbpuIoSK0TAY+WHqZp9w2Qvacpob q8SeEkQE9mGtBUur4EC5zIO1AHdmOvIPtsEDq/AAijSfPZAsxlobj4B23/Q+Yo93xmBcAO SIt0R3Psmk6qCwW6mLne5U3ICCvC5kA= Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by sin.source.kernel.org (Postfix) with ESMTP id 6D8BACE1AFE; Mon, 1 Jul 2024 19:27:17 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 9226FC4AF0D; Mon, 1 Jul 2024 19:27:16 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1719862037; bh=W9d4cUx1EjXG3O2nC/ytqNez6Roq0dChgJMH8XJ7CE8=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=IXU6KryR88jDAsOwngkduDOqIYRUMZ3Zx6gSiN32pgbA9QsG3NtQ71mfMPlhVZpsV 3DTrttmY6WafRHkIIVnDhir3Nw3hQa7//04K5Ucxf92WnBeG92/BlbHKEj+NWfv0ke nH58B14RusmqUVBu8o1UA89LsYIs441aD8Vk3PiyWsW5uegD7pPUWS4I0pfAdV5JE3 EFD+zqjVWjGWOXksvVlKhX4IRRnygeY3kA/qu8orOL3eFt1A0Bm2uxMJ3vwReE8ZBS mb68L1pa8dImiQoboeisyLrVx1jQ5NAIDEUt34bVZwS7LLEu4gPhozkKAyCLKuQDWg jtvxepdW0s4Bg== 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 8/9] Docs/mm/damon/index: add links to design Date: Mon, 1 Jul 2024 12:27:05 -0700 Message-Id: <20240701192706.51415-9-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-Stat-Signature: 9cm98ieo5e9z5pmazggkjzh6jxatokjp X-Rspam-User: X-Rspamd-Queue-Id: 074D4160003 X-Rspamd-Server: rspam02 X-HE-Tag: 1719862039-606960 X-HE-Meta: U2FsdGVkX18w4kIESPVskUGjnqm7HHlIKWff3aMHIJBMQMeHpinadd+4WWFgkn3K8LAsXpnbC87mE8UBTEkSlxO2HOcNLHQxt5TvynD4vlDQncwx02lZmJldlwFPLife62lTLsCQB6l2sqCbHO2wmf1HyyIho3WXAibRF3rWwaCwClnJXeDHVrxcXQSHBTwuSO8y3IJkdmMAK3cU0+ITBdm0YGyMeEdgCnVgKvZkqaBopxPeDz8E0G+NiT6M/ic5aOGBVlcgMdG6WkeG1okUG3TKQuU8jthTgnaBvOjbTqdqOj2z4ViVjN1fIOtroHagXXAl6xGvdaBATGiIKyRyqJA2q30HRRgEBOO/Aot/HbaOCdCA72crAzjaWlikJMpp0KXR1lQX3SFoFRdbGrPmGjirsfxhAkvVcpJ2KtADQwjCyE1cPd6agh3b2ps9hNcl0MhnlLd4aXL0lVEl1sklmRiyJEAI8gco0rKst03miB66prbdfdeBUPWQvVKsA3VGK0DxWbJiIXoizm1qsmSrsK11/+BSPaH4Pri+PMShR9kpvHYYM+F+Rv19N8oWK7JWMBXFi4jKmmNCEAXM8UK0JxWMgTRfA2oCXTHs2jgU+biDymJRH8GzUi+vQnN5l2AKG8fAiqvD7/ypsNfIDM/ah+xe8eU5O8VGrhOxmMnCB4d/q5p/q1PJ43i+eIzHUhXkWguZQJhM6FbyJREBvIC2Vm+RIv+fkZJK6q46ggMl6Nw/iuvJGiG6jwe7XFiJ14BeD54BEINqrG6Q40LC2Eiv4Yo4PB1yoiNUT5A+VbRP0kpA6Qq2bvNB6J9f3+Tq1rMP8pKIuabyWHkVk9lldh86XRqvcGOa/tUwiHaQgHIPijhjJR9j+aZiqki3F9P3GGIR4Vk3A938e7JEYnBvD8/OjjTnmB6jzsWAsf3+gyrGespXSKlZCM1TD3mEj6N1hCu+lKd5rVrNeujrNae9Zk6 HoB9Aqp/ AGgQmSmiCsZrTsNC/l5iY56ShHVWeIRtO5peSkdyIuu/kscJigIXLj9Ka9zVkqqo3cjChcksog0VemaIdAF6+puk6W4/4pIySlNkiDq0Rv1PxLvAr4psKCq8VGKqUwXIhhfkAM/8U394sCdcdbeZEAtX42QoZVqxxJYtIlJok/arSiL2TftuFPC7XQAP1E0vDOZY7B3Rw+Hqa8Pc6e3tBPG4lOJ5mgQqPdNN//I9ErilOc9g= 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 subsystem documents index page provides a short intro of DAMON core concepts. Add links to sections of the design document to let users easily browse to the details. Signed-off-by: SeongJae Park --- Documentation/mm/damon/design.rst | 1 + Documentation/mm/damon/index.rst | 11 ++++++----- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/Documentation/mm/damon/design.rst b/Documentation/mm/damon/design.rst index 89f5330e003f..8730c246ceaa 100644 --- a/Documentation/mm/damon/design.rst +++ b/Documentation/mm/damon/design.rst @@ -141,6 +141,7 @@ as Idle page tracking does. Core Logics =========== +.. _damon_design_monitoring: Monitoring ---------- diff --git a/Documentation/mm/damon/index.rst b/Documentation/mm/damon/index.rst index 5e0a50583500..3d3b345d8889 100644 --- a/Documentation/mm/damon/index.rst +++ b/Documentation/mm/damon/index.rst @@ -6,7 +6,7 @@ DAMON: Data Access MONitor DAMON is a Linux kernel subsystem that provides a framework for data access monitoring and the monitoring results based system operations. The core -monitoring mechanisms of DAMON (refer to :doc:`design` for the detail) make it +monitoring :ref:`mechanisms ` of DAMON make it - *accurate* (the monitoring output is useful enough for DRAM level memory management; It might not appropriate for CPU Cache levels, though), @@ -21,10 +21,11 @@ users who have special information about their workloads can write personalized applications for better understanding and optimizations of their workloads and systems. -For easier development of such systems, DAMON provides a feature called DAMOS -(DAMon-based Operation Schemes) in addition to the monitoring. Using the -feature, DAMON users in both kernel and user spaces can do access-aware system -operations with no code but simple configurations. +For easier development of such systems, DAMON provides a feature called +:ref:`DAMOS ` (DAMon-based Operation Schemes) in addition +to the monitoring. Using the feature, DAMON users in both kernel and user +spaces can do access-aware system operations with no code but simple +configurations. .. toctree:: :maxdepth: 2