From patchwork Wed Sep 13 02:20:50 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 138927 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:9ecd:0:b0:3f2:4152:657d with SMTP id t13csp1204132vqx; Wed, 13 Sep 2023 09:26:07 -0700 (PDT) X-Google-Smtp-Source: AGHT+IGwIMKvJyOwusBme00VS49ZW84jPCUJqkbM/VJDKD/IIjYWuzH6UFCcPsrwS+b3bb5Rlu7r X-Received: by 2002:a05:6871:1d2:b0:1b0:189c:87a0 with SMTP id q18-20020a05687101d200b001b0189c87a0mr3255667oad.41.1694622367122; Wed, 13 Sep 2023 09:26:07 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1694622367; cv=none; d=google.com; s=arc-20160816; b=YHLJgUGIVDvfje4r/L9xw3xTZgLjftPLEf5VJU2ArYesGh7ix0qtToFx+OshXhnTSf /ykUzQX/toHrTfmeUamJcGZAxdDBW2U9ULp09j45fvzxGsauRa3A/WdNCOaw4kylFdAs d5sN1FKJhhBo40d/LucshueXLV/M1snpwMk2KMch6dOXTtzpweDlCuurmjE2EWLNMzDm CoSq/uVvi59R958FtN9GfP7L/6G8qhq/g4Z1N5tPZHKKKkiixM8MLcfzMYYBfj6W+oR4 ZLk2e5zYEI8N4ljhLjEZQHUSDA0ZoY+syClJEW+Hqptg8NmaUxWEpA01HclZX3z2BiLd SaIw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=uOx8ScWSHBi0cBUuCTXtnmBmYJYt+uGhSfTmXKZCMoM=; fh=jKijsxc1Z2CHKVFf4S4lB42jMLcn6gTpewOn4Tq1/VM=; b=xrXRSIy4jEJpRqIKJCfMcpe8LPt7Qvboxbh11+6GGJF0bCPHEk1YDBjMA+69GWseVy 09hR71HEaeHIeOzc8nzxMSUKkCHIlMvnAiRxE0v75ok+RE6xYlzUrTi3/qV728mNlLOf 4sSvoInSxAcpkGiW5QEYCcH9ZH1JrrSbre8qjsP8jAkSw6iXQWdB9ptYb6pI7uFE2W/j 3ouCrL3jchP7hIu8uUZdN1rZerfsoszv3b0s+5eRNp6CBiGvitluIauvTZGRWjIJUF2u fBEtQspZFjR9Zg6SZsfIZMpJY74hhiSmMzUX/N/rUI0l/Z/cw2FPpYq8Yi72VmzDoiYM TFsA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=G+l4nTmJ; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:7 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: from snail.vger.email (snail.vger.email. [2620:137:e000::3:7]) by mx.google.com with ESMTPS id b19-20020a63d313000000b0056476f15584si10762932pgg.541.2023.09.13.09.26.06 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 13 Sep 2023 09:26:07 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:7 as permitted sender) client-ip=2620:137:e000::3:7; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=G+l4nTmJ; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:7 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by snail.vger.email (Postfix) with ESMTP id 9D6FE818908F; Tue, 12 Sep 2023 19:21:09 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at snail.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238176AbjIMCVG (ORCPT + 36 others); Tue, 12 Sep 2023 22:21:06 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:59654 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S238166AbjIMCVF (ORCPT ); Tue, 12 Sep 2023 22:21:05 -0400 Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 1242E1716; Tue, 12 Sep 2023 19:21:01 -0700 (PDT) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 2810DC433C8; Wed, 13 Sep 2023 02:21:00 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1694571660; bh=yCdyENSSr2jBoqcU5uuhQp9Eg5ZiZzpyIfgAEWQFG08=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=G+l4nTmJpLTnnS7zeMq7sUR0wx9A3+mSu7hZCG0AI8qsphhiKn/LA+9HqEahsbJkW 0VIYo5N/jkiNWdz5mJ70XL49dQ1xejMgCB+uYW73vVraKzDPiM3zegf5Y/bgvYN7IZ GFK1gmEqs8YH7k18ckYgFZfPa9qs/iuxvztNwWFzkudCTmJxoaqxbL2/lTf1DP9WWV H5iXINSUW0dB57rg3MTW4mQnxqtXQMBWidwbBIrWXua4awmxZq9qLDfCQrCqK3P3wK uKb+G+s+SL95eFpdJuOuJMiT5S4CRPUVwuI/bAZipHgcHpNPnNf8KjGOw7iRv3DTw1 rjAKkU//Pz6RA== 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 RESEND v2 2/2] Docs/admin-guide/mm/damon/usage: document damos_before_apply tracepoint Date: Wed, 13 Sep 2023 02:20:50 +0000 Message-Id: <20230913022050.2109-3-sj@kernel.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20230913022050.2109-1-sj@kernel.org> References: <20230913022050.2109-1-sj@kernel.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (snail.vger.email [0.0.0.0]); Tue, 12 Sep 2023 19:21:09 -0700 (PDT) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1776940342887355303 X-GMAIL-MSGID: 1776940342887355303 Document damos_before_apply tracepoint on the usage document. Signed-off-by: SeongJae Park --- Documentation/admin-guide/mm/damon/usage.rst | 37 ++++++++++++++++---- 1 file changed, 30 insertions(+), 7 deletions(-) diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst index 282062b6f134..6272cd36590a 100644 --- a/Documentation/admin-guide/mm/damon/usage.rst +++ b/Documentation/admin-guide/mm/damon/usage.rst @@ -496,15 +496,24 @@ the files as above. Above is only for an example. .. _tracepoint: -Tracepoint for Monitoring Results -================================= +Tracepoints for Monitoring Results +================================== Users can get the monitoring results via the :ref:`tried_regions -` or a tracepoint, ``damon:damon_aggregated``. -While the tried regions directory is useful for getting a snapshot, the -tracepoint is useful for getting a full record of the results. While the -monitoring is turned on, you could record the tracepoint events and show -results using tracepoint supporting tools like ``perf``. For example:: +`. The interface is useful for getting a +snapshot, but it could be inefficient for fully recording all the monitoring +results. For the purpose, two trace points, namely ``damon:damon_aggregated`` +and ``damon:damos_before_apply``, are provided. ``damon:damon_aggregated`` +provides the whole monitoring results, while ``damon:damos_before_apply`` +provides the monitoring results for regions that each DAMON-based Operation +Scheme (:ref:`DAMOS `) is gonna be applied. Hence, +``damon:damos_before_apply`` is more useful for recording internal behavior of +DAMOS, or DAMOS target access +:ref:`pattern ` based query-like efficient +monitoring results recording. + +While the monitoring is turned on, you could record the tracepoint events and +show results using tracepoint supporting tools like ``perf``. For example:: # echo on > monitor_on # perf record -e damon:damon_aggregated & @@ -527,6 +536,20 @@ counter). Finally the tenth field (``X``) shows the ``age`` of the region (refer to :ref:`design ` for more details of the counter). +If the event was ``damon:damos_beofre_apply``, the ``perf script`` output would +be somewhat like below:: + + kdamond.0 47293 [000] 80801.060214: damon:damos_before_apply: ctx_idx=0 scheme_idx=0 target_idx=0 nr_regions=11 121932607488-135128711168: 0 136 + [...] + +Each line of the output represents each monitoring region that each DAMON-based +Operation Scheme was about to be applied at the traced time. The first five +fields are as usual. It shows the index of the DAMON context (``ctx_idx=X``) +of the scheme in the list of the contexts of the context's kdamond, the index +of the scheme (``scheme_idx=X``) in the list of the schemes of the context, in +addition to the output of ``damon_aggregated`` tracepoint. + + .. _debugfs_interface: debugfs Interface (DEPRECATED!)