Introduce Data Access MONitor (DAMON)
Subsystems (8)
v21 cover Introduce Data Access MONitor (DAMON)
From: SeongJae Park <[email protected]>
Changes from Previous Version (v20)
===================================
- s/snprintf()/scnprintf() (Marco Elver)
- Support multiple contexts for user space users (Shakeel Butt)
- Export pid of monitoring thread to user space (Shakeel Butt)
- Let coexistable with Idle Pages Tracking
- Place three parts of DAMON (core, primitives, and dbgfs) in different files
Introduction
============
DAMON is a data access monitoring framework for the Linux kernel. The core mechanisms of DAMON called 'region based sampling' and 'adaptive regions adjustment' (refer to 'mechanisms.rst' in the 11th patch of this patchset for the detail) make it
- accurate (The monitored information is useful for DRAM level memory management. It might not appropriate for Cache-level accuracy, though.),
- light-weight (The monitoring overhead is low enough to be applied online while making no impact on the performance of the target workloads.), and
- scalable (the upper-bound of the instrumentation overhead is controllable regardless of the size of target workloads.).
Using this framework, therefore, several memory management mechanisms such as reclamation and THP can be optimized to aware real data access patterns. Experimental access pattern aware memory management optimization works that incurring high instrumentation overhead will be able to have another try.
Though DAMON is for kernel subsystems, writing a DAMON-wrapper kernel subsystem exposing DAMON to user space is straightforward, due to DAMON's simple interface. Then, user space users who have some special workloads will be able to write personalized tools or applications for deeper understanding and specialized optimizations of their systems.
Evaluations
===========
We evaluated DAMON's overhead, monitoring quality and usefulness using 25 realistic workloads on my QEMU/KVM based virtual machine running a kernel that v20 DAMON patchset is applied.
DAMON is lightweight. It increases system memory usage by 0.12% and slows target workloads down by 1.39%.
DAMON is accurate and useful for memory management optimizations. An experimental DAMON-based operation scheme for THP, 'ethp', removes 88.16% of THP memory overheads while preserving 88.73% of THP speedup. Another experimental DAMON-based 'proactive reclamation' implementation, 'prcl', reduces 91.34% of residential sets and 25.59% of system memory footprint while incurring only 1.58% runtime overhead in the best case (parsec3/freqmine).
NOTE that the experimentail THP optimization and proactive reclamation are not for production but just only for proof of concepts.
Please refer to the official document[1] or "Documentation/admin-guide/mm: Add a document for DAMON" patch in this patchset for detailed evaluation setup and results.
[1] https://damonitor.github.io/doc/html/latest-damon/admin-guide/mm/damon/eval.html
Comparison with Idle Pages Tracking
===================================
Idle Pages Tracking allow users to set and read idleness of pages using a bitmap file which represents each page with each bit of the file. One recommended usage of it is working set size detection. Users can do that by
1. find PFN of all pages for workloads in interest,
2. set all the pages as idle by doing writes to the bitmap file,
3. wait until the workload accesses its working set, and
4. read the idleness of the pages again and count pages became not idle.
NOTE: DAMON is primarily for kernel code, but the interface can easily be exposed to user space. This section only assumes such user space use of DAMON.
For what use cases Idle Pages Tracking would be better?
-------------------------------------------------------
1. Page granularity working set size detection.
DAMON maintains additional metadata for each of the monitoring target regions. So, in this page granularity monitoring use case, DAMON would incur (number of monitoring target pages * sizeof metadata) memory overhead. Size of the single metadata item is about 54 bytes, so about 1.3% of monitoring target pages will be additionally used.
All essential metadata for Idle Page Tracking are embedded in 'struct page' and page table entries. Therefore, in this use case, only one counter variable for working set size account is additionally used.
There are more detail to consider, but roughly speaking, this is true in most cases.
2. Physical memory monitoring.
Idle Page Tracking receives PFN range as input, so natively supports physical memory monitoring.
DAMON is instead designed to be extensible for multiple address spaces and use cases by implementing and using primitives for the given use case. Therefore, by theory, DAMON has no limitation in the type of target address space as long as primitives for the given address space exists. However, this patchset provides only one implementation of primitives for virtual address spaces.
Therefore, for physical memory monitoring, you should implement your own primitives and use it, or simply use Idle Page Tracking.
Nonetheless, RFC patchsets[1] for the physical memory address space primitives is already available. It also support user memory same to Idle Page Tracking.
[1] https://lore.kernel.org/linux-mm/[email protected]/
For what use cases DAMON is better?
-----------------------------------
1. Hotness Monitoring.
Idle Page Tracking let users know only if a page frame is accessed or not. For hotness check, the user should write more code. DAMON do that by itself.
2. Low Monitoring Overhead
DAMON receives user's monitoring request with one step and then provide the results. So, roughly speaking, DAMON require only O(1) user/kernel context switches.
In case of Idle Page Tracking, however, because it works with contiguous page frames, the number of user/kernel context switches increases as the monitoring target becomes complex and huge. As a result, the context switch overhead could be not negligible.
Moreover, DAMON is born to handle with the monitoring overhead. Because the core mechanism is pure logical, Idle Page Tracking users might be able to implement the mechanism on thier own on the user space, but it would be time consuming. Also, the user/kernel context switching costs would not disappeared.
3. More future usecases
While Idle Page Tracking has tight coupling with base primitive (PG_Idle), DAMON is designed to be easily expandsble for many use cases and address spaces. If you need some special address type or want to use special h/w access check primitives, you can write your own primitives for that and configure DAMON with it. Therefore, if your use case could be changed a lot in future, using DAMON could be better.
Can I use both Idle Page Tracking and DAMON?
--------------------------------------------
Because DAMON could interfere Idle Page Tracking, v20 of this patchset made those exclusive in the kernel config. However, this patchset solves the problem. So, yes, you can use both Idle Page Tracking and DAMON on single system as you want.
More Information
================
We prepared a showcase web site[1] that you can get more information. There are
- the official documentations[2],
- the heatmap format dynamic access pattern of various realistic workloads for heap area[3], mmap()-ed area[4], and stack[5] area,
- the dynamic working set size distribution[6] and chronological working set size changes[7], and
- the latest performance test results[8].
[1] https://damonitor.github.io/_index
[2] https://damonitor.github.io/doc/html/latest-damon
[3] https://damonitor.github.io/test/result/visual/latest/rec.heatmap.0.png.html
[4] https://damonitor.github.io/test/result/visual/latest/rec.heatmap.1.png.html
[5] https://damonitor.github.io/test/result/visual/latest/rec.heatmap.2.png.html
[6] https://damonitor.github.io/test/result/visual/latest/rec.wss_sz.png.html
[7] https://damonitor.github.io/test/result/visual/latest/rec.wss_time.png.html
[8] https://damonitor.github.io/test/result/perf/latest/html/index.html
Baseline and Complete Git Trees
===============================
The patches are based on the v5.8. You can also clone the complete git tree:
$ git clone git://github.com/sjp38/linux -b damon/patches/v21
The web is also available:
https://github.com/sjp38/linux/releases/tag/damon/patches/v21
There are a couple of trees for entire DAMON patchset series. It includes future features. The first one[1] contains the changes for latest release, while the other one[2] contains the changes for next release.
[1] https://github.com/sjp38/linux/tree/damon/master
[2] https://github.com/sjp38/linux/tree/damon/next
Sequence Of Patches
===================
First four patches implement the target address space independent core logics of DAMON and it's programming interface. The 1st patch introduces DAMON data structures and functions for manipulation of the structures. Following three patches (2nd to 4th) implements the core mechanisms of DAMON, namely regions based sampling (patch 2), adaptive regions adjustment (patch 3), and dynamic memory mapping change adoption (patch 4).
Now the essential parts of DAMON is complete, but it cannot work unless someone provide primitives for specific use case. The following two patches make it just work for virtual address spaces monitoring. The 5th patch makes 'PG_idle' could be used by DAMON and the 6th patch implements the virtual memory address space specific low primitives using page table Accessed bits and the 'PG_idle' page flag. As use of 'PG_idle' could it interfere Idle Page Tracking, the primitives are configured to be exclusive with Idle Page Tracking.
As there are some cases Idle Page Tracking could do better, next two patches make DAMON coexistable with Idle Page Tracking. The 7th patch introduces a synchronization primitives for concurrent PG_Idle users, and the 8th patch makes the primitives for DAMON to synchronize with Idle Page Tracking using it.
Now DAMON just works for virtual address space monitoring via the kernel space api. Following six patches adds interfaces for the users in the user space. The 9th patch adds a tracepoint for other tracepoints supporting tracers. The 10th patch implements a DAMON application kernel module, namely damon-dbgfs, that exposes DAMON interface to the user space via the debugfs interface. To let user space get the monitoring results more easily, the 11th patch implement a simple recording feature in 'damon-dbgfs'. The 12nd patch further export pid of monitoring thread (kdamond) to user space for easier cpu usage account, and the 13rd patch makes the debugfs interface to support multiple contexts. Then, the 14th patch implements an user space tool to provide a minimal reference to the debugfs interface and for high level use/tests of the DAMON.
Three patches for maintainability follows. The 15th patch adds documentations for both the user space and the kernel space. The 16th patch provides unit tests (based on the kunit) while the 17th patch adds user space tests (based on the kselftest).
Finally, the last patch (18th) updates the MAINTAINERS file.
Patch History
=============
Changes from v20
(https://lore.kernel.org/linux-mm/[email protected]/)
- s/snprintf()/scnprintf() (Marco Elver)
- Support multiple contexts for user space users (Shakeel Butt)
- Export pid of monitoring thread to user space (Shakeel Butt)
- Let coexistable with Idle Pages Tracking
- Place three parts of DAMON (core, primitives, and dbgfs) in different files
Changes from v19
(https://lore.kernel.org/linux-mm/[email protected]/)
- Place 'CREATE_TRACE_POINTS' after '#include' statements (Steven Rostedt)
- Support large record file (Alkaid)
- Place 'put_pid()' of virtual monitoring targets in 'cleanup' callback
- Avoid conflict between concurrent DAMON users
- Update evaluation result document
Changes from v18
(https://lore.kernel.org/linux-mm/[email protected]/)
- Drop loadable module support (Mike Rapoport)
- Select PAGE_EXTENSION if !64BIT for 'set_page_young()'
- Take care of the MMU notification subscribers (Shakeel Butt)
- Substitute 'struct damon_task' with 'struct damon_target' for better abstract
- Use 'struct pid' instead of 'pid_t' as the target (Shakeel Butt)
- Support pidfd from the debugfs interface (Shakeel Butt)
- Fix typos (Greg Thelen)
- Properly isolate DAMON from other pmd/pte Accessed bit users (Greg Thelen)
- Rebase on v5.8
Changes from v17
(https://lore.kernel.org/linux-mm/[email protected]/)
- Reorganize the doc and remove png blobs (Mike Rapoport)
- Wordsmith mechnisms doc and commit messages
- tools/wss: Set default working set access frequency threshold
- Avoid race in damon deamon start
Changes from v16
(https://lore.kernel.org/linux-mm/[email protected]/)
- Wordsmith/cleanup the documentations and the code
- user space tool: Simplify the code and add wss option for reuse histogram
- recording: Check disablement condition properly
- recording: Force minimal recording buffer size (1KB)
Changes from v15
(https://lore.kernel.org/linux-mm/[email protected]/)
- Refine commit messages (David Hildenbrand)
- Optimizes three vma regions search (Varad Gautam)
- Support static granularity monitoring (Shakeel Butt)
- Cleanup code and re-organize the sequence of patches
Please refer to the v15 patchset to get older history.
SeongJae Park (18):
mm: Introduce Data Access MONitor (DAMON)
mm/damon: Implement region based sampling
mm/damon: Adaptively adjust regions
mm/damon: Track dynamic monitoring target regions update mm/idle_page_tracking: Make PG_(idle|young) reusable mm/damon: Implement primitives for the virtual memory address spaces mm/page_idle: Avoid interferences from concurrent users mm/damon/primitives: Make coexistable with Idle Page Tracking mm/damon: Add a tracepoint
mm/damon: Implement a debugfs-based user space interface mm/damon/dbgfs: Implement recording feature mm/damon/dbgfs: Export kdamond pid to the user space mm/damon/dbgfs: Support multiple contexts
tools: Introduce a minimal user-space tool for DAMON
Documentation: Add documents for DAMON
mm/damon: Add kunit tests
mm/damon: Add user space selftests
MAINTAINERS: Update for DAMON
Documentation/admin-guide/mm/damon/guide.rst | 157 +++ Documentation/admin-guide/mm/damon/index.rst | 15 + Documentation/admin-guide/mm/damon/plans.rst | 29 + Documentation/admin-guide/mm/damon/start.rst | 96 ++ Documentation/admin-guide/mm/damon/usage.rst | 302 ++++++ .../admin-guide/mm/idle_page_tracking.rst | 22 +- Documentation/admin-guide/mm/index.rst | 1 + Documentation/vm/damon/api.rst | 20 + Documentation/vm/damon/design.rst | 166 ++++ Documentation/vm/damon/eval.rst | 225 +++++ Documentation/vm/damon/faq.rst | 58 ++ Documentation/vm/damon/index.rst | 31 + Documentation/vm/index.rst | 1 + MAINTAINERS | 12 + include/linux/damon.h | 256 +++++ include/linux/page-flags.h | 4 +- include/linux/page_ext.h | 2 +- include/linux/page_idle.h | 8 +- include/trace/events/damon.h | 43 + include/trace/events/mmflags.h | 2 +- mm/Kconfig | 10 + mm/Makefile | 1 + mm/damon/Kconfig | 67 ++ mm/damon/Makefile | 5 + mm/damon/core-test.h | 253 +++++ mm/damon/core.c | 711 ++++++++++++++ mm/damon/dbgfs-test.h | 209 ++++ mm/damon/dbgfs.c | 918 ++++++++++++++++++ mm/damon/primitives-test.h | 328 +++++++ mm/damon/primitives.c | 595 ++++++++++++ mm/page_ext.c | 12 +- mm/page_idle.c | 50 +- tools/damon/.gitignore | 1 + tools/damon/_damon.py | 130 +++ tools/damon/_dist.py | 35 + tools/damon/_recfile.py | 23 + tools/damon/bin2txt.py | 67 ++ tools/damon/damo | 37 + tools/damon/heats.py | 362 +++++++ tools/damon/nr_regions.py | 91 ++ tools/damon/record.py | 135 +++ tools/damon/report.py | 45 + tools/damon/wss.py | 100 ++ tools/testing/selftests/damon/Makefile | 7 + .../selftests/damon/_chk_dependency.sh | 28 + tools/testing/selftests/damon/_chk_record.py | 109 +++ .../testing/selftests/damon/debugfs_attrs.sh | 161 +++ .../testing/selftests/damon/debugfs_record.sh | 50 + 48 files changed, 5966 insertions(+), 24 deletions(-) create mode 100644 Documentation/admin-guide/mm/damon/guide.rst create mode 100644 Documentation/admin-guide/mm/damon/index.rst create mode 100644 Documentation/admin-guide/mm/damon/plans.rst create mode 100644 Documentation/admin-guide/mm/damon/start.rst create mode 100644 Documentation/admin-guide/mm/damon/usage.rst create mode 100644 Documentation/vm/damon/api.rst create mode 100644 Documentation/vm/damon/design.rst create mode 100644 Documentation/vm/damon/eval.rst create mode 100644 Documentation/vm/damon/faq.rst create mode 100644 Documentation/vm/damon/index.rst create mode 100644 include/linux/damon.h create mode 100644 include/trace/events/damon.h create mode 100644 mm/damon/Kconfig create mode 100644 mm/damon/Makefile create mode 100644 mm/damon/core-test.h create mode 100644 mm/damon/core.c create mode 100644 mm/damon/dbgfs-test.h create mode 100644 mm/damon/dbgfs.c create mode 100644 mm/damon/primitives-test.h create mode 100644 mm/damon/primitives.c create mode 100644 tools/damon/.gitignore create mode 100644 tools/damon/_damon.py create mode 100644 tools/damon/_dist.py create mode 100644 tools/damon/_recfile.py create mode 100644 tools/damon/bin2txt.py create mode 100755 tools/damon/damo create mode 100644 tools/damon/heats.py create mode 100644 tools/damon/nr_regions.py create mode 100644 tools/damon/record.py create mode 100644 tools/damon/report.py create mode 100644 tools/damon/wss.py create mode 100644 tools/testing/selftests/damon/Makefile create mode 100644 tools/testing/selftests/damon/_chk_dependency.sh create mode 100644 tools/testing/selftests/damon/_chk_record.py create mode 100755 tools/testing/selftests/damon/debugfs_attrs.sh create mode 100755 tools/testing/selftests/damon/debugfs_record.sh
Signature · 1 line
2.17.1
PATCH v21 1/18 mm: Introduce Data Access MONitor (DAMON)
From: SeongJae Park <[email protected]>
DAMON is a data access monitoring framework for the Linux kernel. The core mechanisms of DAMON make it
- accurate (the monitoring output is useful enough for DRAM level performance-centric memory management; It might be inappropriate for CPU Cache levels, though),
- light-weight (the monitoring overhead is normally low enough to be applied online), and
- scalable (the upper-bound of the overhead is in constant range regardless of the size of target workloads).
Using this framework, hence, we can easily write efficient kernel space data access monitoring applications. For example, the kernel's memory management mechanisms can make advanced decisions using this. Experimental data access aware optimization works that incurring high access monitoring overhead could implemented again on top of this.
Due to its simple and flexible interface, providing user space interface would be also easy. Then, user space users who have some special workloads can write personalized applications for better understanding and optimizations of their workloads and systems.
That said, this commit is implementing only basic data structures and simple manipulation functions of the structures. The core mechanisms of DAMON will be implemented by following commits.
--- include/linux/damon.h | 95 +++++++++++++++++++++++++++++++++ mm/Kconfig | 2 + mm/Makefile | 1 + mm/damon/Kconfig | 15 ++++++ mm/damon/Makefile | 3 ++ mm/damon/core.c | 121 ++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 237 insertions(+) create mode 100644 include/linux/damon.h create mode 100644 mm/damon/Kconfig create mode 100644 mm/damon/Makefile create mode 100644 mm/damon/core.c
include/linux/damon.h new file +95 -0
@@ -0,0 +1,95 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* +* DAMON api +* +* Author: SeongJae Park <[email protected]> +*/ + +#ifndef _DAMON_H_ +#define _DAMON_H_ + +#include <linux/types.h> + +/** +* struct damon_addr_range - Represents an address region of [@start, @end). +* @start: Start address of the region (inclusive). +* @end: End address of the region (exclusive). +*/ +struct damon_addr_range { +unsigned long start; +unsigned long end; +}; + +/** +* struct damon_region - Represents a monitoring target region. +* @ar: The address range of the region. +* @nr_accesses: Access frequency of this region. +* @list: List head for siblings. +*/ +struct damon_region { +struct damon_addr_range ar; +unsigned int nr_accesses; +struct list_head list; +}; + +/** +* struct damon_target - Represents a monitoring target. +* @id: Unique identifier for this target. +* @regions_list: Head of the monitoring target regions of this target. +* @list: List head for siblings. +* +* Each monitoring context could have multiple targets. For example, a context +* for virtual memory address spaces could have multiple target processes. The +* @id of each target should be unique among the targets of the context. For +* example, in the virtual address monitoring context, it could be a pidfd or +* an address of an mm_struct. +*/ +struct damon_target { +unsigned long id; +struct list_head regions_list; +struct list_head list; +}; + +/** +* struct damon_ctx - Represents a context for each monitoring. +* @targets_list: Head of monitoring targets (&damon_target) list. +*/ +struct damon_ctx { +struct list_head targets_list;/* 'damon_target' objects */ +}; + +#define damon_next_region (r) \ + (container_of(r->list.next, struct damon_region, list)) + +#define damon_prev_region (r) \ + (container_of(r->list.prev, struct damon_region, list)) + +#define damon_for_each_region (r, t) \ + list_for_each_entry(r, &t->regions_list, list) + +#define damon_for_each_region_safe (r, next, t) \ + list_for_each_entry_safe(r, next, &t->regions_list, list) + +#define damon_for_each_target (t, ctx) \ + list_for_each_entry(t, &(ctx)->targets_list, list) + +#define damon_for_each_target_safe (t, next, ctx) \ + list_for_each_entry_safe(t, next, &(ctx)->targets_list, list) + +#ifdef CONFIG_DAMON + +struct damon_region *damon_new_region (unsigned long start,unsigned long end); +inline void damon_insert_region (struct damon_region *r, +struct damon_region *prev,struct damon_region *next); +void damon_add_region (struct damon_region *r,struct damon_target *t); +void damon_destroy_region (struct damon_region *r); + +struct damon_target *damon_new_target (unsigned long id); +void damon_add_target (struct damon_ctx *ctx,struct damon_target *t); +void damon_free_target (struct damon_target *t); +void damon_destroy_target (struct damon_target *t); +unsigned int damon_nr_regions (struct damon_target *t); + +#endif /* CONFIG_DAMON */ + +#endif
mm/Kconfig +2 -0
@@ -872,4 +872,6 @@ config ARCH_HAS_HUGEPD config MAPPING_DIRTY_HELPERS bool +source "mm/damon/Kconfig" + endmenu
mm/Makefile +1 -0
@@ -121,3 +121,4 @@ obj-$(CONFIG_MEMFD_CREATE) += memfd.o obj-$(CONFIG_MAPPING_DIRTY_HELPERS) += mapping_dirty_helpers.o obj-$(CONFIG_PTDUMP_CORE) += ptdump.o obj-$(CONFIG_PAGE_REPORTING) += page_reporting.o +obj-$(CONFIG_DAMON) += damon/
mm/damon/Kconfig new file +15 -0
@@ -0,0 +1,15 @@ +# SPDX-License-Identifier: GPL-2.0-only + +menu "Data Access Monitoring" + +config DAMON + bool "DAMON: Data Access Monitoring Framework" + help + This builds a framework that allows kernel subsystems to monitor + access frequency of each memory region. The information can be useful + for performance-centric DRAM level memory management. + + See https://damonitor.github.io/doc/html/latest-damon/index.html for + more information. + +endmenu
mm/damon/Makefile new file +3 -0
@@ -0,0 +1,3 @@ +# SPDX-License-Identifier: GPL-2.0 + +obj-$(CONFIG_DAMON) := core.o
mm/damon/core.c new file +121 -0
121 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v21 2/18 mm/damon: Implement region based sampling
In reply to SeongJae ParkFrom: SeongJae Park <[email protected]>
DAMON separates its monitoring target address space independent high level logics from the target space dependent low level primitives for flexible support of various address spaces.
This commit implements DAMON's target address space independent high level logics for basic access check and region based sampling. Hence, without the target address space specific parts implementations, this doesn't work alone. A reference implementation of those will be provided by a later commit.
Basic Access Check
==================
The output of DAMON says what pages are how frequently accessed for a given duration. The resolution of the access frequency is controlled by setting ``sampling interval`` and ``aggregation interval``. In detail, DAMON checks access to each page per ``sampling interval`` and aggregates the results. In other words, counts the number of the accesses to each page. After each ``aggregation interval`` passes, DAMON calls callback functions that previously registered by users so that users can read the aggregated results and then clears the results. This can be described in below simple pseudo-code::
while monitoring_on:
for page in monitoring_target:
if accessed(page):
nr_accesses[page] += 1
if time() % aggregation_interval == 0:
for callback in user_registered_callbacks:
callback(monitoring_target, nr_accesses)
for page in monitoring_target:
nr_accesses[page] = 0
sleep(sampling interval)
The monitoring overhead of this mechanism will arbitrarily increase as the size of the target workload grows.
Region Based Sampling
=====================
To avoid the unbounded increase of the overhead, DAMON groups adjacent pages that assumed to have the same access frequencies into a region. As long as the assumption (pages in a region have the same access frequencies) is kept, only one page in the region is required to be checked. Thus, for each ``sampling interval``, DAMON randomly picks one page in each region, waits for one ``sampling interval``, checks whether the page is accessed meanwhile, and increases the access frequency of the region if so. Therefore, the monitoring overhead is controllable by setting the number of regions. DAMON allows users to set the minimum and the maximum number of regions for the trade-off.
This scheme, however, cannot preserve the quality of the output if the assumption is not guaranteed. Next commit will address this problem.
--- include/linux/damon.h | 133 ++++++++++++++++- mm/damon/core.c | 333 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 465 insertions(+), 1 deletion(-)
include/linux/damon.h +132 -1
@@ -8,6 +8,8 @@#ifndef _DAMON_H_#define _DAMON_H_ +#include <linux/mutex.h> +#include <linux/time64.h> #include <linux/types.h> /**
@@ -23,11 +25,13 @@ struct damon_addr_range {/** * struct damon_region - Represents a monitoring target region. * @ar: The address range of the region. +* @sampling_addr: Address of the sample for the next access check. * @nr_accesses: Access frequency of this region. * @list: List head for siblings. */ struct damon_region {struct damon_addr_range ar; +unsigned long sampling_addr;unsigned int nr_accesses;struct list_head list; };
@@ -50,12 +54,130 @@ struct damon_target {struct list_head list; }; +struct damon_ctx ; +/** -* struct damon_ctx - Represents a context for each monitoring. +* struct damon_primitive Monitoring primitives for given use cases. +* +* @init_target_regions: Constructs initial monitoring target regions. +* @prepare_access_checks: Prepares next access check of target regions. +* @check_accesses: Checks the access of target regions. +* @target_valid: Determine if the target is valid. +* @cleanup: Cleans up the context. +* +* DAMON can be extended for various address spaces and usages. For this, +* users should register the low level primitives for their target address +* space and usecase via the &damon_ctx.primitive. Then, the monitoring thread +* calls @init_target_regions before starting the monitoring and +* @prepare_access_checks, @check_accesses, and @target_valid for each +* @sample_interval. +* +* @init_target_regions should construct proper monitoring target regions and +* link those to the DAMON context struct. +* @prepare_access_checks should manipulate the monitoring regions to be +* prepare for the next access check. +* @check_accesses should check the accesses to each region that made after the +* last preparation and update the `->nr_accesses` of each region. It should +* also return max &damon_region.nr_accesses that made as a result of its +* update. +* @target_valid should check whether the target is still valid for the +* monitoring. +* @cleanup is called from @kdamond just before its termination. After this +* call, only @kdamond_lock and @kdamond will be touched. +*/ +struct damon_primitive { +void (*init_target_regions)(struct damon_ctx *context); +void (*prepare_access_checks)(struct damon_ctx *context); +unsigned int (*check_accesses)(struct damon_ctx *context); +bool (*target_valid)(struct damon_target *target); +void (*cleanup)(struct damon_ctx *context); +}; + +/* +* struct damon_callback Monitoring events notification callbacks. +* +* @before_start: Called before starting the monitoring. +* @after_sampling: Called after each sampling. +* @after_aggregation: Called after each aggregation. +* @before_terminate: Called before terminating the monitoring. +* @private: User private data. +* +* The monitoring thread (&damon_ctx->kdamond) calls @before_start and +* @before_terminate just before starting the monitoring and just before +* finishing the monitoring. Therefore, those are good places for installing +* and cleaning @private. +* +* The monitoring thread calls @after_sampling and @after_aggregation for each +* of the sampling intervals and aggregation intervals, respectively. +* Therefore, users can safely access the monitoring results via +* &damon_ctx.targets_list without additional protection of +* damon_ctx.kdamond_lock. For the reason, users are recommended to use these +* callback for the accesses to the results. +* +* If any callback returns non-zero, monitoring stops. +*/ +struct damon_callback { +void *private; + +int (*before_start)(struct damon_ctx *context); +int (*after_sampling)(struct damon_ctx *context); +int (*after_aggregation)(struct damon_ctx *context); +int (*before_terminate)(struct damon_ctx *context); +}; + +/** +* struct damon_ctx - Represents a context for each monitoring. This is the +* main interface that allows users to set the attributes and get the results +* of the monitoring. +* +* @sample_interval: The time between access samplings. +* @aggr_interval: The time between monitor results aggregations. +* @nr_regions: The number of monitoring regions. +* +* For each @sample_interval, DAMON checks whether each region is accessed or +* not. It aggregates and keeps the access information (number of accesses to +* each region) for @aggr_interval time. All time intervals are in +* micro-seconds. +* +* @kdamond: Kernel thread who does the monitoring. +* @kdamond_stop: Notifies whether kdamond should stop. +* @kdamond_lock: Mutex for the synchronizations with @kdamond. +* +* For each monitoring context, one kernel thread for the monitoring is +* created. The pointer to the thread is stored in @kdamond. +* +* Once started, the monitoring thread runs until explicitly required to be +* terminated or every monitoring target is invalid. The validity of the +* targets is checked via the @target_valid callback. The termination can also +* be explicitly requested by writing non-zero to @kdamond_stop. The thread +* sets @kdamond to NULL when it terminates. Therefore, users can know whether +* the monitoring is ongoing or terminated by reading @kdamond. Reads and +* writes to @kdamond and @kdamond_stop from outside of the monitoring thread +* must be protected by @kdamond_lock. +* +* Note that the monitoring thread protects only @kdamond and @kdamond_stop via +* @kdamond_lock. Accesses to other fields must be protected by themselves. +* * @targets_list: Head of monitoring targets (&damon_target) list. +* +* @primitive: Set of monitoring primitives for given use cases. +* @callback: Set of callbacks for monitoring events notifications. */ struct damon_ctx { +unsigned long sample_interval; +unsigned long aggr_interval; +unsigned long nr_regions; + +struct timespec64 last_aggregation; + +struct task_struct *kdamond; +bool kdamond_stop; +struct mutex kdamond_lock; +struct list_head targets_list;/* 'damon_target' objects */ + +struct damon_primitive primitive; +struct damon_callback callback; };#define damon_next_region (r) \
@@ -90,6 +212,15 @@ void damon_free_target(struct damon_target *t);void damon_destroy_target (struct damon_target *t);unsigned int damon_nr_regions (struct damon_target *t); +int damon_set_targets (struct damon_ctx *ctx, +unsigned long *ids,ssize_t nr_ids); +int damon_set_attrs (struct damon_ctx *ctx,unsigned long sample_int, +unsigned long aggr_int,unsigned long nr_reg); + +int damon_nr_running_ctxs (void ); +int damon_start (struct damon_ctx **ctxs,int nr_ctxs); +int damon_stop (struct damon_ctx **ctxs,int nr_ctxs); +#endif /* CONFIG_DAMON */ #endif
mm/damon/core.c +333 -0
348 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v21 3/18 mm/damon: Adaptively adjust regions
In reply to SeongJae ParkFrom: SeongJae Park <[email protected]>
Even somehow the initial monitoring target regions are well constructed to fulfill the assumption (pages in same region have similar access frequencies), the data access pattern can be dynamically changed. This will result in low monitoring quality. To keep the assumption as much as possible, DAMON adaptively merges and splits each region based on their access frequency.
For each ``aggregation interval``, it compares the access frequencies of adjacent regions and merges those if the frequency difference is small. Then, after it reports and clears the aggregated access frequency of each region, it splits each region into two or three regions if the total number of regions will not exceed the user-specified maximum number of regions after the split.
In this way, DAMON provides its best-effort quality and minimal overhead while keeping the upper-bound overhead that users set.
--- include/linux/damon.h | 11 ++- mm/damon/core.c | 196 ++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 195 insertions(+), 12 deletions(-)
include/linux/damon.h +7 -4
@@ -132,7 +132,8 @@ struct damon_callback {* * @sample_interval: The time between access samplings. * @aggr_interval: The time between monitor results aggregations. -* @nr_regions: The number of monitoring regions. +* @min_nr_regions: The minimum number of monitoring regions. +* @max_nr_regions: The maximum number of monitoring regions. * * For each @sample_interval, DAMON checks whether each region is accessed or * not. It aggregates and keeps the access information (number of accesses to
@@ -166,7 +167,8 @@ struct damon_callback {struct damon_ctx {unsigned long sample_interval;unsigned long aggr_interval; -unsigned long nr_regions; +unsigned long min_nr_regions; +unsigned long max_nr_regions;struct timespec64 last_aggregation;
@@ -214,8 +216,9 @@ unsigned int damon_nr_regions(struct damon_target *t);int damon_set_targets (struct damon_ctx *ctx,unsigned long *ids,ssize_t nr_ids); -int damon_set_attrs (struct damon_ctx *ctx,unsigned long sample_int, -unsigned long aggr_int,unsigned long nr_reg); +int damon_set_attrs (struct damon_ctx *ctx, +unsigned long sample_int,unsigned long aggr_int, +unsigned long min_nr_reg,unsigned long max_nr_reg);int damon_nr_running_ctxs (void );int damon_start (struct damon_ctx **ctxs,int nr_ctxs);
mm/damon/core.c +188 -8
258 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v21 4/18 mm/damon: Track dynamic monitoring target regions update
In reply to SeongJae ParkFrom: SeongJae Park <[email protected]>
The monitoring target address range can be dynamically changed. For example, virtual memory could be dynamically mapped and unmapped. Physical memory could be hot-plugged.
As the changes could be quite frequent in some cases, DAMON checks the dynamic memory mapping changes and applies it to the abstracted target area only for each of a user-specified time interval, ``regions update interval``.
--- include/linux/damon.h | 21 ++++++++++++++++----- mm/damon/core.c | 22 ++++++++++++++++++++-- 2 files changed, 36 insertions(+), 7 deletions(-)
include/linux/damon.h +16 -5
@@ -60,6 +60,7 @@ struct damon_ctx;* struct damon_primitive Monitoring primitives for given use cases. * * @init_target_regions: Constructs initial monitoring target regions. +* @update_target_regions: Updates monitoring target regions. * @prepare_access_checks: Prepares next access check of target regions. * @check_accesses: Checks the access of target regions. * @target_valid: Determine if the target is valid.
@@ -68,12 +69,17 @@ struct damon_ctx;* DAMON can be extended for various address spaces and usages. For this, * users should register the low level primitives for their target address * space and usecase via the &damon_ctx.primitive. Then, the monitoring thread -* calls @init_target_regions before starting the monitoring and +* calls @init_target_regions before starting the monitoring, +* @update_target_regions for each @regions_update_interval, and * @prepare_access_checks, @check_accesses, and @target_valid for each * @sample_interval. +* * @init_target_regions should construct proper monitoring target regions and * link those to the DAMON context struct. +* @update_target_regions should update the monitoring target regions for +* current status. +* @prepare_access_checks should manipulate the monitoring regions to be * prepare for the next access check. * @check_accesses should check the accesses to each region that made after the
@@ -87,6 +93,7 @@ struct damon_ctx;*/ struct damon_primitive {void (*init_target_regions)(struct damon_ctx *context); +void (*update_target_regions)(struct damon_ctx *context);void (*prepare_access_checks)(struct damon_ctx *context);unsigned int (*check_accesses)(struct damon_ctx *context);bool (*target_valid)(struct damon_target *target);
@@ -132,13 +139,15 @@ struct damon_callback {* * @sample_interval: The time between access samplings. * @aggr_interval: The time between monitor results aggregations. +* @regions_update_interval: The time between monitor regions updates. * @min_nr_regions: The minimum number of monitoring regions. * @max_nr_regions: The maximum number of monitoring regions. * * For each @sample_interval, DAMON checks whether each region is accessed or * not. It aggregates and keeps the access information (number of accesses to -* each region) for @aggr_interval time. All time intervals are in -* micro-seconds. +* each region) for @aggr_interval time. DAMON also checks whether the target +* memory regions need update (e.g., by ``mmap()`` calls from the application, +* @regions_update_interval. All time intervals are in micro-seconds. * * @kdamond: Kernel thread who does the monitoring. * @kdamond_stop: Notifies whether kdamond should stop.
@@ -167,10 +176,12 @@ struct damon_callback {struct damon_ctx {unsigned long sample_interval;unsigned long aggr_interval; +unsigned long regions_update_interval;unsigned long min_nr_regions;unsigned long max_nr_regions;struct timespec64 last_aggregation; +struct timespec64 last_regions_update;struct task_struct *kdamond;bool kdamond_stop;
@@ -216,8 +227,8 @@ unsigned int damon_nr_regions(struct damon_target *t);int damon_set_targets (struct damon_ctx *ctx,unsigned long *ids,ssize_t nr_ids); -int damon_set_attrs (struct damon_ctx *ctx, -unsigned long sample_int,unsigned long aggr_int, +int damon_set_attrs (struct damon_ctx *ctx,unsigned long sample_int, +unsigned long aggr_int,unsigned long regions_update_int,unsigned long min_nr_reg,unsigned long max_nr_reg);int damon_nr_running_ctxs (void );
mm/damon/core.c +20 -2
@@ -167,6 +167,7 @@ int damon_set_targets(struct damon_ctx *ctx,* damon_set_attrs() - Set attributes for the monitoring. * @ctx: monitoring context * @sample_int: time interval between samplings +* @regions_update_int: time interval between target regions update * @aggr_int: time interval between aggregations * @min_nr_reg: minimal number of regions * @max_nr_reg: maximum number of regions
@@ -176,8 +177,8 @@ int damon_set_targets(struct damon_ctx *ctx,* * Return: 0 on success, negative error code otherwise. */ -int damon_set_attrs (struct damon_ctx *ctx, -unsigned long sample_int,unsigned long aggr_int, +int damon_set_attrs (struct damon_ctx *ctx,unsigned long sample_int, +unsigned long aggr_int,unsigned long regions_update_int,unsigned long min_nr_reg,unsigned long max_nr_reg) {if (min_nr_reg <3 ) {
@@ -193,6 +194,7 @@ int damon_set_attrs(struct damon_ctx *ctx, ctx->sample_interval = sample_int; ctx->aggr_interval = aggr_int; + ctx->regions_update_interval = regions_update_int; ctx->min_nr_regions = min_nr_reg; ctx->max_nr_regions = max_nr_reg;
@@ -529,6 +531,17 @@ static void kdamond_split_regions(struct damon_ctx *ctx) last_nr_regions = nr_regions; } +/* +* Check whether it is time to check and apply the target monitoring regions +* +* Returns true if it is. +*/ +static bool kdamond_need_update_regions (struct damon_ctx *ctx) +{ +return damon_check_reset_time_interval (&ctx->last_regions_update, + ctx->regions_update_interval); +} +/* * Check whether current monitoring should be stopped *
@@ -612,6 +625,11 @@ static int kdamond_fn(void *data)kdamond_reset_aggregated (ctx);kdamond_split_regions (ctx); } + +if (kdamond_need_update_regions (ctx)) { +kdamond_call_prmt (ctx, update_target_regions); + sz_limit =damon_region_sz_limit (ctx); + } }damon_for_each_target (t, ctx) {damon_for_each_region_safe (r, next, t)
Signature · 1 line
2.17.1
PATCH v21 5/18 mm/idle_page_tracking: Make PG_(idle|young) reusable
In reply to SeongJae ParkFrom: SeongJae Park <[email protected]>
PG_idle and PG_young allows the two PTE Accessed bit users, IDLE_PAGE_TRACKING and the reclaim logic concurrently work while don't interfere each other. That is, when they need to clear the Accessed bit, they set PG_young and PG_idle to represent the previous state of the bit, respectively. And when they need to read the bit, if the bit is cleared, they further read the PG_young and PG_idle, respectively, to know whether the other has cleared the bit meanwhile or not.
We could add another page flag and extend the mechanism to use the flag if we need to add another concurrent PTE Accessed bit user subsystem. However, it would be only waste the space. Instead, if the new subsystem is mutually exclusive with IDLE_PAGE_TRACKING, it could simply reuse the PG_idle flag. However, it's impossible because the flags are dependent on IDLE_PAGE_TRACKING.
To allow such reuse of the flags, this commit separates the PG_young and PG_idle flag logic from IDLE_PAGE_TRACKING and introduces new kernel config, 'PAGE_IDLE_FLAG'. Hence, if !IDLE_PAGE_TRACKING and IDLE_PAGE_FLAG, a new subsystem would be able to reuse PG_idle.
In the next commit, DAMON's reference implementation of the virtual memory address space monitoring primitives will use it.
--- include/linux/page-flags.h | 4 ++-- include/linux/page_ext.h | 2 +- include/linux/page_idle.h | 6 +++--- include/trace/events/mmflags.h | 2 +- mm/Kconfig | 8 ++++++++ mm/page_ext.c | 12 +++++++++++- mm/page_idle.c | 10 ---------- 7 files changed, 26 insertions(+), 18 deletions(-)
include/linux/page-flags.h +2 -2
@@ -132,7 +132,7 @@ enum pageflags {#ifdef CONFIG_MEMORY_FAILURE PG_hwpoison, /* hardware poisoned page. Don't touch */#endif -#if defined(CONFIG_IDLE_PAGE_TRACKING ) && defined(CONFIG_64BIT ) +#if defined(CONFIG_PAGE_IDLE_FLAG ) && defined(CONFIG_64BIT ) PG_young, PG_idle,#endif
@@ -432,7 +432,7 @@ static inline bool set_hwpoison_free_buddy_page(struct page *page)#define __PG_HWPOISON 0#endif -#if defined(CONFIG_IDLE_PAGE_TRACKING ) && defined(CONFIG_64BIT ) +#if defined(CONFIG_PAGE_IDLE_FLAG ) && defined(CONFIG_64BIT ) TESTPAGEFLAG(Young, young, PF_ANY) SETPAGEFLAG(Young, young, PF_ANY)TESTCLEARFLAG (Young, young,PF_ANY )
include/linux/page_ext.h +1 -1
@@ -19,7 +19,7 @@ struct page_ext_operations {enum page_ext_flags {PAGE_EXT_OWNER ,PAGE_EXT_OWNER_ALLOCATED , -#if defined(CONFIG_IDLE_PAGE_TRACKING ) && !defined(CONFIG_64BIT ) +#if defined(CONFIG_PAGE_IDLE_FLAG ) && !defined(CONFIG_64BIT )PAGE_EXT_YOUNG ,PAGE_EXT_IDLE ,#endif
include/linux/page_idle.h +3 -3
@@ -6,7 +6,7 @@#include <linux/page-flags.h> #include <linux/page_ext.h> -#ifdef CONFIG_IDLE_PAGE_TRACKING +#ifdef CONFIG_PAGE_IDLE_FLAG #ifdef CONFIG_64BIT static inline bool page_is_young (struct page *page)
@@ -106,7 +106,7 @@ static inline void clear_page_idle(struct page *page) }#endif /* CONFIG_64BIT */ -#else /* !CONFIG_IDLE_PAGE_TRACKING */ +#else /* !CONFIG_PAGE_IDLE_FLAG */ static inline bool page_is_young (struct page *page) {
@@ -135,6 +135,6 @@ static inline void clear_page_idle(struct page *page) { } -#endif /* CONFIG_IDLE_PAGE_TRACKING */ +#endif /* CONFIG_PAGE_IDLE_FLAG */ #endif /* _LINUX_MM_PAGE_IDLE_H */
include/trace/events/mmflags.h +1 -1
@@ -73,7 +73,7 @@#define IF_HAVE_PG_HWPOISON (flag,string)#endif -#if defined(CONFIG_IDLE_PAGE_TRACKING ) && defined(CONFIG_64BIT ) +#if defined(CONFIG_PAGE_IDLE_FLAG ) && defined(CONFIG_64BIT )#define IF_HAVE_PG_IDLE (flag,string) ,{1UL << flag, string}#else #define IF_HAVE_PG_IDLE (flag,string)
mm/Kconfig +8 -0
@@ -765,10 +765,18 @@ config DEFERRED_STRUCT_PAGE_INIT lifetime of the system until these kthreads finish the initialisation. +config PAGE_IDLE_FLAG + bool "Add PG_idle and PG_young flags" + help + This feature adds PG_idle and PG_young flags in 'struct page'. PTE + Accessed bit writers can set the state of the bit in the flags to let + other PTE Accessed bit readers don't disturbed. + config IDLE_PAGE_TRACKING bool "Enable idle page tracking" depends on SYSFS && MMU select PAGE_EXTENSION if !64BIT + select PAGE_IDLE_FLAG help This feature allows to estimate the amount of user pages that have not been touched during a given period of time. This information can
mm/page_ext.c +11 -1
@@ -58,11 +58,21 @@* can utilize this callback to initialize the state of it correctly. */ +#if defined(CONFIG_PAGE_IDLE_FLAG ) && !defined(CONFIG_64BIT ) +static bool need_page_idle (void ) +{ +return true; +} +struct page_ext_operations page_idle_ops = { + .need = need_page_idle, +}; +#endif +static struct page_ext_operations *page_ext_ops[] = { #ifdef CONFIG_PAGE_OWNER &page_owner_ops, #endif -#if defined(CONFIG_IDLE_PAGE_TRACKING) && !defined(CONFIG_64BIT) +#if defined(CONFIG_PAGE_IDLE_FLAG) && !defined(CONFIG_64BIT) &page_idle_ops, #endif };
mm/page_idle.c +0 -10
@@ -211,16 +211,6 @@ static const struct attribute_group page_idle_attr_group = { .name = "page_idle", }; -#ifndef CONFIG_64BIT -static bool need_page_idle (void ) -{ -return true; -} -struct page_ext_operations page_idle_ops = { - .need = need_page_idle, -}; -#endif -static int __init page_idle_init (void ) {int err;
Signature · 1 line
2.17.1
PATCH v21 6/18 mm/damon: Implement primitives for the virtual memory address spaces
In reply to SeongJae ParkFrom: SeongJae Park <[email protected]>
This commit introduces a reference implementation of the address space specific low level primitives for the virtual address space, so that users of DAMON can easily monitor the data accesses on virtual address spaces of specific processes by simply configuring the implementation to be used by DAMON.
The low level primitives for the fundamental access monitoring are defined in two parts:
1. Identification of the monitoring target address range for the address space.
2. Access check of specific address range in the target space.
The reference implementation for the virtual address space provided by this commit is designed as below.
PTE Accessed-bit Based Access Check
-----------------------------------
The implementation uses PTE Accessed-bit for basic access checks. That is, it clears the bit for next sampling target page and checks whether it set again after one sampling period. This could disturb other kernel subsystems using the Accessed bits, namely Idle page tracking and the reclaim logic. To avoid such disturbances, DAMON makes it mutually exclusive with Idle page tracking and uses ``PG_idle`` and ``PG_young`` page flags to solve the conflict with the reclaim logics, as Idle page tracking does.
VMA-based Target Address Range Construction
-------------------------------------------
Only small parts in the super-huge virtual address space of the processes are mapped to physical memory and accessed. Thus, tracking the unmapped address regions is just wasteful. However, because DAMON can deal with some level of noise using the adaptive regions adjustment mechanism, tracking every mapping is not strictly required but could even incur a high overhead in some cases. That said, too huge unmapped areas inside the monitoring target should be removed to not take the time for the adaptive mechanism.
For the reason, this implementation converts the complex mappings to three distinct regions that cover every mapped area of the address space. Also, the two gaps between the three regions are the two biggest unmapped areas in the given address space. The two biggest unmapped areas would be the gap between the heap and the uppermost mmap()-ed region, and the gap between the lowermost mmap()-ed region and the stack in most of the cases. Because these gaps are exceptionally huge in usual address spacees, excluding these will be sufficient to make a reasonable trade-off. Below shows this in detail::
<heap>
<BIG UNMAPPED REGION 1>
<uppermost mmap()-ed region>
(small mmap()-ed regions and munmap()-ed regions) <lowermost mmap()-ed region>
<BIG UNMAPPED REGION 2>
<stack>
--- include/linux/damon.h | 14 + mm/damon/Kconfig | 10 + mm/damon/Makefile | 1 + mm/damon/primitives.c | 582 ++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 607 insertions(+) create mode 100644 mm/damon/primitives.c
include/linux/damon.h +14 -0
@@ -237,4 +237,18 @@ int damon_stop(struct damon_ctx **ctxs, int nr_ctxs);#endif /* CONFIG_DAMON */ +#ifdef CONFIG_DAMON_PRIMITIVES + +/* Reference callback implementations for virtual memory */ +void damon_va_init_regions (struct damon_ctx *ctx); +void damon_va_update_regions (struct damon_ctx *ctx); +void damon_va_prepare_access_checks (struct damon_ctx *ctx); +unsigned int damon_va_check_accesses (struct damon_ctx *ctx); +bool damon_va_target_valid (struct damon_target *t); +void damon_va_cleanup (struct damon_ctx *ctx); +void damon_va_set_primitives (struct damon_ctx *ctx); + +#endif /* CONFIG_DAMON_PRIMITIVES */ + +#endif
mm/damon/Kconfig +10 -0
@@ -12,4 +12,14 @@ config DAMON See https://damonitor.github.io/doc/html/latest-damon/index.html for more information. +config DAMON_PRIMITIVES + bool "Monitoring primitives for virtual address spaces monitoring" + depends on DAMON && MMU && !IDLE_PAGE_TRACKING + select PAGE_EXTENSION if !64BIT + select PAGE_IDLE_FLAG + help + This builds the default data access monitoring primitives for DAMON. + The primitives support only virtual address spaces. If this cannot + cover your use case, you can implement and use your own primitives. + endmenu
mm/damon/Makefile +1 -0
@@ -1,3 +1,4 @@ # SPDX-License-Identifier: GPL-2.0 obj-$(CONFIG_DAMON) := core.o +obj-$(CONFIG_DAMON_PRIMITIVES) += primitives.o
mm/damon/primitives.c new file +582 -0
582 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v21 7/18 mm/page_idle: Avoid interferences from concurrent users
In reply to SeongJae ParkFrom: SeongJae Park <[email protected]>
Concurrent Idle Page Tracking users can interfere each other because the interface doesn't provide a central rule for synchronization between the users. Users could implement their own synchronization rule, but even in that case, applications developed by different users would not know how to synchronize with others. To help this situation, this commit introduces a centralized synchronization infrastructure of Idle Page Tracking.
In detail, this commit introduces a mutex lock for Idle Page Tracking, called 'page_idle_lock'. It is exposed to user space via a new bool sysfs file, '/sys/kernel/mm/page_idle/lock'. By writing to and reading from the file, users can hold/release and read status of the mutex. Writes to the Idle Page Tracking 'bitmap' file fails if the lock is not held, while reads of the file can be done regardless of the lock status.
Note that users could still interfere each other if they abuse this locking rule. Nevertheless, this change will let them notice the rule.
--- .../admin-guide/mm/idle_page_tracking.rst | 22 +++++++--- mm/page_idle.c | 40 +++++++++++++++++++ 2 files changed, 56 insertions(+), 6 deletions(-)
Documentation/admin-guide/mm/idle_page_tracking.rst +16 -6
@@ -21,13 +21,13 @@ User API ======== The idle page tracking API is located at ``/sys/kernel/mm/page_idle``. -Currently, it consists of the only read-write file, -``/sys/kernel/mm/page_idle/bitmap``. +Currently, it consists of two read-write file, +``/sys/kernel/mm/page_idle/bitmap`` and ``/sys/kernel/mm/page_idle/lock``. -The file implements a bitmap where each bit corresponds to a memory page. The -bitmap is represented by an array of 8-byte integers, and the page at PFN #i is -mapped to bit #i%64 of array element #i/64, byte order is native. When a bit is -set, the corresponding page is idle. +The ``bitmap`` file implements a bitmap where each bit corresponds to a memory +page. The bitmap is represented by an array of 8-byte integers, and the page at +PFN #i is mapped to bit #i%64 of array element #i/64, byte order is native. +When a bit is set, the corresponding page is idle. A page is considered idle if it has not been accessed since it was marked idle (for more details on what "accessed" actually means see the :ref:`Implementation
@@ -74,6 +74,16 @@ See :ref:`Documentation/admin-guide/mm/pagemap.rst <pagemap>` for more information about ``/proc/pid/pagemap``, ``/proc/kpageflags``, and ``/proc/kpagecgroup``. +The ``lock`` file is for avoidance of interference from concurrent users. If +the content of the ``lock`` file is ``1``, it means the ``bitmap`` file is +currently being used by someone. While the content of the ``lock`` file is +``1``, writing ``1`` to the file fails. Therefore, users should first +successfully write ``1`` to the ``lock`` file before starting use of ``bitmap`` +file and write ``0`` to the ``lock`` file after they finished use of the +``bitmap`` file. If a user writes the ``bitmap`` file while the ``lock`` is +``0``, the write fails. Meanwhile, reads of the ``bitmap`` file success +regardless of the ``lock`` status. + .. _impl_details: Implementation Details
mm/page_idle.c +40 -0
@@ -16,6 +16,8 @@#define BITMAP_CHUNK_SIZE sizeof(u64)#define BITMAP_CHUNK_BITS (BITMAP_CHUNK_SIZE * BITS_PER_BYTE) +static DEFINE_MUTEX (page_idle_lock); +/* * Idle page tracking only considers user memory pages, for other types of * pages the idle flag is always unset and an attempt to set it is silently
@@ -169,6 +171,9 @@ static ssize_t page_idle_bitmap_write(struct file *file, struct kobject *kobj,unsigned long pfn, end_pfn;int bit; +if (!mutex_is_locked (&page_idle_lock)) +return -EPERM ; +if (pos %BITMAP_CHUNK_SIZE || count %BITMAP_CHUNK_SIZE )return -EINVAL ;
@@ -197,17 +202,52 @@ static ssize_t page_idle_bitmap_write(struct file *file, struct kobject *kobj,return (char *)in - buf; } +static ssize_t page_idle_lock_show (struct kobject *kobj, +struct kobj_attribute *attr,char *buf) +{ +return sprintf (buf,"%d\n" ,mutex_is_locked (&page_idle_lock)); +} + +static ssize_t page_idle_lock_store (struct kobject *kobj, +struct kobj_attribute *attr,const char *buf,size_t count) +{ +bool do_lock; +int ret; + + ret =kstrtobool (buf, &do_lock); +if (ret <0 ) +return ret; + +if (do_lock) { +if (!mutex_trylock (&page_idle_lock)) +return -EBUSY ; + }else { +mutex_unlock (&page_idle_lock); + } + +return count; +} +static struct bin_attribute page_idle_bitmap_attr =__BIN_ATTR (bitmap,0600 , page_idle_bitmap_read, page_idle_bitmap_write,0 ); +static struct kobj_attribute page_idle_lock_attr = +__ATTR (lock,0600 , page_idle_lock_show, page_idle_lock_store); +static struct bin_attribute *page_idle_bin_attrs[] = { &page_idle_bitmap_attr,NULL , }; +static struct attribute *page_idle_lock_attrs[] = { + &page_idle_lock_attr.attr, +NULL , +}; +static const struct attribute_group page_idle_attr_group = { .bin_attrs = page_idle_bin_attrs, + .attrs = page_idle_lock_attrs, .name ="page_idle" , };
Signature · 1 line
2.17.1
PATCH v21 8/18 mm/damon/primitives: Make coexistable with Idle Page Tracking
In reply to SeongJae ParkFrom: SeongJae Park <[email protected]>
DAMON's reference 'primitives' internally use 'PG_Idle' flag. Because the flag is also used by Idle Page Tracking but there was no way to synchronize with it, the 'primitives' were configured to be exclusive with Idle Page Tracking before. However, as we can now synchronize with Idle Page Tracking using 'idle_page_lock', this commit makes the primitives to do the synchronization and coexistable with Idle Page Tracking.
Note that the 'primitives' only require the users to do the synchronization by themselves.
--- include/linux/page_idle.h | 2 ++ mm/damon/Kconfig | 2 +- mm/damon/primitives.c | 7 +++++++ mm/page_idle.c | 2 +- 4 files changed, 11 insertions(+), 2 deletions(-)
include/linux/page_idle.h +2 -0
@@ -8,6 +8,8 @@ #ifdef CONFIG_PAGE_IDLE_FLAG +extern struct mutex page_idle_lock; + #ifdef CONFIG_64BIT static inline bool page_is_young(struct page *page) {
mm/damon/Kconfig +1 -1
@@ -14,7 +14,7 @@ config DAMON config DAMON_PRIMITIVES bool "Monitoring primitives for virtual address spaces monitoring" - depends on DAMON && MMU && !IDLE_PAGE_TRACKING + depends on DAMON && MMU select PAGE_EXTENSION if !64BIT select PAGE_IDLE_FLAG help
mm/damon/primitives.c +7 -0
@@ -15,6 +15,10 @@#include <linux/sched/mm.h> #include <linux/slab.h> +#ifndef CONFIG_IDLE_PAGE_TRACKING +DEFINE_MUTEX (page_idle_lock); +#endif +/* Minimal region size. Every damon_region is aligned by this. */ #define MIN_REGION PAGE_SIZE
@@ -552,6 +556,9 @@ bool damon_va_target_valid(struct damon_target *t) {struct task_struct *task; +if (!mutex_is_locked (&page_idle_lock)) +return false; + task =damon_get_task_struct (t);if (task) {put_task_struct (task);
mm/page_idle.c +1 -1
@@ -16,7 +16,7 @@#define BITMAP_CHUNK_SIZE sizeof(u64)#define BITMAP_CHUNK_BITS (BITMAP_CHUNK_SIZE * BITS_PER_BYTE) -static DEFINE_MUTEX (page_idle_lock); +DEFINE_MUTEX (page_idle_lock);/* * Idle page tracking only considers user memory pages, for other types of
Signature · 1 line
2.17.1
kernel test robot
build botRe: [PATCH v21 08/18] mm/damon/primitives: Make coexistable with Idle Page Tracking
Thank you for the patch! Perhaps something to improve:
Hi SeongJae,
Thank you for the patch! Perhaps something to improve:
[auto build test WARNING on hnaz-linux-mm/master]
[also build test WARNING on kselftest/next tip/perf/core linus/master v5.9-rc8 next-20201002] [If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]
url: https://github.com/0day-ci/linux/commits/SeongJae-Park/Introduce-Data-Access-MONitor-DAMON/20201005-190315 base: https://github.com/hnaz/linux-mm master config: arm64-allyesconfig (attached as .config) compiler: aarch64-linux-gcc (GCC) 9.3.0
reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross chmod +x ~/bin/make.cross
# https://github.com/0day-ci/linux/commit/21e763101056cfbf0d4274757b0dc5c025d9d514
git remote add linux-review https://github.com/0day-ci/linux
git fetch --no-tags linux-review SeongJae-Park/Introduce-Data-Access-MONitor-DAMON/20201005-190315 git checkout 21e763101056cfbf0d4274757b0dc5c025d9d514
# save the attached .config to linux build tree
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-9.3.0 make.cross ARCH=arm64
If you fix the issue, kindly add following tag as appropriate
All warnings (new ones prefixed by >>):
>> mm/damon/primitives.c:42:19: warning: no previous prototype for 'damon_get_mm' [-Wmissing-prototypes]
42 | struct mm_struct *damon_get_mm(struct damon_target *t)
| ^~~~~~~~~~~~
>> mm/damon/primitives.c:453:6: warning: no previous prototype for 'damon_va_prepare_vm_access_checks' [-Wmissing-prototypes] 453 | void damon_va_prepare_vm_access_checks(struct damon_ctx *ctx)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
vim +/damon_get_mm +42 mm/damon/primitives.c
38bec5a9ae83407 SeongJae Park 2020-10-05 27
38bec5a9ae83407 SeongJae Park 2020-10-05 28 /*
38bec5a9ae83407 SeongJae Park 2020-10-05 29 * 't->id' should be the pointer to the relevant 'struct pid' having reference
38bec5a9ae83407 SeongJae Park 2020-10-05 30 * count. Caller must put the returned task, unless it is NULL.
38bec5a9ae83407 SeongJae Park 2020-10-05 31 */
38bec5a9ae83407 SeongJae Park 2020-10-05 32 #define damon_get_task_struct(t) \
38bec5a9ae83407 SeongJae Park 2020-10-05 33 (get_pid_task((struct pid *)t->id, PIDTYPE_PID))
38bec5a9ae83407 SeongJae Park 2020-10-05 34
38bec5a9ae83407 SeongJae Park 2020-10-05 35 /*
38bec5a9ae83407 SeongJae Park 2020-10-05 36 * Get the mm_struct of the given target
38bec5a9ae83407 SeongJae Park 2020-10-05 37 *
38bec5a9ae83407 SeongJae Park 2020-10-05 38 * Caller _must_ put the mm_struct after use, unless it is NULL.
38bec5a9ae83407 SeongJae Park 2020-10-05 39 *
38bec5a9ae83407 SeongJae Park 2020-10-05 40 * Returns the mm_struct of the target on success, NULL on failure
38bec5a9ae83407 SeongJae Park 2020-10-05 41 */
38bec5a9ae83407 SeongJae Park 2020-10-05 @42 struct mm_struct *damon_get_mm(struct damon_target *t)
38bec5a9ae83407 SeongJae Park 2020-10-05 43 {
38bec5a9ae83407 SeongJae Park 2020-10-05 44 struct task_struct *task;
38bec5a9ae83407 SeongJae Park 2020-10-05 45 struct mm_struct *mm;
38bec5a9ae83407 SeongJae Park 2020-10-05 46
38bec5a9ae83407 SeongJae Park 2020-10-05 47 task = damon_get_task_struct(t);
38bec5a9ae83407 SeongJae Park 2020-10-05 48 if (!task)
38bec5a9ae83407 SeongJae Park 2020-10-05 49 return NULL;
38bec5a9ae83407 SeongJae Park 2020-10-05 50
38bec5a9ae83407 SeongJae Park 2020-10-05 51 mm = get_task_mm(task);
38bec5a9ae83407 SeongJae Park 2020-10-05 52 put_task_struct(task);
38bec5a9ae83407 SeongJae Park 2020-10-05 53 return mm;
38bec5a9ae83407 SeongJae Park 2020-10-05 54 }
38bec5a9ae83407 SeongJae Park 2020-10-05 55 ---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all(a)lists.01.org
PATCH v21 9/18 mm/damon: Add a tracepoint
In reply to SeongJae ParkFrom: SeongJae Park <[email protected]>
This commit adds a tracepoint for DAMON. It traces the monitoring results of each region for each aggregation interval. Using this, DAMON can easily integrated with tracepoints supporting tools such as perf.
--- include/trace/events/damon.h | 43 ++++++++++++++++++++++++++++++++++++ mm/damon/core.c | 7 +++++- 2 files changed, 49 insertions(+), 1 deletion(-) create mode 100644 include/trace/events/damon.h
include/trace/events/damon.h new file +43 -0
@@ -0,0 +1,43 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +#undef TRACE_SYSTEM +#define TRACE_SYSTEM damon + +#if !defined(_TRACE_DAMON_H) || defined(TRACE_HEADER_MULTI_READ ) +#define _TRACE_DAMON_H + +#include <linux/damon.h> +#include <linux/types.h> +#include <linux/tracepoint.h> + +TRACE_EVENT (damon_aggregated, + + TP_PROTO(struct damon_target *t, struct damon_region *r, + unsigned int nr_regions), + +TP_ARGS (t, r, nr_regions), + +TP_STRUCT__entry ( + __field(unsigned long, target_id) + __field(unsigned int, nr_regions) + __field(unsigned long, start) + __field(unsigned long, end) + __field(unsigned int, nr_accesses) + ), + +TP_fast_assign ( + __entry->target_id = t->id; + __entry->nr_regions = nr_regions; + __entry->start = r->ar.start; + __entry->end = r->ar.end; + __entry->nr_accesses = r->nr_accesses; + ), + +TP_printk ("target_id=%lu nr_regions=%u %lu-%lu: %u" , + __entry->target_id, __entry->nr_regions, + __entry->start, __entry->end, __entry->nr_accesses) +); + +#endif /* _TRACE_DAMON_H */ + +/* This part must be outside protection */ +#include <trace/define_trace.h>
mm/damon/core.c +6 -1
@@ -13,6 +13,9 @@#include <linux/random.h> #include <linux/slab.h> +#define CREATE_TRACE_POINTS +#include <trace/events/damon.h> +/* Minimal region size. Every damon_region is aligned by this. */ #define MIN_REGION PAGE_SIZE
@@ -386,8 +389,10 @@ static void kdamond_reset_aggregated(struct damon_ctx *c)damon_for_each_target (t, c) {struct damon_region *r; -damon_for_each_region (r, t) +damon_for_each_region (r, t) { +trace_damon_aggregated (t, r,damon_nr_regions (t)); r->nr_accesses =0 ; + } } }
Signature · 1 line
2.17.1
PATCH v21 10/18 mm/damon: Implement a debugfs-based user space interface
In reply to SeongJae ParkFrom: SeongJae Park <[email protected]>
DAMON is designed to be used by kernel space code such as the memory management subsystems, and therefore it provides only kernel space API. That said, letting the user space control DAMON could provide some benefits to them. For example, it will allow user space to analyze their specific workloads and make their own special optimizations.
For such cases, this commit implements a simple DAMON application kernel module, namely 'damon-dbgfs', which merely wraps the DAMON api and exports those to the user space via the debugfs.
'damon-dbgfs' exports three files, ``attrs``, ``target_ids``, and ``monitor_on`` under its debugfs directory, ``<debugfs>/damon/``.
Attributes
----------
Users can read and write the ``sampling interval``, ``aggregation interval``, ``regions update interval``, and min/max number of monitoring target regions by reading from and writing to the ``attrs`` file. For example, below commands set those values to 5 ms, 100 ms, 1,000 ms, 10, 1000 and check it again::
# cd <debugfs>/damon
# echo 5000 100000 1000000 10 1000 > attrs
# cat attrs
5000 100000 1000000 10 1000Target IDs
----------
Some types of address spaces supports multiple monitoring target. For example, the virtual memory address spaces monitoring can have multiple processes as the monitoring targets. Users can set the targets by writing relevant id values of the targets to, and get the ids of the current targets by reading from the ``target_ids`` file. In case of the virtual address spaces monitoring, the values should be pids of the monitoring target processes. For example, below commands set processes having pids 42 and 4242 as the monitoring targets and check it again::
# cd <debugfs>/damon
# echo 42 4242 > target_ids
# cat target_ids
42 4242Note that setting the target ids doesn't start the monitoring.
Turning On/Off
--------------
Setting the files as described above doesn't incur effect unless you explicitly start the monitoring. You can start, stop, and check the current status of the monitoring by writing to and reading from the ``monitor_on`` file. Writing ``on`` to the file starts the monitoring of the targets with the attributes. Writing ``off`` to the file stops those. DAMON also stops if every targets are invalidated (in case of the virtual memory monitoring, target processes are invalidated when terminated). Below example commands turn on, off, and check the status of DAMON::
# cd <debugfs>/damon
# echo on > monitor_on
# echo off > monitor_on
# cat monitor_on
offPlease note that you cannot write to the above-mentioned debugfs files while the monitoring is turned on. If you write to the files while DAMON is running, an error code such as ``-EBUSY`` will be returned.
--- include/linux/damon.h | 2 + mm/damon/Kconfig | 9 + mm/damon/Makefile | 1 + mm/damon/core.c | 48 +++++ mm/damon/dbgfs.c | 424 ++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 484 insertions(+) create mode 100644 mm/damon/dbgfs.c
include/linux/damon.h +2 -0
@@ -225,6 +225,8 @@ void damon_free_target(struct damon_target *t);void damon_destroy_target (struct damon_target *t);unsigned int damon_nr_regions (struct damon_target *t); +struct damon_ctx *damon_new_ctx (void ); +void damon_destroy_ctx (struct damon_ctx *ctx);int damon_set_targets (struct damon_ctx *ctx,unsigned long *ids,ssize_t nr_ids); int damon_set_attrs(struct damon_ctx *ctx, unsigned long sample_int,
mm/damon/Kconfig +9 -0
@@ -22,4 +22,13 @@ config DAMON_PRIMITIVES The primitives support only virtual address spaces. If this cannot cover your use case, you can implement and use your own primitives. +config DAMON_DBGFS + bool "DAMON debugfs interface" + depends on DAMON_PRIMITIVES && DEBUG_FS + help + This builds the debugfs interface for DAMON. The user space admins + can use the interface for arbitrary data access monitoring. + + If unsure, say N. + endmenu
mm/damon/Makefile +1 -0
@@ -2,3 +2,4 @@ obj-$(CONFIG_DAMON) := core.o obj-$(CONFIG_DAMON_PRIMITIVES) += primitives.o +obj-$(CONFIG_DAMON_DBGFS) += dbgfs.o
mm/damon/core.c +48 -0
60 lines not on this page · raw message
mm/damon/dbgfs.c new file +424 -0
424 lines not on this page · raw message
Signature · 1 line
2.17.1
Re: [PATCH v21 10/18] mm/damon: Implement a debugfs-based user space interface
Quoted 11 lines · On Mon, 5 Oct 2020 12:55:14 +0200 SeongJae Park <[email protected]> wrote:
From: SeongJae Park <[email protected]>
DAMON is designed to be used by kernel space code such as the memory management subsystems, and therefore it provides only kernel space API. That said, letting the user space control DAMON could provide some benefits to them. For example, it will allow user space to analyze their specific workloads and make their own special optimizations.
For such cases, this commit implements a simple DAMON application kernel module, namely 'damon-dbgfs', which merely wraps the DAMON api and exports those to the user space via the debugfs.
[...]
Quoted 15 lines
mm/damon/dbgfs.c new file +15
-0+ +static ssize_t dbgfs_monitor_on_write (struct file *file, +const char __user *buf,size_t count,loff_t *ppos) +{ +ssize_t ret = count; +char *kbuf; +int err; + + kbuf =user_input_str (buf, count, ppos); +if (IS_ERR (kbuf)) +return PTR_ERR (kbuf); + +/* Remove white space */ +if (sscanf (kbuf,"%s" , kbuf) !=1 ) +return -EINVAL ;
mm/damon/dbgfs.c line 367
Quoted 10 lines
mm/damon/dbgfs.c new file +10
-0+if (!strncmp (kbuf,"on" , count)) + err =dbgfs_start_ctxs (dbgfs_ctxs, dbgfs_nr_ctxs); +else if (!strncmp (kbuf,"off" , count)) + err =damon_stop (dbgfs_ctxs, dbgfs_nr_ctxs); +else +return -EINVAL ; + +if (err) + ret = err; +return ret;
'kbuf' should be freed before returning from this function. I will fix it in the next version. To find more potential memory leaks, I ran 'kmemleak' after a set of correctness tests[1], but it didn't find more leaks.
[1] https://github.com/awslabs/damon-tests/tree/master/corr
Thanks,
SeongJae Park
PATCH v21 11/18 mm/damon/dbgfs: Implement recording feature
In reply to SeongJae ParkFrom: SeongJae Park <[email protected]>
The user space users can control DAMON via and get the monitoring results using the 'damon_aggregated' tracepoint event. However, dealing with the tracepoint might be complex for some simple use cases. This commit therefore implements 'recording' feature in 'damon-dbgfs'. The feature can be used via 'record' file in the '<debugfs>/damon/' directory.
The file allows users to record monitored access patterns in a regular binary file. The recorded results are first written in an in-memory buffer and flushed to a file in batch. Users can get and set the size of the buffer and the path to the result file by reading from and writing to the ``record`` file. For example, below commands set the buffer to be 4 KiB and the result to be saved in ``/damon.data``. ::
# cd <debugfs>/damon
# echo "4096 /damon.data" > record
# cat record
4096 /damon.dataThe recording can be disabled by setting the buffer size zero.
--- mm/damon/dbgfs.c | 255 ++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 253 insertions(+), 2 deletions(-)
mm/damon/dbgfs.c +253 -2
@@ -15,6 +15,17 @@#include <linux/page_idle.h> #include <linux/slab.h> +#define MIN_RECORD_BUFFER_LEN 1024 +#define MAX_RECORD_BUFFER_LEN (4 * 1024 * 1024) +#define MAX_RFILE_PATH_LEN 256 + +struct dbgfs_recorder { +unsigned char *rbuf; +unsigned int rbuf_len; +unsigned int rbuf_offset; +char *rfile_path; +}; +static struct damon_ctx **dbgfs_ctxs;static int dbgfs_nr_ctxs =1 ;static int dbgfs_nr_terminated_ctxs;
@@ -99,6 +110,116 @@ static ssize_t dbgfs_attrs_write(struct file *file,return ret; } +static ssize_t dbgfs_record_read (struct file *file, +char __user *buf,size_t count,loff_t *ppos) +{ +struct damon_ctx *ctx = file->private_data; +struct dbgfs_recorder *rec = ctx->callback.private; +char record_buf[20 +MAX_RFILE_PATH_LEN ]; +int ret; + +mutex_lock (&ctx->kdamond_lock); + ret =scnprintf (record_buf,ARRAY_SIZE (record_buf),"%u %s\n" , + rec->rbuf_len, rec->rfile_path); +mutex_unlock (&ctx->kdamond_lock); +return simple_read_from_buffer (buf, count, ppos, record_buf, ret); +} + +/* +* dbgfs_set_recording() - Set attributes for the recording. +* @ctx: target kdamond context +* @rbuf_len: length of the result buffer +* @rfile_path: path to the monitor result files +* +* Setting 'rbuf_len' 0 disables recording. +* +* This function should not be called while the kdamond is running. +* +* Return: 0 on success, negative error code otherwise. +*/ +static int dbgfs_set_recording (struct damon_ctx *ctx, +unsigned int rbuf_len,char *rfile_path) +{ +struct dbgfs_recorder *recorder; +size_t rfile_path_len; + +if (rbuf_len && (rbuf_len >MAX_RECORD_BUFFER_LEN || + rbuf_len <MIN_RECORD_BUFFER_LEN )) { +pr_err ("result buffer size (%u) is out of [%d,%d]\n" , + rbuf_len,MIN_RECORD_BUFFER_LEN , +MAX_RECORD_BUFFER_LEN ); +return -EINVAL ; + } + rfile_path_len =strnlen (rfile_path,MAX_RFILE_PATH_LEN ); +if (rfile_path_len >=MAX_RFILE_PATH_LEN ) { +pr_err ("too long (>%d) result file path %s\n" , +MAX_RFILE_PATH_LEN , rfile_path); +return -EINVAL ; + } + + recorder = ctx->callback.private; +if (!recorder) { + recorder =kzalloc (sizeof (*recorder),GFP_KERNEL ); +if (!recorder) +return -ENOMEM ; + ctx->callback.private = recorder; + } + + recorder->rbuf_len = rbuf_len; +kfree (recorder->rbuf); + recorder->rbuf =NULL ; +kfree (recorder->rfile_path); + recorder->rfile_path =NULL ; + +if (rbuf_len) { + recorder->rbuf =kvmalloc (rbuf_len,GFP_KERNEL ); +if (!recorder->rbuf) +return -ENOMEM ; + } + recorder->rfile_path =kmalloc (rfile_path_len +1 ,GFP_KERNEL ); +if (!recorder->rfile_path) +return -ENOMEM ; +strncpy (recorder->rfile_path, rfile_path, rfile_path_len +1 ); + +return 0 ; +} + +static ssize_t dbgfs_record_write (struct file *file, +const char __user *buf,size_t count,loff_t *ppos) +{ +struct damon_ctx *ctx = file->private_data; +char *kbuf; +unsigned int rbuf_len; +char rfile_path[MAX_RFILE_PATH_LEN ]; +ssize_t ret = count; +int err; + + kbuf =user_input_str (buf, count, ppos); +if (IS_ERR (kbuf)) +return PTR_ERR (kbuf); + +if (sscanf (kbuf,"%u %s" , + &rbuf_len, rfile_path) !=2 ) { + ret = -EINVAL ; + goto out; + } + +mutex_lock (&ctx->kdamond_lock); +if (ctx->kdamond) { + ret = -EBUSY ; + goto unlock_out; + } + + err =dbgfs_set_recording (ctx, rbuf_len, rfile_path); +if (err) + ret = err; +unlock_out: +mutex_unlock (&ctx->kdamond_lock); +out: +kfree (kbuf); +return ret; +} +#define targetid_is_pid (ctx) \ (ctx->primitive.target_valid == damon_va_target_valid)
@@ -262,6 +383,13 @@ static const struct file_operations attrs_fops = { .write = dbgfs_attrs_write, }; +static const struct file_operations record_fops = { + .owner =THIS_MODULE , + .open = damon_dbgfs_open, + .read = dbgfs_record_read, + .write = dbgfs_record_write, +}; +static const struct file_operations target_ids_fops = { .owner =THIS_MODULE , .open = damon_dbgfs_open,
@@ -271,8 +399,9 @@ static const struct file_operations target_ids_fops = {static int dbgfs_fill_ctx_dir (struct dentry *dir,struct damon_ctx *ctx) { -const char *const file_names[] = {"attrs" ,"target_ids" }; -const struct file_operations *fops[] = {&attrs_fops, &target_ids_fops}; +const char *const file_names[] = {"attrs" ,"record" ,"target_ids" }; +const struct file_operations *fops[] = {&attrs_fops, &record_fops, + &target_ids_fops};int i;for (i =0 ; i <ARRAY_SIZE (file_names); i++) {
@@ -286,6 +415,120 @@ static int dbgfs_fill_ctx_dir(struct dentry *dir, struct damon_ctx *ctx)return 0 ; } +/* +* Flush the content in the result buffer to the result file +*/ +static void dbgfs_flush_rbuffer (struct dbgfs_recorder *rec) +{ +ssize_t sz; +loff_t pos =0 ; +struct file *rfile; + +if (!rec->rbuf_offset) +return ; + + rfile =filp_open (rec->rfile_path, +O_CREAT |O_RDWR |O_APPEND |O_LARGEFILE ,0644 ); +if (IS_ERR (rfile)) { +pr_err ("Cannot open the result file %s\n" , + rec->rfile_path); +return ; + } + +while (rec->rbuf_offset) { + sz =kernel_write (rfile, rec->rbuf, rec->rbuf_offset, &pos); +if (sz <0 ) +break ; + rec->rbuf_offset -= sz; + } +filp_close (rfile,NULL ); +} + +/* +* Write a data into the result buffer +*/ +static void dbgfs_write_rbuf (struct damon_ctx *ctx,void *data,ssize_t size) +{ +struct dbgfs_recorder *rec = ctx->callback.private; + +if (!rec->rbuf_len || !rec->rbuf || !rec->rfile_path) +return ; +if (rec->rbuf_offset + size > rec->rbuf_len) +dbgfs_flush_rbuffer (ctx->callback.private); +if (rec->rbuf_offset + size > rec->rbuf_len) { +pr_warn ("%s: flush failed, or wrong size given(%u, %zu)\n" , + __func__, rec->rbuf_offset, size); +return ; + } + +memcpy (&rec->rbuf[rec->rbuf_offset], data, size); + rec->rbuf_offset += size; +} + +static void dbgfs_write_record_header (struct damon_ctx *ctx) +{ +int recfmt_ver =2 ; + +dbgfs_write_rbuf (ctx,"damon_recfmt_ver" ,16 ); +dbgfs_write_rbuf (ctx, &recfmt_ver,sizeof (recfmt_ver)); +} + +static unsigned int nr_damon_targets (struct damon_ctx *ctx) +{ +struct damon_target *t; +unsigned int nr_targets =0 ; + +damon_for_each_target (t, ctx) + nr_targets++; + +return nr_targets; +} + +static int dbgfs_before_start (struct damon_ctx *ctx) +{ +dbgfs_write_record_header (ctx); +return 0 ; +} + +/* +* Store the aggregated monitoring results to the result buffer +* +* The format for the result buffer is as below: +* +* <time> <number of targets> <array of target infos> +* +* target info: <id> <number of regions> <array of region infos> +* region info: <start address> <end address> <nr_accesses> +*/ +static int dbgfs_after_aggregation (struct damon_ctx *c) +{ +struct damon_target *t; +struct timespec64 now; +unsigned int nr; + +ktime_get_coarse_ts64 (&now); + +dbgfs_write_rbuf (c, &now,sizeof (now)); + nr =nr_damon_targets (c); +dbgfs_write_rbuf (c, &nr,sizeof (nr)); + +damon_for_each_target (t, c) { +struct damon_region *r; + +dbgfs_write_rbuf (c, &t->id,sizeof (t->id)); + nr =damon_nr_regions (t); +dbgfs_write_rbuf (c, &nr,sizeof (nr)); +damon_for_each_region (r, t) { +dbgfs_write_rbuf (c, &r->ar.start,sizeof (r->ar.start)); +dbgfs_write_rbuf (c, &r->ar.end,sizeof (r->ar.end)); +dbgfs_write_rbuf (c, &r->nr_accesses, +sizeof (r->nr_accesses)); + } + } + +return 0 ; +} +static void dbgfs_unlock_page_idle_lock (void ) {mutex_lock (&damon_dbgfs_lock);
@@ -298,6 +541,7 @@ static void dbgfs_unlock_page_idle_lock(void)static int dbgfs_before_terminate (struct damon_ctx *ctx) { +dbgfs_flush_rbuffer (ctx->callback.private);dbgfs_unlock_page_idle_lock ();return 0 ; }
@@ -310,7 +554,14 @@ static struct damon_ctx *dbgfs_new_ctx(void)if (!ctx)return NULL ; +if (dbgfs_set_recording (ctx,0 ,"none" )) { +damon_destroy_ctx (ctx); +return NULL ; + } +damon_va_set_primitives (ctx); + ctx->callback.before_start = dbgfs_before_start; + ctx->callback.after_aggregation = dbgfs_after_aggregation; ctx->callback.before_terminate = dbgfs_before_terminate;return ctx; }
Signature · 1 line
2.17.1
PATCH v21 12/18 mm/damon/dbgfs: Export kdamond pid to the user space
In reply to SeongJae ParkFrom: SeongJae Park <[email protected]>
For CPU usage accounting, knowing pid of the monitoring thread could be helpful. For example, users could use cpuaccount cgroups with the pid.
This commit therefore exports the pid of currently running monitoring thread to the user space via 'kdamond_pid' file in the debugfs directory.
--- mm/damon/dbgfs.c | 37 +++++++++++++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-)
mm/damon/dbgfs.c +35 -2
@@ -369,6 +369,32 @@ static ssize_t dbgfs_target_ids_write(struct file *file,return ret; } +static ssize_t dbgfs_kdamond_pid_read (struct file *file, +char __user *buf,size_t count,loff_t *ppos) +{ +struct damon_ctx *ctx = file->private_data; +char *kbuf; +ssize_t len; + + kbuf =kmalloc (count,GFP_KERNEL ); +if (!kbuf) +return -ENOMEM ; + +mutex_lock (&ctx->kdamond_lock); +if (ctx->kdamond) + len =scnprintf (kbuf, count,"%d\n" , ctx->kdamond->pid); +else + len =scnprintf (kbuf, count,"none\n" ); +mutex_unlock (&ctx->kdamond_lock); +if (!len) + goto out; + len =simple_read_from_buffer (buf, count, ppos, kbuf, len); + +out: +kfree (kbuf); +return len; +} +static int damon_dbgfs_open (struct inode *inode,struct file *file) { file->private_data = inode->i_private;
@@ -397,11 +423,18 @@ static const struct file_operations target_ids_fops = { .write = dbgfs_target_ids_write, }; +static const struct file_operations kdamond_pid_fops = { + .owner =THIS_MODULE , + .open = damon_dbgfs_open, + .read = dbgfs_kdamond_pid_read, +}; +static int dbgfs_fill_ctx_dir (struct dentry *dir,struct damon_ctx *ctx) { -const char *const file_names[] = {"attrs" ,"record" ,"target_ids" }; +const char *const file_names[] = {"attrs" ,"record" ,"target_ids" , +"kdamond_pid" };const struct file_operations *fops[] = {&attrs_fops, &record_fops, - &target_ids_fops}; + &target_ids_fops}, &kdamond_pid_fops;int i;for (i =0 ; i <ARRAY_SIZE (file_names); i++) {
Signature · 1 line
2.17.1
PATCH v21 13/18 mm/damon/dbgfs: Support multiple contexts
In reply to SeongJae ParkFrom: SeongJae Park <[email protected]>
In some use cases, users would want to run multiple monitoring context. For example, if a user wants a high precision monitoring and dedicating multiple CPUs for the job is ok, because DAMON creates one monitoring thread per one context, the user can split the monitoring target regions into multiple small regions and create one context for each region. Or, someone might want to simultaneously monitor different address spaces, e.g., both virtual address space and physical address space.
The DAMON's API allows such usage, but 'damon-dbgfs' does not. Therefore, only kernel space DAMON users can do multiple contexts monitoring.
This commit allows the user space DAMON users to use multiple contexts monitoring by introducing two new 'damon-dbgfs' debugfs files, 'mk_context' and 'rm_context'. Users can create a new monitoring context by writing the desired name of the new context to 'mk_context'. Then, a new directory with the name and having the files for setting of the context ('attrs', 'target_ids' and 'record') will be created under the debugfs directory. Writing the name of the context to remove to 'rm_context' will remove the related context and directory.
--- mm/damon/dbgfs.c | 214 ++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 211 insertions(+), 3 deletions(-)
mm/damon/dbgfs.c +211 -3
@@ -434,7 +434,7 @@ static int dbgfs_fill_ctx_dir(struct dentry *dir, struct damon_ctx *ctx)const char *const file_names[] = {"attrs" ,"record" ,"target_ids" ,"kdamond_pid" };const struct file_operations *fops[] = {&attrs_fops, &record_fops, - &target_ids_fops}, &kdamond_pid_fops; + &target_ids_fops, &kdamond_pid_fops};int i;for (i =0 ; i <ARRAY_SIZE (file_names); i++) {
@@ -506,6 +506,13 @@ static void dbgfs_write_record_header(struct damon_ctx *ctx)dbgfs_write_rbuf (ctx, &recfmt_ver,sizeof (recfmt_ver)); } +static void dbgfs_free_recorder (struct dbgfs_recorder *recorder) +{ +kfree (recorder->rbuf); +kfree (recorder->rfile_path); +kfree (recorder); +} +static unsigned int nr_damon_targets (struct damon_ctx *ctx) {struct damon_target *t;
@@ -599,6 +606,195 @@ static struct damon_ctx *dbgfs_new_ctx(void)return ctx; } +static void dbgfs_destroy_ctx (struct damon_ctx *ctx) +{ +dbgfs_free_recorder (ctx->callback.private); +damon_destroy_ctx (ctx); +} + +/* +* Make a context of @name and create a debugfs directory for it. +* +* This function should be called while holding damon_dbgfs_lock. +* +* Returns 0 on success, negative error code otherwise. +*/ +static int dbgfs_mk_context (char *name) +{ +struct dentry *root, **new_dirs, *new_dir; +struct damon_ctx **new_ctxs, *new_ctx; +int err; + +if (damon_nr_running_ctxs ()) +return -EBUSY ; + + new_ctxs =krealloc (dbgfs_ctxs,sizeof (*dbgfs_ctxs) * + (dbgfs_nr_ctxs +1 ),GFP_KERNEL ); +if (!new_ctxs) +return -ENOMEM ; + + new_dirs =krealloc (dbgfs_dirs,sizeof (*dbgfs_dirs) * + (dbgfs_nr_ctxs +1 ),GFP_KERNEL ); +if (!new_dirs) { +kfree (new_ctxs); +return -ENOMEM ; + } + + dbgfs_ctxs = new_ctxs; + dbgfs_dirs = new_dirs; + + root = dbgfs_dirs[0 ]; +if (!root) +return -ENOENT ; + + new_dir =debugfs_create_dir (name, root); +if (IS_ERR (new_dir)) +return PTR_ERR (new_dir); + dbgfs_dirs[dbgfs_nr_ctxs] = new_dir; + + new_ctx =dbgfs_new_ctx (); +if (!new_ctx) { +debugfs_remove (new_dir); + dbgfs_dirs[dbgfs_nr_ctxs] =NULL ; +return -ENOMEM ; + } + dbgfs_ctxs[dbgfs_nr_ctxs] = new_ctx; + + err =dbgfs_fill_ctx_dir (dbgfs_dirs[dbgfs_nr_ctxs], + dbgfs_ctxs[dbgfs_nr_ctxs]); +if (err) +return err; + + dbgfs_nr_ctxs++; +return 0 ; +} + +static ssize_t dbgfs_mk_context_write (struct file *file, +const char __user *buf,size_t count,loff_t *ppos) +{ +char *kbuf; +char *ctx_name; +ssize_t ret = count; +int err; + + kbuf =user_input_str (buf, count, ppos); +if (IS_ERR (kbuf)) +return PTR_ERR (kbuf); + ctx_name =kmalloc (count +1 ,GFP_KERNEL ); +if (!ctx_name) { +kfree (kbuf); +return -ENOMEM ; + } + +/* Trim white space */ +if (sscanf (kbuf,"%s" , ctx_name) !=1 ) { + ret = -EINVAL ; + goto out; + } + +mutex_lock (&damon_dbgfs_lock); + err =dbgfs_mk_context (ctx_name); +if (err) + ret = err; +mutex_unlock (&damon_dbgfs_lock); + +out: +kfree (kbuf); +kfree (ctx_name); +return ret; +} + +/* +* Remove a context of @name and its debugfs directory. +* +* This function should be called while holding damon_dbgfs_lock. +* +* Return 0 on success, negative error code otherwise. +*/ +static int dbgfs_rm_context (char *name) +{ +struct dentry *root, *dir, **new_dirs; +struct damon_ctx **new_ctxs; +int i, j; + +if (damon_nr_running_ctxs ()) +return -EBUSY ; + + root = dbgfs_dirs[0 ]; +if (!root) +return -ENOENT ; + + dir =debugfs_lookup (name, root); +if (!dir) +return -ENOENT ; + + new_dirs =kmalloc_array (dbgfs_nr_ctxs -1 ,sizeof (*dbgfs_dirs), +GFP_KERNEL ); +if (!new_dirs) +return -ENOMEM ; + + new_ctxs =kmalloc_array (dbgfs_nr_ctxs -1 ,sizeof (*dbgfs_ctxs), +GFP_KERNEL ); +if (!new_ctxs) { +kfree (new_dirs); +return -ENOMEM ; + } + +for (i =0 , j =0 ; i < dbgfs_nr_ctxs; i++) { +if (dbgfs_dirs[i] == dir) { +debugfs_remove (dbgfs_dirs[i]); +dbgfs_destroy_ctx (dbgfs_ctxs[i]); +continue ; + } + new_dirs[j] = dbgfs_dirs[i]; + new_ctxs[j++] = dbgfs_ctxs[i]; + } + +kfree (dbgfs_dirs); +kfree (dbgfs_ctxs); + + dbgfs_dirs = new_dirs; + dbgfs_ctxs = new_ctxs; + dbgfs_nr_ctxs--; + +return 0 ; +} + +static ssize_t dbgfs_rm_context_write (struct file *file, +const char __user *buf,size_t count,loff_t *ppos) +{ +char *kbuf; +ssize_t ret = count; +int err; +char *ctx_name; + + kbuf =user_input_str (buf, count, ppos); +if (IS_ERR (kbuf)) +return PTR_ERR (kbuf); + ctx_name =kmalloc (count +1 ,GFP_KERNEL ); +if (!ctx_name) { +kfree (kbuf); +return -ENOMEM ; + } + +/* Trim white space */ +if (sscanf (kbuf,"%s" , ctx_name) !=1 ) { + ret = -EINVAL ; + goto out; + } + +mutex_lock (&damon_dbgfs_lock); + err =dbgfs_rm_context (ctx_name); +if (err) + ret = err; +mutex_unlock (&damon_dbgfs_lock); + +out: +kfree (kbuf); +kfree (ctx_name); +return ret; +} +static ssize_t dbgfs_monitor_on_read (struct file *file,char __user *buf,size_t count,loff_t *ppos) {
@@ -651,6 +847,16 @@ static ssize_t dbgfs_monitor_on_write(struct file *file,return ret; } +static const struct file_operations mk_contexts_fops = { + .owner =THIS_MODULE , + .write = dbgfs_mk_context_write, +}; + +static const struct file_operations rm_contexts_fops = { + .owner =THIS_MODULE , + .write = dbgfs_rm_context_write, +}; +static const struct file_operations monitor_on_fops = { .owner =THIS_MODULE , .read = dbgfs_monitor_on_read,
@@ -660,8 +866,10 @@ static const struct file_operations monitor_on_fops = {static int __init __damon_dbgfs_init (void ) {struct dentry *dbgfs_root; -const char *const file_names[] = {"monitor_on" }; -const struct file_operations *fops[] = {&monitor_on_fops}; +const char *const file_names[] = {"mk_contexts" ,"rm_contexts" , +"monitor_on" }; +const struct file_operations *fops[] = {&mk_contexts_fops, + &rm_contexts_fops, &monitor_on_fops};int i; dbgfs_root =debugfs_create_dir ("damon" ,NULL );
Signature · 1 line
2.17.1
PATCH v21 14/18 tools: Introduce a minimal user-space tool for DAMON
In reply to SeongJae ParkFrom: SeongJae Park <[email protected]>
'damon-dbgfs' provides simple user space interface for DAMON, but using the interface for complex usages could require annoying repetitive works. Writing a user space data access monitoring applications on top of the debugfs interface and using the application would be better for such complex cases.
This commit introduces a reference implementation of such user space application built on top of the debugfs interface, namely 'DAMon Operator' (DAMO). It contains a shallow wrapper python script of the debugfs interface and various visualization of the monitoring results convenient user interface.
Note that it is initially aimed to be used for minimal reference of the 'damon-dbgfs' interface and for debugging of the DAMON itself.
--- tools/damon/.gitignore | 1 + tools/damon/_damon.py | 130 ++++++++++++++ tools/damon/_dist.py | 35 ++++ tools/damon/_recfile.py | 23 +++ tools/damon/bin2txt.py | 67 +++++++ tools/damon/damo | 37 ++++ tools/damon/heats.py | 362 ++++++++++++++++++++++++++++++++++++++ tools/damon/nr_regions.py | 91 ++++++++++ tools/damon/record.py | 135 ++++++++++++++ tools/damon/report.py | 45 +++++ tools/damon/wss.py | 100 +++++++++++ 11 files changed, 1026 insertions(+) create mode 100644 tools/damon/.gitignore create mode 100644 tools/damon/_damon.py create mode 100644 tools/damon/_dist.py create mode 100644 tools/damon/_recfile.py create mode 100644 tools/damon/bin2txt.py create mode 100755 tools/damon/damo create mode 100644 tools/damon/heats.py create mode 100644 tools/damon/nr_regions.py create mode 100644 tools/damon/record.py create mode 100644 tools/damon/report.py create mode 100644 tools/damon/wss.py
tools/damon/.gitignore new file +1 -0
@@ -0,0 +1 @@ +__pycache__/*
tools/damon/_damon.py new file +130 -0
130 lines not on this page · raw message
tools/damon/_dist.py new file +35 -0
@@ -0,0 +1,35 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: GPL-2.0 + +import os +import struct +import subprocess + +def access_patterns(f): + nr_regions = struct.unpack('I', f.read(4))[0] + + patterns = [] + for r in range(nr_regions): + saddr = struct.unpack('L', f.read(8))[0] + eaddr = struct.unpack('L', f.read(8))[0] + nr_accesses = struct.unpack('I', f.read(4))[0] + patterns.append([eaddr - saddr, nr_accesses]) + return patterns + +def plot_dist(data_file, output_file, xlabel, ylabel): + terminal = output_file.split('.')[-1] + if not terminal in ['pdf', 'jpeg', 'png', 'svg']: + os.remove(data_file) + print("Unsupported plot output type.") + exit(-1) + + gnuplot_cmd = """ + set term %s; + set output '%s'; + set key off; + set xlabel '%s'; + set ylabel '%s'; + plot '%s' with linespoints;""" % (terminal, output_file, xlabel, ylabel, + data_file) + subprocess.call(['gnuplot', '-e', gnuplot_cmd]) + os.remove(data_file)
tools/damon/_recfile.py new file +23 -0
@@ -0,0 +1,23 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: GPL-2.0 + +import struct + +fmt_version = 0 + +def set_fmt_version(f): + global fmt_version + + mark = f.read(16) + if mark == b'damon_recfmt_ver': + fmt_version = struct.unpack('i', f.read(4))[0] + else: + fmt_version = 0 + f.seek(0) + return fmt_version + +def target_id(f): + if fmt_version == 1: + return struct.unpack('i', f.read(4))[0] + else: + return struct.unpack('L', f.read(8))[0]
tools/damon/bin2txt.py new file +67 -0
67 lines not on this page · raw message
tools/damon/damo new file +37 -0
@@ -0,0 +1,37 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: GPL-2.0 + +import argparse + +import record +import report + +class SubCmdHelpFormatter(argparse.RawDescriptionHelpFormatter): + def _format_action(self, action): + parts = super(argparse.RawDescriptionHelpFormatter, + self)._format_action(action) + # skip sub parsers help + if action.nargs == argparse.PARSER: + parts = '\n'.join(parts.split('\n')[1:]) + return parts + +parser = argparse.ArgumentParser(formatter_class=SubCmdHelpFormatter) + +subparser = parser.add_subparsers(title='command', dest='command', + metavar='<command>') +subparser.required = True + +parser_record = subparser.add_parser('record', + help='record data accesses of the given target processes') +record.set_argparser(parser_record) + +parser_report = subparser.add_parser('report', + help='report the recorded data accesses in the specified form') +report.set_argparser(parser_report) + +args = parser.parse_args() + +if args.command == 'record': + record.main(args) +elif args.command == 'report': + report.main(args)
tools/damon/heats.py new file +362 -0
362 lines not on this page · raw message
tools/damon/nr_regions.py new file +91 -0
91 lines not on this page · raw message
tools/damon/record.py new file +135 -0
135 lines not on this page · raw message
tools/damon/report.py new file +45 -0
45 lines not on this page · raw message
tools/damon/wss.py new file +100 -0
100 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v21 15/18 Documentation: Add documents for DAMON
In reply to SeongJae ParkFrom: SeongJae Park <[email protected]>
This commit adds documents for DAMON under Documentation/admin-guide/mm/damon/ and Documentation/vm/damon/.
--- Documentation/admin-guide/mm/damon/guide.rst | 157 ++++++++++ Documentation/admin-guide/mm/damon/index.rst | 15 + Documentation/admin-guide/mm/damon/plans.rst | 29 ++ Documentation/admin-guide/mm/damon/start.rst | 96 ++++++ Documentation/admin-guide/mm/damon/usage.rst | 302 +++++++++++++++++++ Documentation/admin-guide/mm/index.rst | 1 + Documentation/vm/damon/api.rst | 20 ++ Documentation/vm/damon/design.rst | 166 ++++++++++ Documentation/vm/damon/eval.rst | 225 ++++++++++++++ Documentation/vm/damon/faq.rst | 58 ++++ Documentation/vm/damon/index.rst | 31 ++ Documentation/vm/index.rst | 1 + 12 files changed, 1101 insertions(+) create mode 100644 Documentation/admin-guide/mm/damon/guide.rst create mode 100644 Documentation/admin-guide/mm/damon/index.rst create mode 100644 Documentation/admin-guide/mm/damon/plans.rst create mode 100644 Documentation/admin-guide/mm/damon/start.rst create mode 100644 Documentation/admin-guide/mm/damon/usage.rst create mode 100644 Documentation/vm/damon/api.rst create mode 100644 Documentation/vm/damon/design.rst create mode 100644 Documentation/vm/damon/eval.rst create mode 100644 Documentation/vm/damon/faq.rst create mode 100644 Documentation/vm/damon/index.rst
Documentation/admin-guide/mm/damon/guide.rst new file +157 -0
@@ -0,0 +1,157 @@ +.. SPDX-License-Identifier: GPL-2.0 + +================== +Optimization Guide +================== + +This document helps you estimating the amount of benefit that you could get +from DAMON-based optimizations, and describes how you could achieve it. You +are assumed to already read :doc:`start`. + + +Check The Signs +=============== + +No optimization can provide same extent of benefit to every case. Therefore +you should first guess how much improvements you could get using DAMON. If +some of below conditions match your situation, you could consider using DAMON. + +- *Low IPC and High Cache Miss Ratios.* Low IPC means most of the CPU time is + spent waiting for the completion of time-consuming operations such as memory + access, while high cache miss ratios mean the caches don't help it well. + DAMON is not for cache level optimization, but DRAM level. However, + improving DRAM management will also help this case by reducing the memory + operation latency. +- *Memory Over-commitment and Unknown Users.* If you are doing memory + overcommitment and you cannot control every user of your system, a memory + bank run could happen at any time. You can estimate when it will happen + based on DAMON's monitoring results and act earlier to avoid or deal better + with the crisis. +- *Frequent Memory Pressure.* Frequent memory pressure means your system has + wrong configurations or memory hogs. DAMON will help you find the right + configuration and/or the criminals. +- *Heterogeneous Memory System.* If your system is utilizing memory devices + that placed between DRAM and traditional hard disks, such as non-volatile + memory or fast SSDs, DAMON could help you utilizing the devices more + efficiently. + + +Profile +======= + +If you found some positive signals, you could start by profiling your workloads +using DAMON. Find major workloads on your systems and analyze their data +access pattern to find something wrong or can be improved. The DAMON user +space tool (``damo``) will be useful for this. + +We recommend you to start from working set size distribution check using ``damo +report wss``. If the distribution is ununiform or quite different from what +you estimated, you could consider `Memory Configuration`_ optimization. + +Then, review the overall access pattern in heatmap form using ``damo report +heats``. If it shows a simple pattern consists of a small number of memory +regions having high contrast of access temperature, you could consider manual +`Program Modification`_. + +If you still want to absorb more benefits, you should develop `Personalized +DAMON Application`_ for your special case. + +You don't need to take only one approach among the above plans, but you could +use multiple of the above approaches to maximize the benefit. + + +Optimize +======== + +If the profiling result also says it's worth trying some optimization, you +could consider below approaches. Note that some of the below approaches assume +that your systems are configured with swap devices or other types of auxiliary +memory so that you don't strictly required to accommodate the whole working set +in the main memory. Most of the detailed optimization should be made on your +concrete understanding of your memory devices. + + +Memory Configuration +-------------------- + +No more no less, DRAM should be large enough to accommodate only important +working sets, because DRAM is highly performance critical but expensive and +heavily consumes the power. However, knowing the size of the real important +working sets is difficult. As a consequence, people usually equips +unnecessarily large or too small DRAM. Many problems stem from such wrong +configurations. + +Using the working set size distribution report provided by ``damo report wss``, +you can know the appropriate DRAM size for you. For example, roughly speaking, +if you worry about only 95 percentile latency, you don't need to equip DRAM of +a size larger than 95 percentile working set size. + +Let's see a real example. This `page +<https://damonitor.github.io/doc/html/v17/admin-guide/mm/damon/guide.html#memory-configuration>`_ +shows the heatmap and the working set size distributions/changes of +``freqmine`` workload in PARSEC3 benchmark suite. The working set size spikes +up to 180 MiB, but keeps smaller than 50 MiB for more than 95% of the time. +Even though you give only 50 MiB of memory space to the workload, it will work +well for 95% of the time. Meanwhile, you can save the 130 MiB of memory space. + + +Program Modification +-------------------- + +If the data access pattern heatmap plotted by ``damo report heats`` is quite +simple so that you can understand how the things are going in the workload with +your human eye, you could manually optimize the memory management. + +For example, suppose that the workload has two big memory object but only one +object is frequently accessed while the other one is only occasionally +accessed. Then, you could modify the program source code to keep the hot +object in the main memory by invoking ``mlock()`` or ``madvise()`` with +``MADV_WILLNEED``. Or, you could proactively evict the cold object using +``madvise()`` with ``MADV_COLD`` or ``MADV_PAGEOUT``. Using both together +would be also worthy. + +A research work [1]_ using the ``mlock()`` achieved up to 2.55x performance +speedup. + +Let's see another realistic example access pattern for this kind of +optimizations. This `page +<https://damonitor.github.io/doc/html/v17/admin-guide/mm/damon/guide.html#program-modification>`_ +shows the visualized access patterns of streamcluster workload in PARSEC3 +benchmark suite. We can easily identify the 100 MiB sized hot object. + + +Personalized DAMON Application +------------------------------ + +Above approaches will work well for many general cases, but would not enough +for some special cases. + +If this is the case, it might be the time to forget the comfortable use of the +user space tool and dive into the debugfs interface (refer to :doc:`usage` for +the detail) of DAMON. Using the interface, you can control the DAMON more +flexibly. Therefore, you can write your personalized DAMON application that +controls the monitoring via the debugfs interface, analyzes the result, and +applies complex optimizations itself. Using this, you can make more creative +and wise optimizations. + +If you are a kernel space programmer, writing kernel space DAMON applications +using the API (refer to the :doc:`/vm/damon/api` for more detail) would be an +option. + + +Reference Practices +=================== + +Referencing previously done successful practices could help you getting the +sense for this kind of optimizations. There is an academic paper [1]_ +reporting the visualized access pattern and manual `Program +Modification`_ results for a number of realistic workloads. You can also get +the visualized access patterns [3]_ [4]_ [5]_ and automated DAMON-based memory +operations results for other realistic workloads that collected with latest +version of DAMON [2]_ . + +.. [1] https://dl.acm.org/doi/10.1145/3366626.3368125 +.. [2] https://damonitor.github.io/test/result/perf/latest/html/ +.. [3] https://damonitor.github.io/test/result/visual/latest/rec.heatmap.1.png.html +.. [4] https://damonitor.github.io/test/result/visual/latest/rec.wss_sz.png.html +.. [5] https://damonitor.github.io/test/result/visual/latest/rec.wss_time.png.html
Documentation/admin-guide/mm/damon/index.rst new file +15 -0
@@ -0,0 +1,15 @@ +.. SPDX-License-Identifier: GPL-2.0 + +======================== +Monitoring Data Accesses +======================== + +:doc:`DAMON </vm/damon/index>` allows light-weight data access monitoring. +Using this, users can analyze and optimize their systems. + +.. toctree:: + :maxdepth: 2 + + start + guide + usage
Documentation/admin-guide/mm/damon/plans.rst new file +29 -0
@@ -0,0 +1,29 @@ +.. SPDX-License-Identifier: GPL-2.0 + +============ +Future Plans +============ + +DAMON is still on its first stage. Below plans are still under development. + + +Automate Data Access Monitoring-based Memory Operation Schemes Execution +======================================================================== + +The ultimate goal of DAMON is to be used as a building block for the data +access pattern aware kernel memory management optimization. It will make +system just works efficiently. However, some users having very special +workloads will want to further do their own optimization. DAMON will automate +most of the tasks for such manual optimizations in near future. Users will be +required to only describe what kind of data access pattern-based operation +schemes they want in a simple form. + +By applying a very simple scheme for THP promotion/demotion with a prototype +implementation, DAMON reduced 60% of THP memory footprint overhead while +preserving 50% of the THP performance benefit. The detailed results can be +seen on an external web page [1]_. + +Several RFC patchsets for this plan are available [2]_. + +.. [1] https://damonitor.github.io/test/result/perf/latest/html/ +.. [2] https://lore.kernel.org/linux-mm/[email protected]/
Documentation/admin-guide/mm/damon/start.rst new file +96 -0
96 lines not on this page · raw message
Documentation/admin-guide/mm/damon/usage.rst new file +302 -0
302 lines not on this page · raw message
Documentation/admin-guide/mm/index.rst +1 -0
@@ -27,6 +27,7 @@ the Linux memory management. concepts cma_debugfs + damon/index hugetlbpage idle_page_tracking ksm
Documentation/vm/damon/api.rst new file +20 -0
@@ -0,0 +1,20 @@ +.. SPDX-License-Identifier: GPL-2.0 + +============= +API Reference +============= + +Kernel space programs can use every feature of DAMON using below APIs. All you +need to do is including ``damon.h``, which is located in ``include/linux/`` of +the source tree. + +Structures +========== + +.. kernel-doc:: include/linux/damon.h + + +Functions +========= + +.. kernel-doc:: mm/damon.c
Documentation/vm/damon/design.rst new file +166 -0
166 lines not on this page · raw message
Documentation/vm/damon/eval.rst new file +225 -0
225 lines not on this page · raw message
Documentation/vm/damon/faq.rst new file +58 -0
58 lines not on this page · raw message
Documentation/vm/damon/index.rst new file +31 -0
@@ -0,0 +1,31 @@ +.. SPDX-License-Identifier: GPL-2.0 + +========================== +DAMON: Data Access MONitor +========================== + +DAMON is a data access monitoring framework subsystem for the Linux kernel. +The core mechanisms of DAMON (refer to :doc:`design` for the detail) make it + + - *accurate* (the monitoring output is useful enough for DRAM level memory + management; It might not appropriate for CPU Cache levels, though), + - *light-weight* (the monitoring overhead is low enough to be applied online), + and + - *scalable* (the upper-bound of the overhead is in constant range regardless + of the size of target workloads). + +Using this framework, therefore, the kernel's memory management mechanisms can +make advanced decisions. Experimental memory management optimization works +that incurring high data accesses monitoring overhead could implemented again. +In user space, meanwhile, users who have some special workloads can write +personalized applications for better understanding and optimizations of their +workloads and systems. + +.. toctree:: + :maxdepth: 2 + + faq + design + eval + api + plans
Documentation/vm/index.rst +1 -0
@@ -31,6 +31,7 @@ descriptions of data structures and algorithms. active_mm balance cleancache + damon/index free_page_reporting frontswap highmem
Signature · 1 line
2.17.1
PATCH v21 16/18 mm/damon: Add kunit tests
In reply to SeongJae ParkFrom: SeongJae Park <[email protected]>
This commit adds kunit based unit tests for DAMON.
--- mm/damon/Kconfig | 33 ++++ mm/damon/core-test.h | 253 ++++++++++++++++++++++++++++ mm/damon/core.c | 6 + mm/damon/dbgfs-test.h | 209 +++++++++++++++++++++++ mm/damon/dbgfs.c | 2 + mm/damon/primitives-test.h | 328 +++++++++++++++++++++++++++++++++++++ mm/damon/primitives.c | 6 + 7 files changed, 837 insertions(+) create mode 100644 mm/damon/core-test.h create mode 100644 mm/damon/dbgfs-test.h create mode 100644 mm/damon/primitives-test.h
mm/damon/Kconfig +33 -0
@@ -12,6 +12,17 @@ config DAMON See https://damonitor.github.io/doc/html/latest-damon/index.html for more information. +config DAMON_KUNIT_TEST + bool "Test for damon" + depends on DAMON && KUNIT + help + This builds the DAMON Kunit test suite. + + For more information on KUnit and unit tests in general, please refer + to the KUnit documentation. + + If unsure, say N. + config DAMON_PRIMITIVES bool "Monitoring primitives for virtual address spaces monitoring" depends on DAMON && MMU
@@ -22,6 +33,17 @@ config DAMON_PRIMITIVES The primitives support only virtual address spaces. If this cannot cover your use case, you can implement and use your own primitives. +config DAMON_PRIMITIVES_KUNIT_TEST + bool "Test for DAMON primitives" + depends on DAMON_PRIMITIVES && KUNIT + help + This builds the DAMON PRIMITIVES Kunit test suite. + + For more information on KUnit and unit tests in general, please refer + to the KUnit documentation. + + If unsure, say N. + config DAMON_DBGFS bool "DAMON debugfs interface" depends on DAMON_PRIMITIVES && DEBUG_FS
@@ -31,4 +53,15 @@ config DAMON_DBGFS If unsure, say N. +config DAMON_DBGFS_KUNIT_TEST + bool "Test for damon debugfs interface" + depends on DAMON_DBGFS && KUNIT + help + This builds the DAMON debugfs interface Kunit test suite. + + For more information on KUnit and unit tests in general, please refer + to the KUnit documentation. + + If unsure, say N. + endmenu
mm/damon/core-test.h new file +253 -0
253 lines not on this page · raw message
mm/damon/core.c +6 -0
@@ -17,7 +17,11 @@#include <trace/events/damon.h> /* Minimal region size. Every damon_region is aligned by this. */ +#ifndef CONFIG_DAMON_KUNIT_TEST #define MIN_REGION PAGE_SIZE +#else +#define MIN_REGION 1 +#endif /* * Functions and macros for DAMON data structures
@@ -703,3 +707,5 @@ static int kdamond_fn(void *data)do_exit (0 ); } + +#include "core-test.h"
mm/damon/dbgfs-test.h new file +209 -0
209 lines not on this page · raw message
mm/damon/dbgfs.c +2 -0
@@ -914,3 +914,5 @@ static int __init damon_dbgfs_init(void) }module_init (damon_dbgfs_init); + +#include "dbgfs-test.h"
mm/damon/primitives-test.h new file +328 -0
328 lines not on this page · raw message
mm/damon/primitives.c +6 -0
@@ -20,7 +20,11 @@ DEFINE_MUTEX(page_idle_lock);#endif /* Minimal region size. Every damon_region is aligned by this. */ +#ifndef CONFIG_DAMON_PRIMITIVES_KUNIT_TEST #define MIN_REGION PAGE_SIZE +#else +#define MIN_REGION 1 +#endif /* Get a random number in [l, r) */ #define damon_rand (l, r) (l + prandom_u32_max(r - l))
@@ -587,3 +591,5 @@ void damon_va_set_primitives(struct damon_ctx *ctx) ctx->primitive.target_valid = damon_va_target_valid; ctx->primitive.cleanup = damon_va_cleanup; } + +#include "primitives-test.h"
Signature · 1 line
2.17.1
kernel test robot
build botRe: [PATCH v21 16/18] mm/damon: Add kunit tests
Thank you for the patch! Yet something to improve:
Hi SeongJae,
Thank you for the patch! Yet something to improve:
[auto build test ERROR on hnaz-linux-mm/master]
[also build test ERROR on kselftest/next tip/perf/core linus/master v5.9-rc8 next-20201002] [If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]
url: https://github.com/0day-ci/linux/commits/SeongJae-Park/Introduce-Data-Access-MONitor-DAMON/20201005-190315 base: https://github.com/hnaz/linux-mm master config: mips-allmodconfig (attached as .config) compiler: mips-linux-gcc (GCC) 9.3.0
reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross chmod +x ~/bin/make.cross
# https://github.com/0day-ci/linux/commit/bcd8ade170e80e5d63dacb96beb007bfd4e2845e
git remote add linux-review https://github.com/0day-ci/linux
git fetch --no-tags linux-review SeongJae-Park/Introduce-Data-Access-MONitor-DAMON/20201005-190315 git checkout bcd8ade170e80e5d63dacb96beb007bfd4e2845e
# save the attached .config to linux build tree
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-9.3.0 make.cross ARCH=mips
If you fix the issue, kindly add following tag as appropriate
All errors (new ones prefixed by >>):
mips-linux-ld: mm/damon/core.o: in function `kunit_test_suites_init':
core.c:(.text.kunit_test_suites_init+0x2c): undefined reference to `__kunit_test_suites_init'
mips-linux-ld: mm/damon/core.o: in function `damon_test_merge_two':
>> core.c:(.text.damon_test_merge_two+0x1b8): undefined reference to `kunit_binary_assert_format' >> mips-linux-ld: core.c:(.text.damon_test_merge_two+0x1bc): undefined reference to `kunit_binary_assert_format' >> mips-linux-ld: core.c:(.text.damon_test_merge_two+0x244): undefined reference to `kunit_do_assertion' mips-linux-ld: core.c:(.text.damon_test_merge_two+0x2c0): undefined reference to `kunit_do_assertion' mips-linux-ld: core.c:(.text.damon_test_merge_two+0x33c): undefined reference to `kunit_do_assertion' >> mips-linux-ld: core.c:(.text.damon_test_merge_two+0x358): undefined reference to `kunit_binary_ptr_assert_format' mips-linux-ld: core.c:(.text.damon_test_merge_two+0x368): undefined reference to `kunit_binary_ptr_assert_format' mips-linux-ld: core.c:(.text.damon_test_merge_two+0x3c8): undefined reference to `kunit_do_assertion' mips-linux-ld: core.c:(.text.damon_test_merge_two+0x47c): undefined reference to `kunit_do_assertion' mips-linux-ld: mm/damon/core.o: in function `damon_test_merge_regions_of': >> core.c:(.text.damon_test_merge_regions_of+0x274): undefined reference to `kunit_binary_assert_format' >> mips-linux-ld: core.c:(.text.damon_test_merge_regions_of+0x278): undefined reference to `kunit_binary_assert_format' >> mips-linux-ld: core.c:(.text.damon_test_merge_regions_of+0x2fc): undefined reference to `kunit_do_assertion' mips-linux-ld: core.c:(.text.damon_test_merge_regions_of+0x428): undefined reference to `kunit_do_assertion' mips-linux-ld: core.c:(.text.damon_test_merge_regions_of+0x4a4): undefined reference to `kunit_do_assertion' mips-linux-ld: mm/damon/core.o: in function `damon_test_regions': >> core.c:(.text.damon_test_regions+0xe8): undefined reference to `kunit_binary_assert_format' >> mips-linux-ld: core.c:(.text.damon_test_regions+0x108): undefined reference to `kunit_binary_assert_format' >> mips-linux-ld: core.c:(.text.damon_test_regions+0x154): undefined reference to `kunit_do_assertion' mips-linux-ld: core.c:(.text.damon_test_regions+0x1d0): undefined reference to `kunit_do_assertion' mips-linux-ld: core.c:(.text.damon_test_regions+0x24c): undefined reference to `kunit_do_assertion' mips-linux-ld: core.c:(.text.damon_test_regions+0x318): undefined reference to `kunit_do_assertion' mips-linux-ld: core.c:(.text.damon_test_regions+0x43c): undefined reference to `kunit_do_assertion' mips-linux-ld: mm/damon/core.o:core.c:(.text.damon_test_regions+0x540): more undefined references to `kunit_do_assertion' follow mips-linux-ld: mm/damon/core.o: in function `damon_test_split_regions_of': >> core.c:(.text.damon_test_split_regions_of+0x178): undefined reference to `kunit_binary_assert_format' >> mips-linux-ld: core.c:(.text.damon_test_split_regions_of+0x1a4): undefined reference to `kunit_binary_assert_format' >> mips-linux-ld: core.c:(.text.damon_test_split_regions_of+0x1d0): undefined reference to `kunit_do_assertion' mips-linux-ld: core.c:(.text.damon_test_split_regions_of+0x314): undefined reference to `kunit_do_assertion' mips-linux-ld: mm/damon/core.o: in function `damon_test_split_at': >> core.c:(.text.damon_test_split_at+0x12c): undefined reference to `kunit_binary_assert_format' >> mips-linux-ld: core.c:(.text.damon_test_split_at+0x144): undefined reference to `kunit_binary_assert_format' >> mips-linux-ld: core.c:(.text.damon_test_split_at+0x1ac): undefined reference to `kunit_do_assertion' mips-linux-ld: core.c:(.text.damon_test_split_at+0x234): undefined reference to `kunit_do_assertion' mips-linux-ld: core.c:(.text.damon_test_split_at+0x2b0): undefined reference to `kunit_do_assertion' mips-linux-ld: core.c:(.text.damon_test_split_at+0x32c): undefined reference to `kunit_do_assertion' mips-linux-ld: mm/damon/core.o: in function `damon_test_target': >> core.c:(.text.damon_test_target+0x9c): undefined reference to `kunit_binary_assert_format' >> mips-linux-ld: core.c:(.text.damon_test_target+0xf4): undefined reference to `kunit_binary_assert_format' >> mips-linux-ld: core.c:(.text.damon_test_target+0x138): undefined reference to `kunit_do_assertion' mips-linux-ld: core.c:(.text.damon_test_target+0x200): undefined reference to `kunit_do_assertion' mips-linux-ld: core.c:(.text.damon_test_target+0x310): undefined reference to `kunit_do_assertion' mips-linux-ld: core.c:(.text.damon_test_target+0x3cc): undefined reference to `kunit_do_assertion' mips-linux-ld: mm/damon/core.o: in function `damon_test_aggregate': >> core.c:(.text.damon_test_aggregate+0x1d8): undefined reference to `kunit_binary_assert_format'
mips-linux-ld: core.c:(.text.damon_test_aggregate+0x1f4): undefined reference to `kunit_binary_assert_format'
mips-linux-ld: core.c:(.text.damon_test_aggregate+0x30c): undefined reference to `kunit_binary_assert_format'
mips-linux-ld: core.c:(.text.damon_test_aggregate+0x320): undefined reference to `kunit_binary_assert_format'
mips-linux-ld: core.c:(.text.damon_test_aggregate+0x3c0): undefined reference to `kunit_do_assertion'
mips-linux-ld: core.c:(.text.damon_test_aggregate+0x468): undefined reference to `kunit_do_assertion'
mips-linux-ld: core.c:(.text.damon_test_aggregate+0x524): undefined reference to `kunit_do_assertion'
mips-linux-ld: mm/damon/primitives.o: in function `kunit_test_suites_init':
primitives.c:(.text.kunit_test_suites_init+0x2c): undefined reference to `__kunit_test_suites_init'
mips-linux-ld: mm/damon/primitives.o: in function `damon_test_split_evenly':
primitives.c:(.text.damon_test_split_evenly+0x15c): undefined reference to `kunit_binary_assert_format'
mips-linux-ld: primitives.c:(.text.damon_test_split_evenly+0x18c): undefined reference to `kunit_binary_assert_format'
mips-linux-ld: primitives.c:(.text.damon_test_split_evenly+0x1dc): undefined reference to `kunit_do_assertion'
mips-linux-ld: primitives.c:(.text.damon_test_split_evenly+0x258): undefined reference to `kunit_do_assertion'
mips-linux-ld: primitives.c:(.text.damon_test_split_evenly+0x2f0): undefined reference to `kunit_do_assertion'
mips-linux-ld: primitives.c:(.text.damon_test_split_evenly+0x378): undefined reference to `kunit_do_assertion'
mips-linux-ld: primitives.c:(.text.damon_test_split_evenly+0x45c): undefined reference to `kunit_do_assertion'
mips-linux-ld: mm/damon/primitives.o:primitives.c:(.text.damon_test_split_evenly+0x4dc): more undefined references to `kunit_do_assertion' follow
mips-linux-ld: mm/damon/primitives.o: in function `damon_do_test_apply_three_regions.constprop.0':
primitives.c:(.text.damon_do_test_apply_three_regions.constprop.0+0x108): undefined reference to `kunit_binary_assert_format'
mips-linux-ld: primitives.c:(.text.damon_do_test_apply_three_regions.constprop.0+0x10c): undefined reference to `kunit_binary_assert_format'
mips-linux-ld: primitives.c:(.text.damon_do_test_apply_three_regions.constprop.0+0x250): undefined reference to `kunit_do_assertion'
mips-linux-ld: primitives.c:(.text.damon_do_test_apply_three_regions.constprop.0+0x2c8): undefined reference to `kunit_do_assertion'
mips-linux-ld: mm/damon/primitives.o: in function `damon_test_three_regions_in_vmas':
primitives.c:(.text.damon_test_three_regions_in_vmas+0x218): undefined reference to `kunit_binary_assert_format'
mips-linux-ld: primitives.c:(.text.damon_test_three_regions_in_vmas+0x22c): undefined reference to `kunit_binary_assert_format'
mips-linux-ld: primitives.c:(.text.damon_test_three_regions_in_vmas+0x284): undefined reference to `kunit_do_assertion'
mips-linux-ld: primitives.c:(.text.damon_test_three_regions_in_vmas+0x300): undefined reference to `kunit_do_assertion'
mips-linux-ld: primitives.c:(.text.damon_test_three_regions_in_vmas+0x37c): undefined reference to `kunit_do_assertion'
mips-linux-ld: primitives.c:(.text.damon_test_three_regions_in_vmas+0x3f8): undefined reference to `kunit_do_assertion'
mips-linux-ld: primitives.c:(.text.damon_test_three_regions_in_vmas+0x474): undefined reference to `kunit_do_assertion'
mips-linux-ld: mm/damon/primitives.o:primitives.c:(.text.damon_test_three_regions_in_vmas+0x4f0): more undefined references to `kunit_do_assertion' follow
mips-linux-ld: mm/damon/dbgfs.o: in function `kunit_test_suites_init':
dbgfs.c:(.text.kunit_test_suites_init+0x2c): undefined reference to `__kunit_test_suites_init'
mips-linux-ld: mm/damon/dbgfs.o: in function `damon_dbgfs_test_set_targets':
dbgfs.c:(.text.damon_dbgfs_test_set_targets+0x1f4): undefined reference to `kunit_binary_assert_format'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_set_targets+0x20c): undefined reference to `kunit_binary_assert_format'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_set_targets+0x270): undefined reference to `kunit_do_assertion'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_set_targets+0x308): undefined reference to `kunit_do_assertion'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_set_targets+0x3ac): undefined reference to `kunit_do_assertion'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_set_targets+0x44c): undefined reference to `kunit_do_assertion'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_set_targets+0x4d8): undefined reference to `kunit_do_assertion'
mips-linux-ld: mm/damon/dbgfs.o: in function `damon_dbgfs_test_aggregate':
dbgfs.c:(.text.damon_dbgfs_test_aggregate+0x23c): undefined reference to `kunit_binary_assert_format'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_aggregate+0x240): undefined reference to `kunit_binary_assert_format'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_aggregate+0x2ac): undefined reference to `kunit_do_assertion'
mips-linux-ld: mm/damon/dbgfs.o: in function `damon_dbgfs_test_write_rbuf':
dbgfs.c:(.text.damon_dbgfs_test_write_rbuf+0x140): undefined reference to `kunit_binary_assert_format'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_write_rbuf+0x16c): undefined reference to `kunit_binary_assert_format'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_write_rbuf+0x1d0): undefined reference to `kunit_do_assertion'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_write_rbuf+0x254): undefined reference to `kunit_do_assertion'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_write_rbuf+0x2c8): undefined reference to `kunit_do_assertion'
mips-linux-ld: mm/damon/dbgfs.o: in function `damon_dbgfs_test_set_recording':
dbgfs.c:(.text.damon_dbgfs_test_set_recording+0x148): undefined reference to `kunit_binary_assert_format'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_set_recording+0x158): undefined reference to `kunit_binary_assert_format'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_set_recording+0x1b0): undefined reference to `kunit_do_assertion'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_set_recording+0x24c): undefined reference to `kunit_do_assertion'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_set_recording+0x2d4): undefined reference to `kunit_do_assertion'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_set_recording+0x378): undefined reference to `kunit_do_assertion'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_set_recording+0x3f0): undefined reference to `kunit_do_assertion'
mips-linux-ld: mm/damon/dbgfs.o: in function `damon_dbgfs_test_str_to_target_ids':
dbgfs.c:(.text.damon_dbgfs_test_str_to_target_ids+0x1b8): undefined reference to `kunit_binary_assert_format'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_str_to_target_ids+0x1e8): undefined reference to `kunit_binary_assert_format'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_str_to_target_ids+0x248): undefined reference to `kunit_do_assertion'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_str_to_target_ids+0x2c8): undefined reference to `kunit_do_assertion'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_str_to_target_ids+0x3b4): undefined reference to `kunit_do_assertion'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_str_to_target_ids+0x420): undefined reference to `kunit_do_assertion'
mips-linux-ld: dbgfs.c:(.text.damon_dbgfs_test_str_to_target_ids+0x510): undefined reference to `kunit_do_assertion'
mips-linux-ld: mm/damon/dbgfs.o:dbgfs.c:(.text.damon_dbgfs_test_str_to_target_ids+0x608): more undefined references to `kunit_do_assertion' follow
---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all(a)lists.01.org
kernel test robot
build botRe: [PATCH v21 16/18] mm/damon: Add kunit tests
In reply to SeongJae ParkThank you for the patch! Yet something to improve:
Hi SeongJae,
Thank you for the patch! Yet something to improve:
[auto build test ERROR on hnaz-linux-mm/master]
[also build test ERROR on kselftest/next tip/perf/core linus/master v5.9-rc8 next-20201002] [If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]
url: https://github.com/0day-ci/linux/commits/SeongJae-Park/Introduce-Data-Access-MONitor-DAMON/20201005-190315 base: https://github.com/hnaz/linux-mm master config: m68k-allmodconfig (attached as .config) compiler: m68k-linux-gcc (GCC) 9.3.0
reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross chmod +x ~/bin/make.cross
# https://github.com/0day-ci/linux/commit/bcd8ade170e80e5d63dacb96beb007bfd4e2845e
git remote add linux-review https://github.com/0day-ci/linux
git fetch --no-tags linux-review SeongJae-Park/Introduce-Data-Access-MONitor-DAMON/20201005-190315 git checkout bcd8ade170e80e5d63dacb96beb007bfd4e2845e
# save the attached .config to linux build tree
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-9.3.0 make.cross ARCH=m68k
If you fix the issue, kindly add following tag as appropriate
All errors (new ones prefixed by >>):
m68k-linux-ld: mm/damon/core.o: in function `damon_test_merge_two':
core.c:(.text+0x63e): undefined reference to `kunit_binary_assert_format'
>> m68k-linux-ld: core.c:(.text+0x6ae): undefined reference to `kunit_binary_assert_format' m68k-linux-ld: core.c:(.text+0x722): undefined reference to `kunit_binary_assert_format' >> m68k-linux-ld: core.c:(.text+0x790): undefined reference to `kunit_binary_ptr_assert_format' m68k-linux-ld: core.c:(.text+0x83c): undefined reference to `kunit_binary_assert_format' m68k-linux-ld: mm/damon/core.o: in function `damon_test_merge_regions_of': core.c:(.text+0xa66): undefined reference to `kunit_binary_assert_format' m68k-linux-ld: core.c:(.text+0xb0e): undefined reference to `kunit_binary_assert_format' m68k-linux-ld: core.c:(.text+0xb7a): undefined reference to `kunit_binary_assert_format' m68k-linux-ld: mm/damon/core.o: in function `damon_test_regions': core.c:(.text+0xc20): undefined reference to `kunit_binary_assert_format' m68k-linux-ld: mm/damon/core.o:core.c:(.text+0xc96): more undefined references to `kunit_binary_assert_format' follow m68k-linux-ld: mm/damon/core.o: in function `kunit_test_suites_init': core.c:(.text+0x8c): undefined reference to `__kunit_test_suites_init' m68k-linux-ld: mm/damon/core.o: in function `damon_test_merge_two': core.c:(.text+0x682): undefined reference to `kunit_do_assertion' >> m68k-linux-ld: core.c:(.text+0x6f6): undefined reference to `kunit_do_assertion' m68k-linux-ld: core.c:(.text+0x76c): undefined reference to `kunit_do_assertion' m68k-linux-ld: core.c:(.text+0x7ea): undefined reference to `kunit_do_assertion' m68k-linux-ld: core.c:(.text+0x878): undefined reference to `kunit_do_assertion' m68k-linux-ld: mm/damon/core.o:core.c:(.text+0xaa6): more undefined references to `kunit_do_assertion' follow m68k-linux-ld: mm/damon/primitives.o: in function `damon_test_split_evenly': primitives.c:(.text+0x23a): undefined reference to `kunit_binary_assert_format' >> m68k-linux-ld: primitives.c:(.text+0x2cc): undefined reference to `kunit_binary_assert_format' m68k-linux-ld: primitives.c:(.text+0x356): undefined reference to `kunit_binary_assert_format' m68k-linux-ld: primitives.c:(.text+0x3cc): undefined reference to `kunit_binary_assert_format' m68k-linux-ld: primitives.c:(.text+0x48c): undefined reference to `kunit_binary_assert_format' m68k-linux-ld: mm/damon/primitives.o:primitives.c:(.text+0x502): more undefined references to `kunit_binary_assert_format' follow m68k-linux-ld: mm/damon/primitives.o: in function `kunit_test_suites_init': primitives.c:(.text+0x14c): undefined reference to `__kunit_test_suites_init' m68k-linux-ld: mm/damon/primitives.o: in function `damon_test_split_evenly': primitives.c:(.text+0x286): undefined reference to `kunit_do_assertion' m68k-linux-ld: mm/damon/primitives.o: in function `damon_do_test_apply_three_regions.constprop.0': primitives.c:(.text+0xc82): undefined reference to `kunit_do_assertion' m68k-linux-ld: mm/damon/primitives.o: in function `damon_test_three_regions_in_vmas': primitives.c:(.text+0x1208): undefined reference to `kunit_do_assertion' m68k-linux-ld: mm/damon/dbgfs.o: in function `damon_dbgfs_test_aggregate': dbgfs.c:(.text+0x9ca): undefined reference to `kunit_binary_assert_format' m68k-linux-ld: mm/damon/dbgfs.o: in function `damon_dbgfs_test_write_rbuf': dbgfs.c:(.text+0xaba): undefined reference to `kunit_binary_assert_format' >> m68k-linux-ld: dbgfs.c:(.text+0xb42): undefined reference to `kunit_binary_assert_format'
m68k-linux-ld: dbgfs.c:(.text+0xbb0): undefined reference to `kunit_binary_assert_format'
m68k-linux-ld: mm/damon/dbgfs.o: in function `damon_dbgfs_test_set_recording':
dbgfs.c:(.text+0xc6e): undefined reference to `kunit_binary_assert_format'
m68k-linux-ld: mm/damon/dbgfs.o:dbgfs.c:(.text+0xcfe): more undefined references to `kunit_binary_assert_format' follow
m68k-linux-ld: mm/damon/dbgfs.o: in function `kunit_test_suites_init':
dbgfs.c:(.text+0x82c): undefined reference to `__kunit_test_suites_init'
m68k-linux-ld: mm/damon/dbgfs.o: in function `damon_dbgfs_test_aggregate':
dbgfs.c:(.text+0xa16): undefined reference to `kunit_do_assertion'
m68k-linux-ld: mm/damon/dbgfs.o: in function `damon_dbgfs_test_write_rbuf':
dbgfs.c:(.text+0xb04): undefined reference to `kunit_do_assertion'
m68k-linux-ld: mm/damon/dbgfs.o: in function `damon_dbgfs_test_set_recording':
dbgfs.c:(.text+0xcc0): undefined reference to `kunit_do_assertion'
m68k-linux-ld: mm/damon/dbgfs.o: in function `damon_dbgfs_test_set_targets':
dbgfs.c:(.text+0xfda): undefined reference to `kunit_do_assertion'
m68k-linux-ld: mm/damon/dbgfs.o: in function `damon_dbgfs_test_str_to_target_ids':
dbgfs.c:(.text+0x1b40): undefined reference to `kunit_do_assertion'
---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all(a)lists.01.org
PATCH v21 17/18 mm/damon: Add user space selftests
In reply to SeongJae ParkFrom: SeongJae Park <[email protected]>
This commit adds a simple user space tests for DAMON. The tests are using kselftest framework.
--- tools/testing/selftests/damon/Makefile | 7 + .../selftests/damon/_chk_dependency.sh | 28 +++ tools/testing/selftests/damon/_chk_record.py | 109 ++++++++++++ .../testing/selftests/damon/debugfs_attrs.sh | 161 ++++++++++++++++++ .../testing/selftests/damon/debugfs_record.sh | 50 ++++++ 5 files changed, 355 insertions(+) create mode 100644 tools/testing/selftests/damon/Makefile create mode 100644 tools/testing/selftests/damon/_chk_dependency.sh create mode 100644 tools/testing/selftests/damon/_chk_record.py create mode 100755 tools/testing/selftests/damon/debugfs_attrs.sh create mode 100755 tools/testing/selftests/damon/debugfs_record.sh
tools/testing/selftests/damon/Makefile new file +7 -0
@@ -0,0 +1,7 @@ +# SPDX-License-Identifier: GPL-2.0 +# Makefile for damon selftests + +TEST_FILES = _chk_dependency.sh _chk_record_file.py +TEST_PROGS = debugfs_attrs.sh debugfs_record.sh + +include ../lib.mk
tools/testing/selftests/damon/_chk_dependency.sh new file +28 -0
@@ -0,0 +1,28 @@ +#!/bin/bash +# SPDX-License-Identifier: GPL-2.0 + +# Kselftest framework requirement - SKIP code is 4. +ksft_skip=4 + +DBGFS=/sys/kernel/debug/damon + +if [ $EUID -ne 0 ]; +then + echo "Run as root" + exit $ksft_skip +fi + +if [ ! -d $DBGFS ] +then + echo "$DBGFS not found" + exit $ksft_skip +fi + +for f in attrs record target_ids monitor_on +do + if [ ! -f "$DBGFS/$f" ] + then + echo "$f not found" + exit 1 + fi +done
tools/testing/selftests/damon/_chk_record.py new file +109 -0
109 lines not on this page · raw message
tools/testing/selftests/damon/debugfs_attrs.sh new file +161 -0
161 lines not on this page · raw message
tools/testing/selftests/damon/debugfs_record.sh new file +50 -0
50 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v21 18/18 MAINTAINERS: Update for DAMON
In reply to SeongJae ParkFrom: SeongJae Park <[email protected]>
This commit updates MAINTAINERS file for DAMON related files.
--- MAINTAINERS | 12 ++++++++++++ 1 file changed, 12 insertions(+)
MAINTAINERS +12 -0
@@ -4751,6 +4751,18 @@ F: net/ax25/ax25_out.c F: net/ax25/ax25_timer.c F: net/ax25/sysctl_net_ax25.c +DATA ACCESS MONITOR +M: SeongJae Park <[email protected]> +L: [email protected] +S: Maintained +F: Documentation/admin-guide/mm/damon/* +F: Documentation/vm/damon/* +F: include/linux/damon.h +F: include/trace/events/damon.h +F: mm/damon/* +F: tools/damon/* +F: tools/testing/selftests/damon/* + DAVICOM FAST ETHERNET (DMFE) NETWORK DRIVER L: [email protected] S: Orphan
Signature · 1 line
2.17.1