mm/damon: add a tracepoint for damos apply target regions
Subsystems (5)
SeongJae Park
maintainercover mm/damon: add a tracepoint for damos apply target regions
Changes from RFC
(https://lore.kernel.org/damon/[email protected]/)
- Fix the 4 byte hole (Steven Rostedt)
- Add documentation
DAMON provides damon_aggregated tracepoint to let users record full monitoring results. Sometimes, users need to record monitoring results of specific pattern. DAMOS tried regions directory of DAMON sysfs interface allows it, but the interface is mainly designed for snapshots and therefore would be inefficient for such recording. Implement yet another tracepoint for efficient support of the usecase.
SeongJae Park (2):
mm/damon/core: add a tracepoint for damos apply target regions Docs/admin-guide/mm/damon/usage: document damos_before_apply
tracepoint
Documentation/admin-guide/mm/damon/usage.rst | 37 ++++++++++++++++---- include/trace/events/damon.h | 37 ++++++++++++++++++++ mm/damon/core.c | 27 +++++++++++++- 3 files changed, 93 insertions(+), 8 deletions(-)
base-commit: b4c5d592acb5a939aa4f6c08543daf6e2b435343
Signature · 1 line
2.25.1
SeongJae Park
maintainerPATCH 1/2 mm/damon/core: add a tracepoint for damos apply target regions
DAMON provides damon_aggregated tracepoint, which exposes details of each region and its access monitoring results. It is useful for getting whole monitoring results, e.g., for recording purposes.
For investigations of DAMOS, DAMON Sysfs interface provides DAMOS statistics and tried_regions directory. But, those provides only statistics and snapshots. If the scheme is frequently applied and if the user needs to know every detail of DAMOS behavior, the snapshot-based interface could be insufficient and expensive.
As a last resort, userspace users need to record the all monitoring results via damon_aggregated tracepoint and simulate how DAMOS would worked. It is unnecessarily complicated. DAMON kernel API users, meanwhile, can do that easily via before_damos_apply() callback field of 'struct damon_callback', though.
Add a tracepoint that will be called just after before_damos_apply() callback for more convenient investigations of DAMOS. The tracepoint exposes all details about each regions, similar to damon_aggregated tracepoint.
Please note that DAMOS is currently not only for memory management but also for query-like efficient monitoring results retrievals (when 'stat' action is used). Until now, only statistics or snapshots were supported. Addition of this tracepoint allows efficient full recording of DAMOS-based filtered monitoring results.
--- include/trace/events/damon.h | 37 ++++++++++++++++++++++++++++++++++++ mm/damon/core.c | 27 +++++++++++++++++++++++++- 2 files changed, 63 insertions(+), 1 deletion(-)
include/trace/events/damon.h +37 -0
@@ -9,6 +9,43 @@#include <linux/types.h> #include <linux/tracepoint.h> +TRACE_EVENT (damos_before_apply, + + TP_PROTO(unsigned int context_idx, unsigned int scheme_idx, + unsigned int target_idx, struct damon_region *r, + unsigned int nr_regions), + +TP_ARGS (context_idx, target_idx, scheme_idx, r, nr_regions), + +TP_STRUCT__entry ( + __field(unsigned int, context_idx) + __field(unsigned int, scheme_idx) + __field(unsigned long, target_idx) + __field(unsigned long, start) + __field(unsigned long, end) + __field(unsigned int, nr_accesses) + __field(unsigned int, age) + __field(unsigned int, nr_regions) + ), + +TP_fast_assign ( + __entry->context_idx = context_idx; + __entry->scheme_idx = scheme_idx; + __entry->target_idx = target_idx; + __entry->start = r->ar.start; + __entry->end = r->ar.end; + __entry->nr_accesses = r->nr_accesses; + __entry->age = r->age; + __entry->nr_regions = nr_regions; + ), + +TP_printk ("ctx_idx=%u scheme_idx=%u target_idx=%lu nr_regions=%u %lu-%lu: %u %u" , + __entry->context_idx, __entry->scheme_idx, + __entry->target_idx, __entry->nr_regions, + __entry->start, __entry->end, + __entry->nr_accesses, __entry->age) +); + TRACE_EVENT(damon_aggregated, TP_PROTO(unsigned int target_id, struct damon_region *r,
mm/damon/core.c +26 -1
@@ -950,6 +950,28 @@ static void damos_apply_scheme(struct damon_ctx *c, struct damon_target *t,struct timespec64 begin, end;unsigned long sz_applied =0 ;int err =0 ; +/* +* We plan to support multiple context per kdamond, as DAMON sysfs +* implies with 'nr_contexts' file. Nevertheless, only single context +* per kdamond is supported for now. So, we can simply use '0' context +* index here. +*/ +unsigned int cidx =0 ; +struct damos *siter;/* schemes iterator */ +unsigned int sidx =0 ; +struct damon_target *titer;/* targets iterator */ +unsigned int tidx =0 ; + +damon_for_each_scheme (siter, c) { +if (siter == s) +break ; + sidx++; + } +damon_for_each_target (titer, c) { +if (titer == t) +break ; + tidx++; + }if (c->ops.apply_scheme) {if (quota->esz && quota->charged_sz + sz > quota->esz) {
@@ -964,8 +986,11 @@ static void damos_apply_scheme(struct damon_ctx *c, struct damon_target *t,ktime_get_coarse_ts64 (&begin);if (c->callback.before_damos_apply) err = c->callback.before_damos_apply (c, t, r, s); -if (!err) +if (!err) { +trace_damos_before_apply (cidx, sidx, tidx, r, +damon_nr_regions (t)); sz_applied = c->ops.apply_scheme (c, t, r, s); + }ktime_get_coarse_ts64 (&end); quota->total_charged_ns +=timespec64_to_ns (&end) -timespec64_to_ns (&begin);
Signature · 1 line
2.25.1
SeongJae Park
maintainerPATCH 2/2 Docs/admin-guide/mm/damon/usage: document damos_before_apply tracepoint
In reply to SeongJae ParkDocument damos_before_apply tracepoint on the usage document.
--- Documentation/admin-guide/mm/damon/usage.rst | 37 ++++++++++++++++---- 1 file changed, 30 insertions(+), 7 deletions(-)
Documentation/admin-guide/mm/damon/usage.rst +30 -7
@@ -496,15 +496,24 @@ the files as above. Above is only for an example. .. _tracepoint: -Tracepoint for Monitoring Results -================================= +Tracepoints for Monitoring Results +================================== Users can get the monitoring results via the :ref:`tried_regions -<sysfs_schemes_tried_regions>` or a tracepoint, ``damon:damon_aggregated``. -While the tried regions directory is useful for getting a snapshot, the -tracepoint is useful for getting a full record of the results. While the -monitoring is turned on, you could record the tracepoint events and show -results using tracepoint supporting tools like ``perf``. For example:: +<sysfs_schemes_tried_regions>`. The interface is useful for getting a +snapshot, but it could be inefficient for fully recording all the monitoring +results. For the purpose, two trace points, namely ``damon:damon_aggregated`` +and ``damon:damos_before_apply``, are provided. ``damon:damon_aggregated`` +provides the whole monitoring results, while ``damon:damos_before_apply`` +provides the monitoring results for regions that each DAMON-based Operation +Scheme (:ref:`DAMOS <damon_design_damos>`) is gonna be applied. Hence, +``damon:damos_before_apply`` is more useful for recording internal behavior of +DAMOS, or DAMOS target access +:ref:`pattern <damon_design_damos_access_pattern>` based query-like efficient +monitoring results recording. + +While the monitoring is turned on, you could record the tracepoint events and +show results using tracepoint supporting tools like ``perf``. For example:: # echo on > monitor_on # perf record -e damon:damon_aggregated &
@@ -527,6 +536,20 @@ counter). Finally the tenth field (``X``) shows the ``age`` of the region (refer to :ref:`design <damon_design_age_tracking>` for more details of the counter). +If the event was ``damon:damos_beofre_apply``, the ``perf script`` output would +be somewhat like below:: + + kdamond.0 47293 [000] 80801.060214: damon:damos_before_apply: ctx_idx=0 scheme_idx=0 target_idx=0 nr_regions=11 121932607488-135128711168: 0 136 + [...] + +Each line of the output represents each monitoring region that each DAMON-based +Operation Scheme was about to be applied at the traced time. The first five +fields are as usual. It shows the index of the DAMON context (``ctx_idx=X``) +of the scheme in the list of the contexts of the context's kdamond, the index +of the scheme (``scheme_idx=X``) in the list of the schemes of the context, in +addition to the output of ``damon_aggregated`` tracepoint. + + .. _debugfs_interface: debugfs Interface (DEPRECATED!)
Signature · 1 line
2.25.1
Steven Rostedt
maintainerRe: [PATCH 1/2] mm/damon/core: add a tracepoint for damos apply target regions
In reply to SeongJae ParkQuoted 8 lines · On Mon, 11 Sep 2023 04:59:07 +0000 SeongJae Park <[email protected]> wrote:
mm/damon/core.c +2
-0@@ -950,6 +950,28 @@ static void damos_apply_scheme(struct damon_ctx *c, struct damon_target *t,struct timespec64 begin, end;unsigned long sz_applied =0 ;int err =0 ; +/* +* We plan to support multiple context per kdamond, as DAMON sysfs
mm/damon/core.c static void damos_apply_scheme(struct damon_ctx *c, struct damon_target *t, · line 964
Quoted 10 lines
mm/damon/core.c +10
-0+* implies with 'nr_contexts' file. Nevertheless, only single context +* per kdamond is supported for now. So, we can simply use '0' context +* index here. +*/ +unsigned int cidx =0 ; +struct damos *siter;/* schemes iterator */ +unsigned int sidx =0 ; +struct damon_target *titer;/* targets iterator */ +unsigned int tidx =0 ; +
If this loop is only for passing sidx and tidx to the trace point, you can add around it:
if (trace_damos_before_apply_enabled()) {mm/damon/core.c static void damos_apply_scheme(struct damon_ctx *c, struct damon_target *t, · line 974
Quoted 10 lines
mm/damon/core.c +10
-0+damon_for_each_scheme (siter, c) { +if (siter == s) +break ; + sidx++; + } +damon_for_each_target (titer, c) { +if (titer == t) +break ; + tidx++; + }
}
And then this loop will only be done if that trace event is enabled.
To prevent races, you may also want to add a third parameter, or initialize them to -1:
sidx = -1;
if (trace_damo_before_apply_enabled()) {
sidx = 0;
[..]
}And you can change the TRACE_EVENT() TO TRACE_EVENT_CONDITION():
TRACE_EVENT_CONDITION(damos_before_apply,
TP_PROTO(...), TP_ARGS(...), TP_CONDITION(sidx >= 0),
and the trace event will not be called if sidx is less than zero.
Also, this if statement is only done when the trace event is enabled, so it's equivalent to:
if (trace_damos_before_apply_enabled()) {
if (sdx >= 0)
trace_damos_before_apply(cidx, sidx, tidx, r,
damon_nr_regions(t));
}-- Steve
Quoted 17 lines
mm/damon/core.c +4
-1if (c->ops.apply_scheme) {if (quota->esz && quota->charged_sz + sz > quota->esz) {@@ -964,8 +986,11 @@ static void damos_apply_scheme(struct damon_ctx *c, struct damon_target *t,ktime_get_coarse_ts64 (&begin);if (c->callback.before_damos_apply) err = c->callback.before_damos_apply (c, t, r, s); -if (!err) +if (!err) { +trace_damos_before_apply (cidx, sidx, tidx, r, +damon_nr_regions (t)); sz_applied = c->ops.apply_scheme (c, t, r, s); + }ktime_get_coarse_ts64 (&end); quota->total_charged_ns +=timespec64_to_ns (&end) -timespec64_to_ns (&begin);
SeongJae Park
maintainerRe: [PATCH 1/2] mm/damon/core: add a tracepoint for damos apply target regions
Hi Steven,
Quoted 15 lines · On Mon, 11 Sep 2023 14:19:55 -0400 Steven Rostedt <[email protected]> wrote:
Quoted 12 lines · On Mon, 11 Sep 2023 04:59:07 +0000 SeongJae Park <[email protected]> wrote:
mm/damon/core.c +6
-0@@ -950,6 +950,28 @@ static void damos_apply_scheme(struct damon_ctx *c, struct damon_target *t,struct timespec64 begin, end;unsigned long sz_applied =0 ;int err =0 ; +/* +* We plan to support multiple context per kdamond, as DAMON sysfs +* implies with 'nr_contexts' file. Nevertheless, only single context +* per kdamond is supported for now. So, we can simply use '0' context +* index here. +*/
Quoted 8 lines
mm/damon/core.c static void damos_apply_scheme(struct damon_ctx *c, struct damon_target *t, · line 964
Quoted 6 lines
mm/damon/core.c +6
-0+unsigned int cidx =0 ; +struct damos *siter;/* schemes iterator */ +unsigned int sidx =0 ; +struct damon_target *titer;/* targets iterator */ +unsigned int tidx =0 ; +If this loop is only for passing sidx and tidx to the trace point,
You're correct.
Quoted 18 lines
you can add around it:
if (trace_damos_before_apply_enabled()) {mm/damon/core.c static void damos_apply_scheme(struct damon_ctx *c, struct damon_target *t, · line 974
Quoted 10 lines
mm/damon/core.c +10
-0+damon_for_each_scheme (siter, c) { +if (siter == s) +break ; + sidx++; + } +damon_for_each_target (titer, c) { +if (titer == t) +break ; + tidx++; + }}
Quoted 1 line
And then this loop will only be done if that trace event is enabled.
Today I learned yet another great feature of the tracing framework. Thank you Steven, I will add that to the next spin of this patchset!
Quoted 23 lines
To prevent races, you may also want to add a third parameter, or initialize them to -1:
sidx = -1; if (trace_damo_before_apply_enabled()) { sidx = 0; [..] }And you can change the
TRACE_EVENT()TOTRACE_EVENT_CONDITION():TRACE_EVENT_CONDITION(damos_before_apply,
TP_PROTO(...), TP_ARGS(...), TP_CONDITION(sidx >= 0),and the trace event will not be called if sidx is less than zero.
Quoted 8 lines
Also, this if statement is only done when the trace event is enabled, so it's equivalent to:
if (trace_damos_before_apply_enabled()) { if (sdx >= 0) trace_damos_before_apply(cidx, sidx, tidx, r, damon_nr_regions(t)); }
Again, thank you very much for letting me know this awesome feature. However, sidx is supposed to be always >=0 here, since kdamond is running in single thread and hence no race is expected. If it exists, it's a bug. So, I wouldn't make this change. Appreciate again for letting me know this very useful feature, and please let me know if I'm missing something, though!
Thanks,
SJ
Quoted 23 lines
-- Steve
Quoted 17 lines
mm/damon/core.c +4
-1if (c->ops.apply_scheme) {if (quota->esz && quota->charged_sz + sz > quota->esz) {@@ -964,8 +986,11 @@ static void damos_apply_scheme(struct damon_ctx *c, struct damon_target *t,ktime_get_coarse_ts64 (&begin);if (c->callback.before_damos_apply) err = c->callback.before_damos_apply (c, t, r, s); -if (!err) +if (!err) { +trace_damos_before_apply (cidx, sidx, tidx, r, +damon_nr_regions (t)); sz_applied = c->ops.apply_scheme (c, t, r, s); + }ktime_get_coarse_ts64 (&end); quota->total_charged_ns +=timespec64_to_ns (&end) -timespec64_to_ns (&begin);
Steven Rostedt
maintainerRe: [PATCH 1/2] mm/damon/core: add a tracepoint for damos apply target regions
Quoted 9 lines · On Mon, 11 Sep 2023 19:05:04 +0000 SeongJae Park <[email protected]> wrote:
Quoted 8 lines
Also, this if statement is only done when the trace event is enabled, so it's equivalent to:
if (trace_damos_before_apply_enabled()) { if (sdx >= 0) trace_damos_before_apply(cidx, sidx, tidx, r, damon_nr_regions(t)); }
Quoted 5 lines
Again, thank you very much for letting me know this awesome feature. However, sidx is supposed to be always >=0 here, since kdamond is running in single thread and hence no race is expected. If it exists, it's a bug. So, I wouldn't make this change. Appreciate again for letting me know this very useful feature, and please let me know if I'm missing something, though!
The race isn't with your code, but the enabling of tracing.
Let's say you enable tracing just ass it passed the first:
if (trace_damos_before_apply_enabled()) {
damon_for_each_scheme(siter, c) {
if (siter == s)
break;
sidx++;
}
damon_for_each_target(titer, c) {
if (titer == t)
break;
tidx++;
} Now, sidx and tidx is zero (when they were not computed, thus, they shouldn't be zero.
Then tracing is fully enabled here, and now we enter:
if (trace_damos_before_apply_enabled()) {
trace_damos_before_apply(cidx, sidx, tidx, r,
damon_nr_regions(t));
}
Now the trace event is hit with sidx and tidx zero when they should not be. This could confuse you when looking at the report.
What I suggested was to initialize sidx to zero, set it in the first trace_*_enabled() check, and ignore calling the tracepoint if it's not >= 0.
-- Steve
SeongJae Park
maintainerRe: [PATCH 1/2] mm/damon/core: add a tracepoint for damos apply target regions
Quoted 45 lines · On Mon, 11 Sep 2023 16:31:27 -0400 Steven Rostedt <[email protected]> wrote:
Quoted 9 lines · On Mon, 11 Sep 2023 19:05:04 +0000 SeongJae Park <[email protected]> wrote:
Quoted 8 lines
Also, this if statement is only done when the trace event is enabled, so it's equivalent to:
if (trace_damos_before_apply_enabled()) { if (sdx >= 0) trace_damos_before_apply(cidx, sidx, tidx, r, damon_nr_regions(t)); }Quoted 5 lines
Again, thank you very much for letting me know this awesome feature. However, sidx is supposed to be always >=0 here, since kdamond is running in single thread and hence no race is expected. If it exists, it's a bug. So, I wouldn't make this change. Appreciate again for letting me know this very useful feature, and please let me know if I'm missing something, though!
The race isn't with your code, but the enabling of tracing.
Let's say you enable tracing just ass it passed the first:
if (trace_damos_before_apply_enabled()) { damon_for_each_scheme(siter, c) { if (siter == s) break; sidx++; } damon_for_each_target(titer, c) { if (titer == t) break; tidx++; }Now, sidx and tidx is zero (when they were not computed, thus, they shouldn't be zero.
Then tracing is fully enabled here, and now we enter:
if (
trace_damos_before_apply_enabled()) {
trace_damos_before_apply(cidx, sidx, tidx, r,(quoted diff) +0
-0damon_nr_regions(t)); }
Quoted 2 lines
Now the trace event is hit with sidx and tidx zero when they should not be. This could confuse you when looking at the report.
Thank you so much for enlightening me with this kind explanation, Steve! And this all make sense. I will follow your suggestion in the next spin.
Quoted 2 lines
What I suggested was to initialize sidx to zero,
Nit. Initialize to not zero but -1, right?
Quoted 5 lines
set it in the first trace_*_enabled() check, and ignore calling the tracepoint if it's not >= 0.
-- Steve
Thanks,
SJ
Steven Rostedt
maintainerRe: [PATCH 1/2] mm/damon/core: add a tracepoint for damos apply target regions
Quoted 10 lines · On Mon, 11 Sep 2023 20:36:42 +0000 SeongJae Park <[email protected]> wrote:
Quoted 9 lines
Then tracing is fully enabled here, and now we enter:
if (
trace_damos_before_apply_enabled()) {
trace_damos_before_apply(cidx, sidx, tidx, r,(quoted diff) +0
-0damon_nr_regions(t)); }Now the trace event is hit with sidx and tidx zero when they should not be. This could confuse you when looking at the report.
Quoted 7 lines
Thank you so much for enlightening me with this kind explanation, Steve! And this all make sense. I will follow your suggestion in the next spin.
Quoted 2 lines
What I suggested was to initialize sidx to zero,
Nit. Initialize to not zero but -1, right?
Yeah, but I was also thinking of the reset of it too :-p
sidx = -1;
if (trace_damos_before_apply_enabled()) {
sidx = 0;-- Steve
Quoted 4 lines
Quoted 4 lines
set it in the first trace_*_enabled() check, and ignore calling the tracepoint if it's not >= 0.
SeongJae Park
maintainerRe: [PATCH 1/2] mm/damon/core: add a tracepoint for damos apply target regions
Quoted 19 lines · On Mon, 11 Sep 2023 16:51:44 -0400 Steven Rostedt <[email protected]> wrote:
Quoted 16 lines · On Mon, 11 Sep 2023 20:36:42 +0000 SeongJae Park <[email protected]> wrote:
Quoted 9 lines
Then tracing is fully enabled here, and now we enter:
if (
trace_damos_before_apply_enabled()) {
trace_damos_before_apply(cidx, sidx, tidx, r,(quoted diff) +0
-0damon_nr_regions(t)); }Now the trace event is hit with sidx and tidx zero when they should not be. This could confuse you when looking at the report.
Thank you so much for enlightening me with this kind explanation, Steve! And this all make sense. I will follow your suggestion in the next spin.
Quoted 2 lines
What I suggested was to initialize sidx to zero,
Quoted 8 lines
Quoted 1 line
Nit. Initialize to not zero but -1, right?
Yeah, but I was also thinking of the reset of it too :-p
sidx = -1; if (trace_damos_before_apply_enabled()) { sidx = 0;
Thank you for clarifying, Steve :)
Nevertheless, since the variable is unsigned int, I would need to use UINT_MAX instead. To make the code easier to understand, I'd prefer to add a third parameter, as you suggested as another option at the original reply, like below:
mm/damon/core.c +3 -1
@@ -997,6 +997,7 @@ static void damos_apply_scheme(struct damon_ctx *c, struct damon_target *t,unsigned int sidx =0 ;struct damon_target *titer;/* targets iterator */ unsigned int tidx =0 ; +bool do_trace = false;/* get indices for trace_damos_before_apply() */ if (trace_damos_before_apply_enabled ()) {
@@ -1010,6 +1011,7 @@ static void damos_apply_scheme(struct damon_ctx *c, struct damon_target *t,break ; tidx++; } + do_trace = true; }if (c->ops.apply_scheme) {
@@ -1036,7 +1038,7 @@ static void damos_apply_scheme(struct damon_ctx *c, struct damon_target *t, err = c->callback.before_damos_apply (c, t, r, s);if (!err) {trace_damos_before_apply (cidx, sidx, tidx, r, -damon_nr_regions (t)); +damon_nr_regions (t), do_trace); sz_applied = c->ops.apply_scheme (c, t, r, s); }ktime_get_coarse_ts64 (&end);
Thanks,
SJ
Quoted 8 lines
-- Steve
Quoted 4 lines
Quoted 4 lines
set it in the first trace_*_enabled() check, and ignore calling the tracepoint if it's not >= 0.
Steven Rostedt
maintainerRe: [PATCH 1/2] mm/damon/core: add a tracepoint for damos apply target regions
Quoted 4 lines · On Tue, 12 Sep 2023 01:43:08 +0000 SeongJae Park <[email protected]> wrote:
Nevertheless, since the variable is unsigned int, I would need to use
UINT_MAXinstead. To make the code easier to understand, I'd prefer to add a third parameter, as you suggested as another option at the original reply, like below:
That works too.
-- Steve