From patchwork Thu Sep 7 02:29:23 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 13376098 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 0D9E0EE14D8 for ; Thu, 7 Sep 2023 02:29:47 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 5BB1E28002A; Wed, 6 Sep 2023 22:29:44 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 542C5280029; Wed, 6 Sep 2023 22:29:44 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 3735C28002A; Wed, 6 Sep 2023 22:29:44 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0011.hostedemail.com [216.40.44.11]) by kanga.kvack.org (Postfix) with ESMTP id 10060280027 for ; Wed, 6 Sep 2023 22:29:44 -0400 (EDT) Received: from smtpin23.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay01.hostedemail.com (Postfix) with ESMTP id DB22A1CAD28 for ; Thu, 7 Sep 2023 02:29:43 +0000 (UTC) X-FDA: 81208220646.23.F00D52E Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by imf11.hostedemail.com (Postfix) with ESMTP id 4A25A40007 for ; Thu, 7 Sep 2023 02:29:42 +0000 (UTC) Authentication-Results: imf11.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=e1aBIvrV; spf=pass (imf11.hostedemail.com: domain of sj@kernel.org designates 139.178.84.217 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=1694053782; a=rsa-sha256; cv=none; b=hVgB0rgrnjN3VjLp80jnIv/SI4Hr0CURnwD5i80c1InXVvMvMW7oAgYmhCLiyTfpjqEZXU 6cfc43mbO0xnObwkg2nZyLitFla1Bqer6l3bCzSKrIQ3x+pQR6habRIvs4Y92wFjXnfObM YbirsH8LEyu9UdX24P6gjLkR2UxgwsA= ARC-Authentication-Results: i=1; imf11.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=e1aBIvrV; spf=pass (imf11.hostedemail.com: domain of sj@kernel.org designates 139.178.84.217 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=1694053782; 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=WTLK4j9PrIQ0ettyDfx41Rnu2+T/YaiCbqhNgxLxtuA=; b=pi8QATltECuVCRZteiQ6v1ICOl/reSxTtc2z5QgxMcIIehnmoLlVwjZw4gzeQG4yc0llOK yIGM8MBd99Y7ZLibnYTxlJvNBXn4SuTZt0h3liDU8unIve0hXEUGxmnywyIqPPaD9PwLfR CQLjEYXFW+Hm5HFFjBLBIr8IOa8PL0Y= Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by dfw.source.kernel.org (Postfix) with ESMTPS id 6A5C361191; Thu, 7 Sep 2023 02:29:41 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id B3E37C433C9; Thu, 7 Sep 2023 02:29:40 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1694053781; bh=/4c0bNqammeumkz0XhdEYekAGWITk+eiJUgJ8I1y+iI=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=e1aBIvrVp1OYAQpfz00zRovXOneOesmUDSZyTevcK820XKsGAeBqVz+uKLkcn19ia t6iRL/0aRlSuwJh0x/3UVFXNGwBKDRIioHx4gYhpYlanDqU5oNeS/uQo/0Kf0FYlTn yHWjH8sqOnKWJtQ8ZXjS0fEpJY2oDw3OKXbcwx4Q8uXajUh3jhQ00R6lMX83jpsFLU 7qB3XGpSq8hnVEiIUFzsOtdQuhLHqy8onWed+iUqj13gYcdnfp+m/ndsdEmepn6P66 SD0M9Ouci60A3Zf8RhsozItBrOl647bJks1M3TsZTbi3TpBkLEJgMaWCHyNU2RtBuS owRht7VtaeJcQ== 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 05/11] Docs/admin-guide/mm/damon/usage: explain the format of damon_aggregate tracepoint Date: Thu, 7 Sep 2023 02:29:23 +0000 Message-Id: <20230907022929.91361-6-sj@kernel.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20230907022929.91361-1-sj@kernel.org> References: <20230907022929.91361-1-sj@kernel.org> MIME-Version: 1.0 X-Rspamd-Server: rspam08 X-Rspamd-Queue-Id: 4A25A40007 X-Stat-Signature: ayca18mtdiqp5thbprrghb7it3ke3cn7 X-Rspam-User: X-HE-Tag: 1694053782-782019 X-HE-Meta: U2FsdGVkX19IXSavnPy5gmP07h8Y3iyGtorQWywbz8AlPo+ue4cBgbGuJnkyIhnRT/j0Jy38dCi6weEo7ykOGuLfWhu1HM+pAaNgwYKGo3WkDMSmhLnAOgu2RIFdajYWSGlq/ugGn7LwnTIREmB7eq2ZDYDcFiLpx8NdxO00lizMMQWAmCWcTp23fmH4P/4l6hNHp+GrY/QJqOZLVDCaggjOhkn5usUymdoGgy+JmdCAll6rn2SbhftJuCjdJ3BtJpByh38bdRIw8Mik5smE5Fu4ZWeMp8iccR9Zt+cvqn7Niw/l6Se5yRfTWnADc220I0BiB8Bsa4kx2a7bDg32jCeRf0NLaO2jVplg011p1FluUtXlYavRX36UT3+IZZ0INX/FV5ZjRnKtnOtdJSQttze4oAKEwTxK4ZRqt4euoTIJEvldJcht4ej5GxOY0sNfcZsbNbvpKkGrPK1NdgrIyNYm4fX7S9Rm1alfD5KOyWfJs79at56a3sLKK46ZF1vW3DATV3AtU1PkRx4pxqvZDu5XDopzo5W8Qo5yr/cHcdISHMlQ6kYDnUuQ19kOHGv5bC0VZ1AufA0FssynMMEuqextfKdhqo7L3owi3+ODtKZCWNp/oMuDUAPm3i6e6naQiaUOczsCrhsWJodyOe8XXk1xt6OfvKst7fXhbQL2LcNEqujjWhIBCrZC8hIKPlATSK1BGfCmSap2Zl5viHwFcvboATqqoRoUfIeeoh7Uh5I3PoacyvItjRnMX3MdQpOk98L85VfYdwWC7wfvVvC5p1TmagCgbh54zauJp3CG2/Yx0L2PbmZu+YgBePu0jPfovXP+BSJQVAirGSuU+hb1mkVOC67zD6gZTP5Eo/j8WR39HehL77ouX4UDUHq/HkoMcnfopsY/eROqEyO8P6EbcPC2zl0BGd2NWyyyEOpTl/ftYnIMLat6PqCWWjijBWknQmceEjDQh5a7DbirjjL sbpaoLw/ bnA8piQRjhopTyl/ZILQVPPTA3vAd1X/4TO7HJagtmxityJe62JrnZ5IFjO3Y4UzHDcwpIOz0jmv5SXmI8WJMrEDn0qC9XvZkLU7lfYD+QQ3LdF+SdvkpPlmdUPcLxTyK/WEspzAsK0dsIu6YNcVaxByxvIf9VhuYOhFsaAsPPd97ULJQT72IRNXM9nFc1DWQyDtKLRT2GCuHBv3jm2gVs2lOccZ1zQ7IPobhCmUCrC6v+8xzKhYLTUrkqHFIDfVFm5CUGsaehV84SrCtTsN/XGzvhv5I7Q6UOMoVHpM/ha7xEh7fP3s0Zt6ombpFgrAUGoqz3la8Rz1vZpd7xDQnaqW3H5m7RszKcA4CdE1q/IXJYHlfG33iyAw0NBXRt5EQ3aVZq3sU7u7lPnOn/Kn9MaO0bkUYHeX+/pKW X-Bogosity: Ham, tests=bogofilter, spamicity=0.091820, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: The example of the section for damon_aggregated tracepoint is not explaining how the output looks like, and how it can be interpreted. Add it. Signed-off-by: SeongJae Park --- Documentation/admin-guide/mm/damon/usage.rst | 14 ++++++++++++++ Documentation/mm/damon/design.rst | 4 ++++ 2 files changed, 18 insertions(+) diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst index e48101c777e1..758575d33ab6 100644 --- a/Documentation/admin-guide/mm/damon/usage.rst +++ b/Documentation/admin-guide/mm/damon/usage.rst @@ -513,6 +513,20 @@ results using tracepoint supporting tools like ``perf``. For example:: # kill 9 $(pidof perf) # echo off > monitor_on # perf script + kdamond.0 46568 [027] 79357.842179: damon:damon_aggregated: target_id=0 nr_regions=11 122509119488-135708762112: 0 864 + [...] + +Each line of the perf script output represents each monitoring region. The +first five fields are as usual other tracepoint outputs. The sixth field +(``target_id=X``) shows the ide of the monitoring target of the region. The +seventh field (``nr_regions=X``) shows the total number of monitoring regions +for the target. The eighth field (``X-Y:``) shows the start (``X``) and end +(``Y``) addresses of the region in bytes. The ninth field (``X``) shows the +``nr_accesses`` of the region (refer to +:ref:`design ` for more details of the +counter). Finally the tenth field (``X``) shows the ``age`` of the region +(refer to :ref:`design ` for more details of the +counter). .. _debugfs_interface: diff --git a/Documentation/mm/damon/design.rst b/Documentation/mm/damon/design.rst index 5c465835a44f..51aab9b0621a 100644 --- a/Documentation/mm/damon/design.rst +++ b/Documentation/mm/damon/design.rst @@ -154,6 +154,8 @@ The monitoring overhead of this mechanism will arbitrarily increase as the size of the target workload grows. +.. _damon_design_region_based_sampling: + Region Based Sampling ~~~~~~~~~~~~~~~~~~~~~ @@ -191,6 +193,8 @@ In this way, DAMON provides its best-effort quality and minimal overhead while keeping the bounds users set for their trade-off. +.. _damon_design_age_tracking: + Age Tracking ~~~~~~~~~~~~