mm/damon: export DAMON symbols and add sample loadable modules
Subsystems (2)
SeongJae Park
maintainercover mm/damon: export DAMON symbols and add sample loadable modules
Changes from RFC
(https://lore.kernel.org/damon/[email protected]/)
- Wordsmith commit message
- Use GPL v2 for Makefile
- Separate patch for each sample module
DAMON cannot be used from loadable modules since it is not exporting its symbols. This makes use of DAMON unnecessarily tedious. For example, basic usage of DAMON was presented at kernel summit 2021[1] by writing simple loadable DAMON application modules in live. Because the time was limited (10 minutes) and the coding was to be done step by step, it had to make a downstream commit that exports DAMON symbols. There were users asking why the source code is now not working. It was mainly due to the absence of the symbols export patch on their tree, but also due to the updated DAMON programming interfaces. There were also multiple users requesting support of loadable modules for easier deployment.
There's no reason to avoid exporting DAMON symbols. However, it would be better to have concrete use cases of the symbols in the tree together, for better maintenance of the interface and the use cases. The kernels summit 2021's live-coded modules could be used for the purpose.
Expose DAMON API modules for supporting the minimum modules and add the kernel summit 2021's modules that updated for latest DAMON API under the samples directory. The sample modules will be keep updated. For exporting more symbols, requesters would be required to merge their modules using the symbols in the tree together, or updsate the sample modules to use the newly-exporting symbols in still simple but reasonable ways.
[1] https://linuxplumbersconf.org/event/11/contributions/984/
SeongJae Park (3):
mm/damon/core: export symbols for supporting loadable modules
samples: add working set size estimation DAMON sample module
samples: add proactive reclamation DAMON sample module
MAINTAINERS | 1 + mm/damon/core.c | 10 +++ samples/Kconfig | 2 + samples/Makefile | 2 + samples/damon/Kconfig | 30 +++++++++ samples/damon/Makefile | 3 + samples/damon/damon_sample_prcl.c | 102 ++++++++++++++++++++++++++++++ samples/damon/damon_sample_wsse.c | 85 +++++++++++++++++++++++++ 8 files changed, 235 insertions(+) create mode 100644 samples/damon/Kconfig create mode 100644 samples/damon/Makefile create mode 100644 samples/damon/damon_sample_prcl.c create mode 100644 samples/damon/damon_sample_wsse.c
base-commit: 7fcebba4a540e4508b923f00a3e9c5e4710f147f
Signature · 1 line
2.34.1
SeongJae Park
maintainerPATCH 1/3 mm/damon/core: export symbols for supporting loadable modules
Expose minimum DAMON core symbols for supporting use of basic functionality from loadable modules. Followup commits will add sample loadable modules that use the exported symbols.
--- mm/damon/core.c | 10 ++++++++++ 1 file changed, 10 insertions(+)
mm/damon/core.c +10 -0
@@ -111,6 +111,7 @@ int damon_select_ops(struct damon_ctx *ctx, enum damon_ops_id id)mutex_unlock (&damon_ops_lock);return err; } +EXPORT_SYMBOL (damon_select_ops);/* * Construct a damon_region struct
@@ -343,6 +344,7 @@ struct damos *damon_new_scheme(struct damos_access_pattern *pattern,return scheme; } +EXPORT_SYMBOL (damon_new_scheme);static void damos_set_next_apply_sis (struct damos *s,struct damon_ctx *ctx) {
@@ -380,6 +382,7 @@ void damon_destroy_scheme(struct damos *s)damon_del_scheme (s);damon_free_scheme (s); } +EXPORT_SYMBOL (damon_destroy_scheme);/* * Construct a damon_target struct
@@ -401,11 +404,13 @@ struct damon_target *damon_new_target(void)return t; } +EXPORT_SYMBOL (damon_new_target);void damon_add_target (struct damon_ctx *ctx,struct damon_target *t) {list_add_tail (&t->list, &ctx->adaptive_targets); } +EXPORT_SYMBOL (damon_add_target);bool damon_targets_empty (struct damon_ctx *ctx) {
@@ -464,6 +469,7 @@ struct damon_ctx *damon_new_ctx(void)return ctx; } +EXPORT_SYMBOL (damon_new_ctx);static void damon_destroy_targets (struct damon_ctx *ctx) {
@@ -489,6 +495,7 @@ void damon_destroy_ctx(struct damon_ctx *ctx)kfree (ctx); } +EXPORT_SYMBOL (damon_destroy_ctx);static unsigned int damon_age_for_new_attrs (unsigned int age,struct damon_attrs *old_attrs,struct damon_attrs *new_attrs)
@@ -616,6 +623,7 @@ void damon_set_schemes(struct damon_ctx *ctx, struct damos **schemes,for (i =0 ; i < nr_schemes; i++)damon_add_scheme (ctx, schemes[i]); } +EXPORT_SYMBOL (damon_set_schemes);/** * damon_nr_running_ctxs() - Return number of currently running contexts.
@@ -719,6 +727,7 @@ int damon_start(struct damon_ctx **ctxs, int nr_ctxs, bool exclusive)return err; } +EXPORT_SYMBOL (damon_start);/* * __damon_stop() - Stops monitoring of a given context.
@@ -762,6 +771,7 @@ int damon_stop(struct damon_ctx **ctxs, int nr_ctxs) }return err; } +EXPORT_SYMBOL (damon_stop);/* * Reset the aggregated monitoring results ('nr_accesses' of each region).
Signature · 1 line
2.34.1
SeongJae Park
maintainerPATCH 2/3 samples: add working set size estimation DAMON sample module
In reply to SeongJae ParkAdd a sample DAMON application kernel module, namely damon_sample_wsse. It is same to the one of the example kernel modules that presented at kernel summit 2021 with 10 minutes live coding[1] but updated for the latest DAMON interface.
The sample module receives a pid of a process to monitor the access, monitors the access to the virtual address space of the process, calculate estimated working set size, and repeatedly print it on the kernel log.
[1] https://linuxplumbersconf.org/event/11/contributions/984/
--- MAINTAINERS | 1 + samples/Kconfig | 2 + samples/Makefile | 2 + samples/damon/Kconfig | 17 +++++++ samples/damon/Makefile | 2 + samples/damon/damon_sample_wsse.c | 85 +++++++++++++++++++++++++++++++ 6 files changed, 109 insertions(+) create mode 100644 samples/damon/Kconfig create mode 100644 samples/damon/Makefile create mode 100644 samples/damon/damon_sample_wsse.c
MAINTAINERS +1 -0
@@ -5764,6 +5764,7 @@ F: Documentation/mm/damon/ F: include/linux/damon.h F: include/trace/events/damon.h F: mm/damon/ +F: samples/damon/ F: tools/testing/selftests/damon/ DAVICOM FAST ETHERNET (DMFE) NETWORK DRIVER
samples/Kconfig +2 -0
@@ -293,6 +293,8 @@ config SAMPLE_CGROUP source "samples/rust/Kconfig" +source "samples/damon/Kconfig" + endif # SAMPLES config HAVE_SAMPLE_FTRACE_DIRECT
samples/Makefile +2 -0
@@ -39,3 +39,5 @@ obj-$(CONFIG_SAMPLE_KMEMLEAK) += kmemleak/ obj-$(CONFIG_SAMPLE_CORESIGHT_SYSCFG) += coresight/ obj-$(CONFIG_SAMPLE_FPROBE) += fprobe/ obj-$(CONFIG_SAMPLES_RUST) += rust/ +obj-$(CONFIG_SAMPLE_DAMON_WSSE) += damon/ +obj-$(CONFIG_SAMPLE_DAMON_PRCL) += damon/
samples/damon/Kconfig new file +17 -0
@@ -0,0 +1,17 @@ +# SPDX-License-Identifier: GPL-2.0 + +menu "DAMON Samples" + +config SAMPLE_DAMON_WSSE + tristate "DAMON sameple module for working set size estimation" + depends on DAMON && DAMON_VADDR + help + This builds DAMON sample module for working set size estimation. + + The module receives pid of a process, monitor access to the virtual + address space of the process, calculate the estimated working set + size of the process, and repeatedly print the size on the kernel log. + + If unsure, say N. + +endmenu
samples/damon/Makefile new file +2 -0
@@ -0,0 +1,2 @@ +# SPDX-License-Identifier: GPL-2.0 +obj-$(CONFIG_SAMPLE_DAMON_WSSE) += damon_sample_wsse.o
samples/damon/damon_sample_wsse.c new file +85 -0
85 lines not on this page · raw message
Signature · 1 line
2.34.1
SeongJae Park
maintainerPATCH 3/3 samples: add proactive reclamation DAMON sample module
In reply to SeongJae ParkAdd a sample DAMON application kernel module, namely damon_sample_prcl. It is same to the one of the example kernel modules that presented at kernel summit 2021 with 10 minutes live coding[1] but updated for the latest DAMON interface.
The sample module receives a pid of a process to monitor the access, monitors the access to the virtual address space of the process, find regions that not accessed and proactively reclaim those using DAMOS.
[1] https://linuxplumbersconf.org/event/11/contributions/984/
--- samples/damon/Kconfig | 13 ++++ samples/damon/Makefile | 1 + samples/damon/damon_sample_prcl.c | 102 ++++++++++++++++++++++++++++++ 3 files changed, 116 insertions(+) create mode 100644 samples/damon/damon_sample_prcl.c
samples/damon/Kconfig +13 -0
@@ -14,4 +14,17 @@ config SAMPLE_DAMON_WSSE If unsure, say N. +config SAMPLE_DAMON_PRCL + tristate "DAMON sameple module for access-aware proactive reclamation" + depends on DAMON && DAMON_VADDR + help + This builds DAMON sample module for access-aware proactive + reclamation. + + The module receives pid of a process, monitor access to the virtual + address space of the process, find memory regions that not accessed, + and proactively reclaim the regions. + + If unsure, say N. + endmenu
samples/damon/Makefile +1 -0
@@ -1,2 +1,3 @@ # SPDX-License-Identifier: GPL-2.0 obj-$(CONFIG_SAMPLE_DAMON_WSSE) += damon_sample_wsse.o +obj-$(CONFIG_SAMPLE_DAMON_PRCL) += damon_sample_prcl.o
samples/damon/damon_sample_prcl.c new file +102 -0
102 lines not on this page · raw message
Signature · 1 line
2.34.1
Quoted 2 lines · SeongJae Park
DAMON cannot be used from loadable modules since it is not exporting its symbols.
And that is a good thing. We should absolutely not allow random modules
probing MM internals. What you posted here is basically just adding
hooks without even real in-kernel users.
SeongJae Park
maintainerHi Christoph,
Quoted 6 lines · On 2023-12-04T21:12:47-08:00 Christoph Hellwig <[email protected]> wrote:
Quoted 2 lines · SeongJae Park
DAMON cannot be used from loadable modules since it is not exporting its symbols.
And that is a good thing. We should absolutely not allow random modules probing MM internals.
I agree.
Quoted 2 lines
What you posted here is basically just adding hooks without even real in-kernel users.
I was thinking someone might be able to think even the sample module as real usage since there was actually some questions about it from real users. That said, those were more like questions than strong requests, so I still think this change is somewhat better to be made for at least some folks, but I also agree that this wouldn't be not really essential for everyone, and could be only long term maintenance threat.
I personally don't have strong opinion, and thank you for raising your concern. I will hold this patchset unless someone request this change again with good rationale.
Btw, I know there were many concerns about unnecessarily exporting symbols, but do we have a formal guideline or documentation about the requirements for exporting symbols in sepcific subsystem? I was hoping to have such one so that I could provide better answer to DAMON's loadable module support questions, but I was unable to find such one with my poor searching skill. This reply could be used for the purpose meanwhile, though, so appreciate again. :)
Thanks,
SJ