SeongJae Park
3974345f26
Docs/mm/damon/maintainer-profile: allow posting patches based on damon/next tree
...
The document mentions any patches for review should based on mm-unstable
instead of damon/next. It should be the recommended process, but
sometimes patches based on damon/next could be posted for some reasons.
Actually, the DAMON-based tiered memory management patchset[1] was written
on top of 'young page' DAMOS filter patchset, which was in damon/next tree
as of the writing.
Allow such case and just ask such things to be clearly specified.
[1] https://lore.kernel.org/20240405060858.2818-1-honggyu.kim@sk.com
Link: https://lkml.kernel.org/r/20240503180318.72798-11-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: Shuah Khan <shuah@kernel.org >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2024-05-11 15:41:35 -07:00
SeongJae Park
437f7960d0
Docs/mm/damon/maintainer-profile: change the maintainer's timezone from PST to PT
...
The document says the maintainer is working on only PST. The maintainer
respects daylight saving system, though. Update the time zone to PT.
Link: https://lkml.kernel.org/r/20240503180318.72798-10-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: Shuah Khan <shuah@kernel.org >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2024-05-11 15:41:35 -07:00
SeongJae Park
2f02fbba35
Docs/mm/damon/design: use a list for supported filters
...
Filters section is listing currently supported filter types in a normal
paragraph. Since the number of types are higher than four, it is not easy
to read for only specific types. Use a list for easier finding of
specific types.
[sj@kernel.org: fix build warning]
Link: https://lkml.kernel.org/r/20240507161747.52430-1-sj@kernel.org
Link: https://lkml.kernel.org/r/20240503180318.72798-9-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: Shuah Khan <shuah@kernel.org >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2024-05-11 15:41:34 -07:00
SeongJae Park
26dd7cc7bb
Docs/mm/damon/design: document 'young page' type DAMOS filter
...
Update DAMON design document for the newly added DAMOS filter type, 'young
page'.
Link: https://lkml.kernel.org/r/20240426195247.100306-6-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Honggyu Kim <honggyu.kim@sk.com >
Cc: Jonathan Corbet <corbet@lwn.net >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2024-05-05 17:53:55 -07:00
Barry Song
ff0b5905a9
Docs/mm/damon/design: remove the details for pageout as paddr doesn't use MADV_PAGEOUT
...
The doc needs a fix. As only in the case of virtual address, we are
calling madvise() with MADV_PAGEOUT. But in the case of physical address,
we are calling reclaim_pages() directly. MADV_PAGEOUT on virtual address
is much more aggresive to reclaim memory compared to reclaim_pages() on
paddr region. This patch removes the details so that the description can
apply to both cases. And we don't need to couple with the implementation
details.
Link: https://lkml.kernel.org/r/20240224224751.4673-1-21cnbao@gmail.com
Signed-off-by: Barry Song <v-songbaohua@oppo.com >
Reviewed-by: SeongJae Park <sj@kernel.org >
Cc: Minchan Kim <minchan@kernel.org >
Cc: Michal Hocko <mhocko@suse.com >
Cc: Johannes Weiner <hannes@cmpxchg.org >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2024-03-04 17:01:17 -08:00
SeongJae Park
3c17174f64
Docs/mm/damon/design: document quota goal self-tuning
...
Update DAMON design doc to explain the quota goal self-tuning, which can
be used by setting the goal's metric to metrics that kernel can
self-retrieve.
Link: https://lkml.kernel.org/r/20240219194431.159606-16-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2024-02-23 17:48:29 -08:00
SeongJae Park
2d89957c93
Docs/mm/damon: move monitoring target regions setup detail from the usage to the design document
...
Design doc is aimed to have all concept level details, while the usage doc
is focused on only how the features can be used. Some details about
monitoring target regions construction is on the usage doc. Move the
details about the monitoring target regions construction differences for
DAMON operations set from the usage to the design doc.
Link: https://lkml.kernel.org/r/20240217005842.87348-5-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2024-02-22 15:27:20 -08:00
SeongJae Park
669971b406
Docs/mm/damon: move DAMON operation sets list from the usage to the design document
...
The list of DAMON operation sets and their explanation, which may better
to be on design document, is written on the usage document. Move the
detail to design document and make the usage document only reference the
design document.
[sj@kernel.org: fix a typo on a reference link]
Link: https://lkml.kernel.org/r/20240221170852.55529-2-sj@kernel.org
Link: https://lkml.kernel.org/r/20240217005842.87348-4-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2024-02-22 15:27:20 -08:00
SeongJae Park
5b7708e6a8
Docs/mm/damon: move the list of DAMOS actions to design doc
...
DAMOS operation actions are explained nearly twice on the DAMON usage
document, once for the sysfs interface, and then again for the debugfs
interface. Duplication is bad. Also it would better to keep this kind of
concept level details in design document and keep the usage document small
and focus on only the usage. Move the list to design document and update
usage document to reference it.
Link: https://lkml.kernel.org/r/20240217005842.87348-3-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2024-02-22 15:27:20 -08:00
SeongJae Park
0a1ebc17a7
Docs/mm/damon/maintainer-profile: fix reference links for mm-[un]stable tree
...
Patch series "Docs/mm/damon: misc readability improvements".
Fix trivial mistakes and improve layout of information on different
documents for DAMON.
This patch (of 5):
A couple of sentences on maintainer-profile.rst are having reference links
for mm-unstable and mm-stable trees with wrong rst markup. Fix those.
Link: https://lkml.kernel.org/r/20240217005842.87348-1-sj@kernel.org
Link: https://lkml.kernel.org/r/20240217005842.87348-2-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2024-02-22 15:27:20 -08:00
SeongJae Park
1f1d83ca27
Docs/mm/damon/design: place execution model and data structures at the beginning
...
The execution model and data structures section at the end of the design
document is briefly explaining how DAMON works overall. Knowing that
first may help better drawing the overall picture. It may also help
better understanding following detailed sections. Move it to the
beginning of the document.
Link: https://lkml.kernel.org/r/20231213190338.54146-4-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-12-20 14:48:13 -08:00
SeongJae Park
6140edeea8
Docs/admin-guide/mm/damon/usage: document for quota goals
...
Update DAMON sysfs usage for newly added DAMOS quota goals interface.
Link: https://lkml.kernel.org/r/20231130023652.50284-10-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Brendan Higgins <brendanhiggins@google.com >
Cc: David Gow <davidgow@google.com >
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: Shuah Khan <shuah@kernel.org >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-12-12 10:57:05 -08:00
SeongJae Park
3143a7bfd2
Docs/mm/damon/design: document DAMOS quota auto tuning
...
Document the DAMOS quota auto tuning feature on the design document.
Link: https://lkml.kernel.org/r/20231130023652.50284-8-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Brendan Higgins <brendanhiggins@google.com >
Cc: David Gow <davidgow@google.com >
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: Shuah Khan <shuah@kernel.org >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-12-12 10:57:04 -08:00
SeongJae Park
3f8723f129
Docs/mm/damon/design: document DAMOS apply intervals
...
Update DAMON design doc to explain about DAMOS apply intervals.
Link: https://lkml.kernel.org/r/20230916020945.47296-6-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: Shuah Khan <shuah@kernel.org >
Cc: Steven Rostedt (Google) <rostedt@goodmis.org >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-10-04 10:32:31 -07:00
SeongJae Park
46158bf211
Docs/admin-guide/mm/damon/usage: link design doc for details of kdamond and context
...
The explanation of kdamond and context is duplicated in the design and
the usage documents. Replace that in the usage with links to those in
the design document.
Link: https://lkml.kernel.org/r/20230907022929.91361-8-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: Steven Rostedt (Google) <rostedt@goodmis.org >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-10-04 10:32:21 -07:00
SeongJae Park
86ae64cde2
Docs/mm/damon/design: add a section for kdamond and DAMON context
...
The design document is not explaining about the concept of kdamond and
the DAMON context, while usage document does. Those concept explanation
should be in the design document, and usage document should link those.
Add a section for those.
Link: https://lkml.kernel.org/r/20230907022929.91361-7-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: Steven Rostedt (Google) <rostedt@goodmis.org >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-10-04 10:32:21 -07:00
SeongJae Park
4f554ca15a
Docs/admin-guide/mm/damon/usage: explain the format of damon_aggregate tracepoint
...
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.
Link: https://lkml.kernel.org/r/20230907022929.91361-6-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: Steven Rostedt (Google) <rostedt@goodmis.org >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-10-04 10:32:21 -07:00
SeongJae Park
24df886f9f
Docs/mm/damon/design: explicitly introduce `nr_accesses`
...
The design document is explaining about the access tracking mechanism
and the access rate counter (nr_accesses), but not directly mentions the
name. Add a sentence for making it clear.
Link: https://lkml.kernel.org/r/20230907022929.91361-5-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: Steven Rostedt (Google) <rostedt@goodmis.org >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-10-04 10:32:21 -07:00
SeongJae Park
08ad3bb3ed
Docs/mm/damon/design: update for DAMON monitoring target type DAMOS filter
...
Update DAMON design document for the newly added DAMON monitoring target
type DAMOS filter.
Link: https://lkml.kernel.org/r/20230802214312.110532-12-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Brendan Higgins <brendanhiggins@google.com >
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: Shuah Khan <shuah@kernel.org >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-08-21 13:37:37 -07:00
SeongJae Park
96a7cb2377
Docs/mm/damon/design: update for address range filters
...
Update DAMON design document's DAMOS filters section for address range
DAMOS filters. Because address range filters are handled by the core
layer and it makes difference in schemes tried regions and schemes
statistics, clearly describe it.
Link: https://lkml.kernel.org/r/20230802214312.110532-6-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Brendan Higgins <brendanhiggins@google.com >
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: Shuah Khan <shuah@kernel.org >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-08-21 13:37:36 -07:00
SeongJae Park
01e08737da
Docs/admin-guide/mm/damon/usage: link design document for DAMOS
...
The background and concept of DAMOS is redundantly documented, in the
design document and the usage document. Replace the duplicated ones in
usage document with links to the design document.
Link: https://lkml.kernel.org/r/20230616191742.87531-6-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-06-19 16:19:36 -07:00
SeongJae Park
b16b54c9db
Docs/mm/damon/design: document 'age' of region
...
Patch series "Docs/{mm,admin-guide}damon: update design and usage docs".
Update DAMON design and usage documents for outdated and unnecessarily
duplicated parts.
This patch (of 7):
The 'age' of each region in DAMON monitoring results is an important
concept for both monitoring part and DAMOS. And DAMOS section of the
design document is mentioning it. However, the age itself is not
explained in the document. Add a section for that.
Link: https://lkml.kernel.org/r/20230616191742.87531-1-sj@kernel.org
Link: https://lkml.kernel.org/r/20230616191742.87531-2-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-06-19 16:19:36 -07:00
SeongJae Park
da9698105c
Docs/mm/damon/design: add a section for the modules layer
...
Add a section for covering DAMON modules layer to the design document.
Link: https://lkml.kernel.org/r/20230525214314.5204-11-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-06-09 16:25:48 -07:00
SeongJae Park
f508a0fbd3
Docs/mm/damon/design: add a section for DAMON core API
...
Add a section covering the API of DAMON core layer on the design document.
Link: https://lkml.kernel.org/r/20230525214314.5204-10-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-06-09 16:25:48 -07:00
SeongJae Park
b138878609
Docs/mm/damon/design: add sections for advanced features of DAMOS
...
Add sections for advanced features of DAMOS including quotas,
prioritization, watermarks, and filters of DAMOS on the design document.
Link: https://lkml.kernel.org/r/20230525214314.5204-9-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-06-09 16:25:48 -07:00
SeongJae Park
2dc4e6a509
Docs/mm/damon/design: add sections for basic parts of DAMOS
...
DAMOS is an important part of DAMON, but the design doc is not covering
it. Add sections for covering the basic part of DAMOS.
Link: https://lkml.kernel.org/r/20230525214314.5204-8-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-06-09 16:25:47 -07:00
SeongJae Park
eaabfa4321
Docs/mm/damon/design: add a section for the relation between Core and Modules layer
...
Add overall desription of the interface and the relation between the Core
and the Modules layer under 'Overall Architecture' section.
Link: https://lkml.kernel.org/r/20230525214314.5204-7-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-06-09 16:25:47 -07:00
SeongJae Park
69e7b88cea
Docs/mm/damon/design: rewrite configurable layers
...
The 'Configurable Operations Set' section is a little bit outdated.
Update the text.
Link: https://lkml.kernel.org/r/20230525214314.5204-6-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-06-09 16:25:47 -07:00
SeongJae Park
e168962dbf
Docs/mm/damon/design: update the layout based on the layers
...
DAMON design document is describing only the operations set layer and
monitoring part of the core logic. Update the layout based on the DAMON's
layers, so that more parts of DAMON including DAMOS core logic and DAMON
modules can easily be added.
Link: https://lkml.kernel.org/r/20230525214314.5204-5-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-06-09 16:25:47 -07:00
SeongJae Park
45b849df7d
Docs/mm/damon/design: add a section for overall architecture
...
The design doc is missing overall picture of DAMON. Add a section for
overall architeucture and layers.
Link: https://lkml.kernel.org/r/20230525214314.5204-4-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-06-09 16:25:47 -07:00
SeongJae Park
73dc57e4ef
Docs/mm/damon/maintainer-profile: fix typos and grammar errors
...
Fix a few typos and grammar erros in DAMON Maintainer Profile document.
Link: https://lkml.kernel.org/r/20230525214314.5204-3-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-06-09 16:25:46 -07:00
SeongJae Park
c6bb975aa6
Docs/mm/damon/faq: remove old questions
...
Patch series "Docs/mm/damon: Minor fixes and design doc update".
Some of the DAMON documents are outdated, or having minor typos or grammar
erros. Especially, the design doc has not updated for DAMOS, which is an
important part of DAMON. Fix the minor issues and update documents.
This patch (of 10):
The first two questions of DAMON faqs have raised when DAMON patches were
first submitted. More than one year has passed since DAMON patches get
merged in the mainline, and that kind of questions are not asked nowadays.
Remove the questions.
Link: https://lkml.kernel.org/r/20230525214314.5204-1-sj@kernel.org
Link: https://lkml.kernel.org/r/20230525214314.5204-2-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-06-09 16:25:46 -07:00
SeongJae Park
e7366f3a2e
Docs/mm/damon: add a maintainer-profile for DAMON
...
Document the basic policies and expectations for DAMON development.
Link: https://lkml.kernel.org/r/20230110190400.119388-6-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: Shuah Khan <shuah@kernel.org >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-02-02 22:32:52 -08:00
SeongJae Park
86834644e3
Docs/mm/damon/index: mention DAMOS on the intro
...
What DAMON aims to do is not only access monitoring but efficient and
effective access-aware system operations. And DAMon-based Operation
Schemes (DAMOS) is the important feature of DAMON for the goal. Make the
intro of DAMON documentation to emphasize the goal and mention DAMOS.
Link: https://lkml.kernel.org/r/20230110190400.119388-4-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: Shuah Khan <shuah@kernel.org >
Signed-off-by: Andrew Morton <akpm@linux-foundation.org >
2023-02-02 22:32:51 -08:00
Mike Rapoport
ee65728e10
docs: rename Documentation/vm to Documentation/mm
...
so it will be consistent with code mm directory and with
Documentation/admin-guide/mm and won't be confused with virtual machines.
Signed-off-by: Mike Rapoport <rppt@linux.ibm.com >
Suggested-by: Matthew Wilcox <willy@infradead.org >
Tested-by: Ira Weiny <ira.weiny@intel.com >
Acked-by: Jonathan Corbet <corbet@lwn.net >
Acked-by: Wu XiangCheng <bobwxc@email.cn >
2022-06-27 12:52:53 -07:00