The patch titled Subject: mm/damon: explain "effective quota" on kernel-doc comment has been added to the -mm mm-unstable branch. Its filename is mm-damon-explain-effective-quota-on-kernel-doc-comment.patch This patch will shortly appear at https://git.kernel.org/pub/scm/linux/kernel/git/akpm/25-new.git/tree/patches/mm-damon-explain-effective-quota-on-kernel-doc-comment.patch This patch will later appear in the mm-unstable branch at git://git.kernel.org/pub/scm/linux/kernel/git/akpm/mm Before you just go and hit "reply", please: a) Consider who else should be cc'ed b) Prefer to cc a suitable mailing list as well c) Ideally: find the original patch on the mailing list and do a reply-to-all to that, adding suitable additional cc's *** Remember to use Documentation/process/submit-checklist.rst when testing your code *** The -mm tree is included into linux-next via the mm-everything branch at git://git.kernel.org/pub/scm/linux/kernel/git/akpm/mm and is updated there every 2-3 working days ------------------------------------------------------ From: SeongJae Park <sj@xxxxxxxxxx> Subject: mm/damon: explain "effective quota" on kernel-doc comment Date: Fri, 10 Jan 2025 10:52:32 -0800 The kernel-doc comment for 'struct damos_quota' describes how "effective quota" is calculated, but does not explain what it is. Actually there was an input[1] about it. Add the explanation on the comment. Also, fix a trivial typo on the comment block: s/empt/empty/ [1] https://github.com/damonitor/damo/issues/17#issuecomment-2497525043 Link: https://lkml.kernel.org/r/20250110185232.54907-6-sj@xxxxxxxxxx Signed-off-by: SeongJae Park <sj@xxxxxxxxxx> Suggested-by: Honggyu Kim <honggyu.kim@xxxxxx> Cc: Yunjeong Mun <yunjeong.mun@xxxxxx> Cc: Honggyu Kim <honggyu.kim@xxxxxx> Cc: Jonathan Corbet <corbet@xxxxxxx> Signed-off-by: Andrew Morton <akpm@xxxxxxxxxxxxxxxxxxxx> --- include/linux/damon.h | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) --- a/include/linux/damon.h~mm-damon-explain-effective-quota-on-kernel-doc-comment +++ a/include/linux/damon.h @@ -193,11 +193,16 @@ struct damos_quota_goal { * size quota is set, DAMON tries to apply the action only up to &sz bytes * within &reset_interval. * - * Internally, the time quota is transformed to a size quota using estimated - * throughput of the scheme's action. DAMON then compares it against &sz and - * uses smaller one as the effective quota. + * To convince the different types of quotas and goals, DAMON internally + * converts those into one single size quota called "effective quota". DAMON + * internally uses it as the only one real quota. The conversion is made as + * follows. * - * If @goals is not empt, DAMON calculates yet another size quota based on the + * The time quota is transformed to a size quota using estimated throughput of + * the scheme's action. DAMON then compares it against &sz and uses smaller + * one as the effective quota. + * + * If @goals is not empty, DAMON calculates yet another size quota based on the * goals using its internal feedback loop algorithm, for every @reset_interval. * Then, if the new size quota is smaller than the effective quota, it uses the * new size quota as the effective quota. _ Patches currently in -mm which might be from sj@xxxxxxxxxx are samples-add-a-skeleton-of-a-sample-damon-module-for-working-set-size-estimation.patch samples-damon-wsse-start-and-stop-damon-as-the-user-requests.patch samples-damon-wsse-implement-working-set-size-estimation-and-logging.patch samples-damon-introduce-a-skeleton-of-a-smaple-damon-module-for-proactive-reclamation.patch samples-damon-prcl-implement-schemes-setup.patch replace-free-hugepage-folios-after-migration-fix-2.patch mm-damon-sysfs-schemes-remove-unnecessary-schemes-existence-check-in-damon_sysfs_schemes_clear_regions.patch mm-damon-sysfs-handle-clear_schemes_tried_regions-from-damon-sysfs-context.patch mm-damon-core-introduce-damon_call.patch mm-damon-sysfs-use-damon_call-for-update_schemes_stats.patch mm-damon-sysfs-use-damon_call-for-commit_schemes_quota_goals.patch mm-damon-sysfs-use-damon_call-for-update_schemes_effective_quotas.patch mm-damon-core-implement-damos_walk.patch docs-mm-damon-design-document-damos-regions-walking.patch mm-damon-sysfs-use-damos_walk-for-update_schemes_tried_bytesregions.patch mm-damon-sysfs-remove-unused-code-for-schemes-tried-regions-update.patch mm-damon-clarify-trying-vs-applying-on-damos_stat-kernel-doc-comment.patch docs-mm-damon-design-add-statistics-section.patch docs-admin-guide-mm-damon-usage-link-damos-stat-design-doc.patch mm-damon-ask-apply_scheme-to-report-filter-passed-region-internal-bytes.patch mm-damon-paddr-report-filter-passed-bytes-back-for-normal-actions.patch mm-damon-paddr-report-filter-passed-bytes-back-for-damos_stat-action.patch mm-damon-core-implement-per-scheme-ops-handled-filter-passed-bytes-stat.patch mm-damon-syfs-schemes-implement-per-scheme-filter-passed-bytes-stat.patch docs-mm-damon-design-document-sz_ops_filter_passed.patch docs-admin-guide-mm-damon-usage-document-sz_ops_filter_passed.patch docs-abi-damon-document-per-scheme-filter-passed-bytes-stat-file.patch mm-damon-core-pass-per-region-filter-passed-bytes-to-damos_walk_control-walk_fn.patch mm-damon-sysfs-schemes-expose-per-region-filter-passed-bytes.patch docs-mm-damon-design-document-per-region-sz_filter_passed-stat.patch docs-admin-guide-mm-damon-usage-document-sz_filtered_out-of-scheme-tried-region-directories.patch docs-abi-damon-document-per-region-damos-filter-passed-bytes-stat-file.patch docs-translations-admin-guide-mm-damon-usage-remove-damon-debugfs-interface-documentation.patch docs-admin-guide-mm-damon-usage-remove-damon-debugfs-interface-documentation.patch docs-mm-damon-design-update-for-removal-of-damon-debugfs-interface.patch selftests-damon-config-remove-configs-for-damon-debugfs-interface-selftests.patch selftests-damon-remove-tests-for-damon-debugfs-interface.patch kunit-configs-remove-configs-for-damon-debugfs-interface-tests.patch mm-damon-remove-damon-debugfs-interface-kunit-tests.patch mm-damon-remove-damon-debugfs-interface.patch mm-damon-fixup-damos_filter-kernel-doc.patch mm-damon-core-add-damos_filter-allow-field.patch mm-damon-core-support-damos_filter-allow.patch mm-damon-paddr-support-damos_filter-allow.patch mm-damon-add-allow-argument-to-damos_new_filter.patch mm-damon-sysfs-schemes-add-a-file-for-setting-damos_filter-allow.patch docs-mm-damon-design-document-allow-reject-damos-filter-behaviors.patch docs-abi-damon-document-damos-filter-allow-sysfs-file.patch docs-admin-guide-mm-damon-usage-omit-damos-filter-details-in-favor-of-design-doc.patch docs-admin-guide-mm-damon-usage-document-damos-filter-allow-sysfs-file.patch docs-mm-damon-design-add-monitoring-parameters-tuning-guide.patch docs-mm-damon-add-an-example-monitoring-intervals-tuning.patch docs-admin-guide-mm-damon-usage-fix-and-add-missing-damos-filter-sysfs-files-on-files-hierarchy.patch docs-admin-guide-mm-damon-start-update-snapshot-example.patch mm-damon-explain-effective-quota-on-kernel-doc-comment.patch