From patchwork Mon Dec 4 17:01:06 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 13478783 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 D12EBC4167B for ; Mon, 4 Dec 2023 17:01:18 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 55D5E6B02DC; Mon, 4 Dec 2023 12:01:18 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 50BE16B02DD; Mon, 4 Dec 2023 12:01:18 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 3FAB46B02DE; Mon, 4 Dec 2023 12:01:18 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0014.hostedemail.com [216.40.44.14]) by kanga.kvack.org (Postfix) with ESMTP id 2F7206B02DC for ; Mon, 4 Dec 2023 12:01:18 -0500 (EST) Received: from smtpin02.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay09.hostedemail.com (Postfix) with ESMTP id 9C2E480287 for ; Mon, 4 Dec 2023 17:01:17 +0000 (UTC) X-FDA: 81529751394.02.30FD27F Received: from ams.source.kernel.org (ams.source.kernel.org [145.40.68.75]) by imf21.hostedemail.com (Postfix) with ESMTP id 120D31C007B for ; Mon, 4 Dec 2023 17:01:11 +0000 (UTC) Authentication-Results: imf21.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=iGvBZLtY; spf=pass (imf21.hostedemail.com: domain of sj@kernel.org designates 145.40.68.75 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=1701709272; 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:references:dkim-signature; bh=1yw+mkzZ8WSThgOMrf0SaKscIOkk2RXSkarx/JDgGcE=; b=toAL5JmEX5kLb9pkr1JQDQ+1N7arbPmtnG0UKMPc0F2gl3KLF7ULCQWjGUxTdP+N2sFwxg MebXopa9Ky+oV+ly0wSNwgP8vm9/Bgx7wKkgWAi3lq4dMN2ILPRTLmelqrNEBrz5+mfoxU XOW1Wja/nugn/axDoDBFmx0qaX9gR5A= ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1701709272; a=rsa-sha256; cv=none; b=3bfSrxDrv8AGIyB2uD+3/KHYf8EjOhKR6p7lT5nRZWTg9TABBTPF6vurt3MA4ZIXS8VKE3 DDTrMrLNKoeCLhEWvNzksRVE+aWB/GYPTYNIg7IFJnp4yo8rAqgdv3+vtncHzAADhq904K 188s6ut6bvGd1bH077RoxWLZgUx4knM= ARC-Authentication-Results: i=1; imf21.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=iGvBZLtY; spf=pass (imf21.hostedemail.com: domain of sj@kernel.org designates 145.40.68.75 as permitted sender) smtp.mailfrom=sj@kernel.org; dmarc=pass (policy=none) header.from=kernel.org Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by ams.source.kernel.org (Postfix) with ESMTP id 41178B80EE6; Mon, 4 Dec 2023 17:01:10 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 0F5F8C433C7; Mon, 4 Dec 2023 17:01:09 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1701709269; bh=PrQN3LxsLo0hnYtX+mHxOw3BE7UQ018hcELFYEAwoxQ=; h=From:To:Cc:Subject:Date:From; b=iGvBZLtYs7yHtlLTahRlEyaMg77PkPNKCUnY79j+4a+CQ0rzo/s8oWQILhuPdvPah DXg32bDyS/S+oRwZ/rTx+ePKScRNqgIcPlsFAlXdMrwxfzGqc/48qdxze/hx9zZHv4 FfghEKC/+5gGgaUZUYSWaVNMcBHvC9WDKTVAyXUxCVQle9dgrLwZnKVMwRjumzvyKy HbwQ/G80otDrUBS13rwTJK+5hCsXWO8VYjkXJ2AmSvqeNrKo26vG+Mbn2ej+ak+6lJ PbYedmzbC9cXA0f/a4J9cx2Kos0QLDzgLekg7WZItSI4QvlSTYhLxm1CwwCc8yiVcC BIrLl4SrYaj5Q== From: SeongJae Park To: Andrew Morton Cc: SeongJae Park , Stephen Rothwell , damon@lists.linux.dev, linux-mm@kvack.org, linux-next@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH mm-unstable] mm/damon: document get_score_arg field of struct damos_quota Date: Mon, 4 Dec 2023 17:01:06 +0000 Message-Id: <20231204170106.60992-1-sj@kernel.org> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 X-Rspamd-Queue-Id: 120D31C007B X-Rspam-User: X-Stat-Signature: n54pdwuexg59h59is5axb3jdu4fgjm9m X-Rspamd-Server: rspam03 X-HE-Tag: 1701709271-732781 X-HE-Meta: U2FsdGVkX1+vrFoDY0OupjhxfZhRLgi4CGIl7CgTSvwgGuVds0kVK2eSzN8oue+qOfQwJxuqOKPp8W34k/jNei57KocjdOgAhqNHEwwQM4mFjFAx1GwXFysnQ3qxG72kwmg1zskOVO4WSXRSt7N94sYRjvEg3ki+k7eLrbdX2Q1dFfbXo66KbuRFf+Zfqm7Q2r61gmjeojNvhUTtZPHFv52/+JpmAqRWNawBZ5nzPNqcePIoNFoDBj9TC+HK6bxVcdGvTEMTWRKgFSBpj19NyvAL/l2o5VJYcTU5yvpNUhYF2zKF8OTqyY2x4iRJ+ZlhFaZ3ND8t3Ku/U8xSw4PV9a8DkqZ2qxkH4yPoSC/JcVLH3q4EHw73WPbrJCr2lCAyca7ApSlm03DVBngOt+qzL7vnowGQHolrrxJidh96MAwwezvILnIq4AnDk1cGnBtAolUl6gVgY5bUuG/Bp4HeGvDQ4wa4BkVFZrq1CiN839HPUrLsVAY/0lrn4+nENlUmUQP9idp4PVDqyBOoyOYHt7dG3i6ivThler4QoGxTDM9B4q0fBZIswncBXEk1zrWREKkbEK42aVCOpZU9TWa0jg767FZZQKvrPbEJQe/87YLMk2NWHSnZdjvPGinhniqTMmB5UN8RFme6aVtqbrUdYO6QlknhcLssEI96vSU4eCWnHvYz6WMgbt46Izutq/GSA8C2kwVzC+Z1RLS5aT8oyb38AouB/kRloSJeuZEIEx2gZpTR94ti72FzYM+ObQSam7gKc3UbUkErPhOhTxnJQFqg6TlNYmE/yysmWh3bbRCVbCSmLNVUGk82mcfndD2hUDjXwZy92FUDqy8w00zUXqOc09h89gEj9poPjHe82TxRJkPW7pFXtLsihRxkZ4Amsm6XefUJSjT7NaomMhmWoN8YLO22m4i+znyr4J59uUby1MfytCv2t3qJSO2AM64J7WNfep5YycUdKP3uccX MLCHuKJ5 gcnvtritnsY1qfC0HdU+FpMcNr3wl3jnQgf507FOC9nJf5CO4Vl1FEUtGLB7YvWWtPJlUPdYINzhictIj9SjV9vLG+zotd1NKQsaT4DOCd3k9BFGj1N6l3o59LSyrCWidJo65cLp4ybYnYV1ABKz6Cj2lDAGUbDA0Y0hFIqux+gZn7sz7w0G0YgUspd6+L/Q4lUbq0YUOxwtxZOLlh7YGXDEN2jaqDVkvpJDPkY/EyXfzSZ0RG2bry6LSk+dybJZaCasQLor7+zfu4aeT3ljZ1K2pPDzM0cuYkecA X-Bogosity: Ham, tests=bogofilter, spamicity=0.000189, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: List-Subscribe: List-Unsubscribe: Commit 99b36eab9c05 ("mm/damon/core: implement goal-oriented feedback-driven quota auto-tuning") on mm-unstable missed documenting 'get_score_arg' field of 'struct damos_quota' on the kernel-doc comment. Fix it. Fixes: 99b36eab9c05 ("mm/damon/core: implement goal-oriented feedback-driven quota auto-tuning") on mm-unstable Signed-off-by: SeongJae Park --- include/linux/damon.h | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/include/linux/damon.h b/include/linux/damon.h index 508a262418a2..aa34ab433bc5 100644 --- a/include/linux/damon.h +++ b/include/linux/damon.h @@ -137,6 +137,7 @@ enum damos_action { * @weight_age: Weight of the region's age for prioritization. * * @get_score: Feedback function for self-tuning quota. + * @get_score_arg: Parameter for @get_score * * To avoid consuming too much CPU time or IO resources for applying the * &struct damos->action to large memory, DAMON allows users to set time and/or @@ -156,10 +157,10 @@ enum damos_action { * &weight_nr_accesses, and &weight_age, because monitoring operations are * encouraged to respect those. * - * If @get_score function pointer is set, DAMON calls it back and get the - * return value of it for every @reset_interval. Then, DAMON adjusts the - * effective quota using the return value as a feedback score to the current - * quota, using its internal feedback loop algorithm. + * If @get_score function pointer is set, DAMON calls it back with + * @get_score_arg and get the return value of it for every @reset_interval. + * Then, DAMON adjusts the effective quota using the return value as a feedback + * score to the current quota, using its internal feedback loop algorithm. * * The feedback loop algorithem assumes the quota input and the feedback score * output are in a positive proportional relationship, and the goal of the