From patchwork Mon Feb 19 19:44:28 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 13563018 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 EA06CC54764 for ; Mon, 19 Feb 2024 19:45:22 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id AE32A8D0003; Mon, 19 Feb 2024 14:44:51 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id A1BCF8D0001; Mon, 19 Feb 2024 14:44:51 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 86DA18D0003; Mon, 19 Feb 2024 14:44:51 -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 7455B8D0001 for ; Mon, 19 Feb 2024 14:44:51 -0500 (EST) Received: from smtpin19.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay03.hostedemail.com (Postfix) with ESMTP id 45A92A0450 for ; Mon, 19 Feb 2024 19:44:51 +0000 (UTC) X-FDA: 81809581182.19.62363E8 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by imf06.hostedemail.com (Postfix) with ESMTP id 83A9E18001E for ; Mon, 19 Feb 2024 19:44:49 +0000 (UTC) Authentication-Results: imf06.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b="aCReNk/o"; dmarc=pass (policy=none) header.from=kernel.org; spf=pass (imf06.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=1708371889; 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-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=EhCmKs8/QhIiXHvZ4tYCoFVORO+R9k7JihDJpv78Jwc=; b=TO5otTtqEAO0jf5zSY6YOvCq94/9YZkBIBh67UGEY/tABKQTMWAIvXQNLK3/LFsbMHG9EM jXgVplVv24K7m8f2b53lEFuBlcXkWhOeSTO2WGEL2CDtgwnR7i2x6CAyyOJHVBi0Z9t0jf P5HnIPLVltsdEtL9oApED8+sUqRrwys= ARC-Authentication-Results: i=1; imf06.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b="aCReNk/o"; dmarc=pass (policy=none) header.from=kernel.org; spf=pass (imf06.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=1708371889; a=rsa-sha256; cv=none; b=pWN9OjTH5uwyhhHXGhD/EsZoBMluF1WG/Fiud0JbuRy6tLObFS1stdXghgvV9k1b6mJdL1 ao1sCa8NqSOxYBmgI2qUEcryZBzJUBDR1YK7VCxnxEArgz8FRMvNQEM3YmlRekcwXHsvM5 c5+5Kss1Lzh4UGcOIORUwN0PZJ/Mf2c= Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by dfw.source.kernel.org (Postfix) with ESMTP id 41AA660F77; Mon, 19 Feb 2024 19:44:49 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 87A6DC433C7; Mon, 19 Feb 2024 19:44:48 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1708371889; bh=on8Lep3AS4Mtk6AjiPZh/C8TU3CHqMgnp8c3zsc3Iao=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=aCReNk/oosprUvxML+loGz5WEl3Ex0wq8loimKpYSK8vC0StgTzc6hzZtHhrVpWd+ me+a2u1A2eOPZrePsH9WPL1k2OS8p8XMl2saSj+BmYT3t6QBHa+T0pb7ZfAlzCvrk7 gA6aUzkKjMNrH76IFAPd0BaiuojxtgycMnw8vDjd8Vyj4MbrA1ejTXY7slYrRDLE8c MgPkImBcgWOtQ49mT8xulLK8eeMQ6OytjD582dPstYkeDyokYl/YmwJ0jIILgvYZwL DlFu3pE/pVPe/hLKevn9ubaCmAWtyDdVO+9RXbtJrdpoVlzCFwt9KG9NjcHwEW/F3b PuXS69mZlmmzg== 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 17/20] Docs/admin-guide/mm/damon/usage: document quota goal metric file Date: Mon, 19 Feb 2024 11:44:28 -0800 Message-Id: <20240219194431.159606-18-sj@kernel.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20240219194431.159606-1-sj@kernel.org> References: <20240219194431.159606-1-sj@kernel.org> MIME-Version: 1.0 X-Rspamd-Queue-Id: 83A9E18001E X-Rspam-User: X-Rspamd-Server: rspam05 X-Stat-Signature: ttppqkzfhxxmhnpe7xj3kjaf6d6y7fn5 X-HE-Tag: 1708371889-903601 X-HE-Meta: U2FsdGVkX19PFyF4wMgakvCN0d9iRxqQzEVx3fEodkYkwxGdliy4b5I5TctI0qvOpnUq3YbUFsLd/Si13ELhBFaj13C7XsSOQELT2RltJIywAsCWA11RNpMi4meoonnI8I351LVXIHPByrDrTL4X1D0/UjLIvF76/lc2ILwmvFAz7PttawbeKBVpSb/RYoF8ocmGj3WcEDR6IL1fKhWHFPLQTP8oAD92ih6VVp6kXCJ88VnXcOZZpgZA9aOBPUHGLNR1V7VEKGDeX6hrThou9mLgtbVfdnemRtIW3qLrSLsYpe6zghOwkYLaS8CMeLv4aLgRzWaxLLbCabgRj/a6ruWppK+aUPoTCzA+L/F7N9yXNvCHK5pAVcaNIvt8sIeeoBLs+WjR0PAL8yTIgJO7Gjf4S28pdGSNhiM5oQMqyt5T/4zuhWGCDbpOXkdLaZbJHz2uQa+qiXmIzL59a+jXJUBjEgQ0a7Of0jRCls8HTdth84VdLE6vC9NuoQt7JsLXj1T5JHUgr+N/k2pCyI6D0gEO2ecaeRhd60lsjdBnoLQaIKCO5GML75EwzUj3fanyCUGcZWd1dRp8cdnR9uQ1U9mSRw8E7WW/C+cML/TFEUzL1SfHKC+4z4hGcVoFlzmvsmSWlRsZPoibAZrR3wXXaQVznYLHAgImPckZ6OA+IRF4vcHi7ZjlKBjDvCja2dmFw7yp4XWD26SZ83QneAgbks5+P8HircEcGMDfU3XwUMAUlnMQ3/aBDx03NE3vAsSHANDiCAOEQFhcFVmtVuBhOrRauSBjUGN1XJlTKt4OR8KtyeM5bMLXHiwnzoRa1bTKthfjS7QngghKPjXKb7cEJR9GN2h72GwGVtTTAt1IpA10vImkf14hZjoxR0/o5NL/1TsT3Z59RNdt7/ce4ej3cZKgCbzI71YI1Wy9tPLWlH1gmq/wykOMgXHt7bVdMEukw+/0SWbHNS44tLd+CAu SBzIQJYy 0+tHJseHaQIedrsoRTdxMrOLs14smLFkSwvfOjfZ0iBsQeKtXETqk3u/Oq9OnGfPU3G0JhfbWuyNHEKb7AWLjEtjBSLJqtEBL38A7eVJ25UuuiiSN6jL3rzAJEcB7f2R9AhOII5V2iBKppDUbaKIkRh0bE8GimQFGDb5eYNkrnhCyeRUi1CH5Au3HLKyCRvjPOVLVwXclZijJxGdUCEpyVHAcNOOzi11W8n79OiPEVwegQvQY7Mg8g+q9zE5Rmu6WMm16REgpPRIM+mK7bTXDm0G9M/QvsgJlloG/ 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: Update DAMON usage document for the quota goal target_metric file. Signed-off-by: SeongJae Park --- Documentation/admin-guide/mm/damon/usage.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst index 220ebbde7324..b33eecfd0e90 100644 --- a/Documentation/admin-guide/mm/damon/usage.rst +++ b/Documentation/admin-guide/mm/damon/usage.rst @@ -86,7 +86,7 @@ comma (","). │ │ │ │ │ │ │ :ref:`quotas `/ms,bytes,reset_interval_ms,effective_bytes │ │ │ │ │ │ │ │ weights/sz_permil,nr_accesses_permil,age_permil │ │ │ │ │ │ │ │ :ref:`goals `/nr_goals - │ │ │ │ │ │ │ │ │ 0/target_value,current_value + │ │ │ │ │ │ │ │ │ 0/target_metric,target_value,current_value │ │ │ │ │ │ │ :ref:`watermarks `/metric,interval_us,high,mid,low │ │ │ │ │ │ │ :ref:`filters `/nr_filters │ │ │ │ │ │ │ │ 0/type,matching,memcg_id @@ -366,11 +366,11 @@ number (``N``) to the file creates the number of child directories named ``0`` to ``N-1``. Each directory represents each goal and current achievement. Among the multiple feedback, the best one is used. -Each goal directory contains two files, namely ``target_value`` and -``current_value``. Users can set and get any number to those files to set the -feedback. User space main workload's latency or throughput, system metrics -like free memory ratio or memory pressure stall time (PSI) could be example -metrics for the values. Note that users should write +Each goal directory contains three files, namely ``target_metric``, +``target_value`` and ``current_value``. Users can set and get the three +parameters for the quota auto-tuning goals that specified on the :ref:`design +doc ` by writing to and reading from each +of the files. Note that users should further write ``commit_schemes_quota_goals`` to the ``state`` file of the :ref:`kdamond directory ` to pass the feedback to DAMON.