$ git log --pretty=format:'%h %s (%cs)%d'
cde9296 Update the version (2024-10-28)
(HEAD -> master, tag: v2.5.3)
4a974c7 release_note: add missed change (2024-10-28)
0732a64 _damo_records: cleanup applying filter on get_records() using RecordFilter.filter_records() (2024-10-27)
d66d1da _damo_records: Implement RecordFilter method for filtering records (2024-10-27)
f696eb2 _damo_records/filter_by_pattern(): use region_of_pattern() (2024-10-27)
a478b2f _damo_records: add a function for region-pattern check (2024-10-27)
71a345b damo_report_times: Show the unit (2024-10-27)
8bf7cb7 release_note: Update for next release (2024-10-27)
0177fd2 damo: move fmt_json to bottom of help message (2024-10-27)
da13022 damo_report: show 'access' at top of the help message (2024-10-27)
...
$ git cat-file blob HEAD:README.md
DAMO: Data Access Monitoring Operator
=====================================
`damo` is a user space tool for [DAMON](https://damonitor.github.io). Using
this, you can monitor the data access patterns of your system or workloads and
make data access-aware memory management optimizations.
![damo monitor demo for water_nsquared](images/damo_monitor_water_nsquared.gif)
Official Repositories
---------------------
Official git repos for `damo` are hosted on kernel.org and GitHub:
- kernel.org: https://git.kernel.org/pub/scm/linux/kernel/git/sj/damo.git
- GitHub: https://github.com/damonitor/damo
_Note_ that the repo under awslabs GitHub organization
(https://github.com/awslabs/damo)
[was](https://lore.kernel.org/20240813232158.83903-1-sj@kernel.org) one of the
official repos. It is not an official repo since 2024-09-05.
Demo Video
==========
Please click the below thumbnail to show the short demo video.
[![DAMON: a demo for the Kernel Summit 2020](
http://img.youtube.com/vi/l63eqbVBZRY/0.jpg)](
http://www.youtube.com/watch?v=l63eqbVBZRY
"DAMON: a demo for the Kernel Summit 2020")
Getting Started
===============
[![Packaging status](https://repology.org/badge/vertical-allrepos/damo.svg)](https://repology.org/project/damo/versions)
Follow below instructions and commands to monitor and visualize the access
pattern of your workload.
$ # ensure DAMON is enabled on your kernel
$ # install damo using packaging systems listed above,
$ # or cloning the source repo and updating $PATH.
$ sudo damo start $(pidof <your workload>)
$ sudo damo report access
$ sudo damo record ongoing
$ sudo damo report heatmaps --heatmap stdout --stdout_colorset emotion
The second and last commands will show the access pattern of your workload,
like below:
![masim_stairs_snapshot](images/masim_stairs_snapshot.png)
![masim stairs heatmap in ascii](images/masim_stairs_heatmap_ascii.png)
FAQs
====
How can I ensure DAMON is enabled on my kernel?
-----------------------------------------------
Please refer to 'Install'
[section](https://sjp38.github.io/post/damon/#install) of the project webpage.
Where can I get more detailed usage?
------------------------------------
The below sections provide quick introductions for `damo`'s major features.
For more detailed usage, please refer to [USAGE.md](USAGE.md) file.
What does the version numbers mean?
-----------------------------------
Nothing at all but indicate which version is more fresh. A higher version
number means it is more recently released.
Will the features of `damo` be supported forever?
-------------------------------------------------
We try our best to make `damo` stable and doesn't introduce regressions to
users. However, nothing goes forever. Sometimes, some features will be
deprecated. Some features will have longer support more than others.
In short, features that documented on [USAGE.md](USAGE.md) and not explicitly
marked as experimental, the feature will be better supported, and provides at
least three months of deprecation grace period. Within the grace period, users
can ask extension of the support.
Detailed features deprecation process is documented at
[FEATURES_DEPRECATION_PROCESS.md](FEATURES_DEPRECATION_PROCESS.md). Schedules
and status of deprecations are updated on
[FEATURES_DEPRECATION_SCHEDULE.md](FEATURES_DEPRECATION_SCHEDULE.md).
How can I participate in the development of `damo`?
---------------------------------------------------
Please refer to
[CONTRIBUTING](https://github.com/damonitor/damo/blob/next/CONTRIBUTING) file.
Quick Intro for Major Features
==============================
Below are quick introductions for `damo`'s major features.
For more detailed usage, please refer to [USAGE.md](USAGE.md) file.
Snapshot Data Access Pattern
----------------------------
Below commands repeatedly get a snapshot of the access pattern of a program for
every second.
$ git clone https://github.com/sjp38/masim
$ cd masim; make; ./masim ./configs/zigzag.cfg --silent &
$ sudo damo start --target_pid $(pidof masim)
$ while :; do sudo damo report access; sleep 1; done
The first two lines of the commands get an artificial memory access generator
program and run it in the background. It will repeatedly access two 100
MiB-sized memory regions one by one. You can substitute this with your real
workload.
The third line asks ``damo`` to start monitoring the access pattern of the
process. Finally, the last line retries a snapshot of the monitoring results
every second and show on terminal.
Recording Data Access Patterns
------------------------------
Below commands record memory access patterns of a program and save the
monitoring results in `damon.data` file.
$ git clone https://github.com/sjp38/masim
$ cd masim; make; ./masim ./configs/zigzag.cfg --silent &
$ sudo damo record -o damon.data $(pidof masim)
The first two lines of the commands get an artificial memory access generator
program and run it in the background. It will repeatedly access two 100
MiB-sized memory regions one by one. You can substitute this with your real
workload. The last line asks ``damo`` to record the access pattern in
``damon.data`` file.
Visualizing Recorded Patterns
-----------------------------
Below three commands visualize the recorded access patterns into three
image files.
$ damo report heatmap
$ damo report wss --range 0 101 1
$ damo report wss --range 0 101 1 --sortby time --plot
- ``access_pattern_heatmap.png`` will show the data access pattern in a
heatmap, which shows when (x-axis) what memory region (y-axis) is how
frequently accessed (color).
- ``wss_dist.png`` will show the distribution of the working set size.
- ``wss_chron_change.png`` will show how the working set size has
chronologically changed.
You can show the images on a web page [1]. Those made with other realistic
workloads are also available [2,3,4].
[1] https://damonitor.github.io/doc/html/latest/admin-guide/mm/damon/start.html#visualizing-recorded-patterns<br>
[2] https://damonitor.github.io/test/result/visual/latest/rec.heatmap.1.png.html<br>
[3] https://damonitor.github.io/test/result/visual/latest/rec.wss_sz.png.html<br>
[4] https://damonitor.github.io/test/result/visual/latest/rec.wss_time.png.html
Data Access Pattern Aware Memory Management
-------------------------------------------
Below command makes every memory region of size >=4K that hasn't accessed for
>=60 seconds in your workload to be swapped out. By doing this, you can make
your workload more memory efficient with only modest performance overhead.
$ sudo damo start --damos_access_rate 0 0 --damos_sz_region 4K max \
--damos_age 60s max --damos_action pageout \
<pid of your workload>
Holistic Memory Usage Monitoring
--------------------------------
You can also show access pattern heatmap, memory footprints, and hotspot
functions of the system and/or workloads all at once in live, like below.
![damo monitor demo for water_nsquared](images/damo_monitor_holistic.gif)
# heads (aka `branches'):
$ git for-each-ref --sort=-creatordate refs/heads \
--format='%(HEAD) %(refname:short) %(subject) (%(creatordate:short))'
next _damo_yaml: do yaml module install check at the beginning of dump() (2024-10-30)
* master Update the version (2024-10-28)
# tags:
$ git for-each-ref --sort=-creatordate refs/tags \
--format='%(refname:short) %(subject) (%(creatordate:short))'
v2.5.3 DAMO 2.5.3 (2024-10-28) tar.gz
v2.5.2 DAMO 2.5.2 (2024-10-21) tar.gz
v2.5.1 DAMO 2.5.1 (2024-10-14) tar.gz
v2.5.0 DAMO 2.5.0 (2024-10-07) tar.gz
v2.4.9 DAMO 2.4.9 (2024-09-02) tar.gz
v2.4.8 DAMO 2.4.8 (2024-08-19) tar.gz
v2.4.7 DAMO 2.4.7 (2024-08-12) tar.gz
v2.4.6 DAMO 2.4.6 (2024-08-05) tar.gz
v2.4.5 DAMO 2.4.5 (2024-07-29) tar.gz
v2.4.4 DAMO 2.4.4 (2024-07-22) tar.gz
...
# associated public inboxes:
# (number on the left is used for dev purposes)
64 ../../../../../../../lkml
28 linux-mm
25 linux-doc
15 qemu-devel
15 u-boot
11 linux-arm-kernel
11 linuxppc-dev
10 dpdk-dev
9 netdev
8 alsa-devel
8 kvm
7 git
6 linux-wireless
6 xen-devel
6 linux-scsi
6 linux-btrfs
6 intel-gfx
6 linux-omap
5 linux-nfs
5 netfilter-devel
5 linux-fsdevel
5 linux-devicetree
5 linux-media
5 stable
5 linux-mips
5 kvmarm
5 linux-bluetooth
5 dri-devel
5 openbmc
5 buildroot
5 openembedded-devel
4 linux-mtd
4 bpf
4 linux-mediatek
4 linux-iommu
4 linux-input
4 selinux
4 linux-iio
4 linux-gpio
4 linux-rdma
4 linux-security-module
4 linux-ide
4 linux-watchdog
4 amd-gfx
4 linux-spi
4 linux-i2c
4 linux-kbuild
4 linux-arch
4 linux-s390
4 yocto-meta-arago
4 grub-devel
3 linux-samsung-soc
3 linux-block
3 linux-riscv
3 linux-nvme
3 linux-xfs
3 linux-crypto
3 linux-acpi
3 linux-edac
3 linux-cifs
3 linux-arm-msm
3 linux-amlogic
3 linux-erofs
3 fstests
3 linux-pm
3 linux-rtc
3 driverdev-devel
3 linux-usb
3 linux-renesas-soc
3 linux-kselftest
3 linux-clk
3 dmaengine
3 linux-ext4
3 linux-pci
3 linux-modules
3 linux-rt-users
3 linux-serial
3 linux-trace-devel
3 util-linux
3 backports
3 linux-man
3 linux-mmc
3 linux-api
3 linux-sparse
3 linux-tegra
3 virtualization
3 linux-fpga
3 linux-can
3 containers
3 linux-rockchip
3 linux-raid
3 platform-driver-x86
3 dm-devel
3 linux-fbdev
3 linux-cxl
3 linux-perf-users
3 linux-sh
3 nouveau
3 linux-staging
3 linux-coco
3 nvdimm
3 fio
3 iwd
3 ltp
3 yocto
3 yocto-meta-freescale
3 openembedded-core
3 yocto-meta-arm
3 bitbake-devel
3 yocto-meta-virtualization
3 yocto-meta-ti
3 outreachy
3 openrisc
3 intel-wired-lan
3 kexec
3 intel-xe
3 linux-um
3 poky
3 qemu-riscv
3 linux-hexagon
3 igt-dev
2 linux-efi
2 linux-integrity
2 linux-nvdimm
2 linux-snps-arc
2 linux-hwmon
2 linux-parisc
2 linux-leds
2 linux-f2fs-devel
2 linux-hyperv
2 rcu
2 linux-m68k
2 linux-i3c
2 wireguard
2 io-uring
2 linux-csky
2 linux-unionfs
2 linux-firmware
2 cip-dev
2 linux-remoteproc
2 linux-pwm
2 lttng-dev
2 ceph-devel
2 phone-devel
2 linux-hardening
2 dash
2 keyrings
2 lustre-devel
2 soc
2 rust-for-linux
2 linux-phy
2 kernel-janitors
2 sparclinux
2 linux-sunxi
2 mptcp
2 llvm
2 ofono
2 yocto-toaster
2 linux-patches
2 chrome-platform
2 xenomai
2 loongarch
2 imx
2 b4-sent
2 linux-trace-kernel
2 oe-kbuild-all
2 virtio-comment
2 v9fs
2 cluster-devel
2 cgroups
2 kvm-ppc
2 linux-alpha
2 linux-sound
2 reiserfs-devel
2 u-boot-amlogic
2 lvm-devel
2 perfbook
2 virtio-fs
2 fuego
1 linux-fscrypt
1 cocci
1 live-patching
1 kernel-hardening
1 linux-next
1 kernelnewbies
1 linux-sgx
1 workflows
1 selinux-refpolicy
1 linux-spdx
1 linux-wpan
1 ksummit-discuss
1 linux-kernel-mentees
1 tpmdd-devel
1 linux-audit
1 linux-dash
1 linux-bcache
1 mm-commits
1 xdp-newbies
1 linux-sctp
1 target-devel
1 ocfs2-devel
1 ath10k
1 ath11k
1 regressions
1 ksummit
1 b43-dev
1 linux-nfc
1 linux-bcachefs
1 ath9k-devel
1 ntfs3
1 linux-ppp
1 ell
1 yocto-docs
1 ntb
1 damon
1 asahi
1 ath12k
1 oe-linux-nfc
1 oe-chipsec
1 batman
1 fsverity
1 virtio-dev
1 ecryptfs
1 linux-ia64
1 kdevops
1 kbd
1 autofs
1 cpufreq
1 dccp
1 devicetree-spec
1 devicetree-compiler
1 initramfs
1 hail-devel
1 kvm-ia64
1 linux-8086
1 kernel-testers
1 linux-btrace
1 linux-embedded
1 linux-hams
1 linux-hotplug
1 linux-laptop
1 trinity
1 linux-metag
1 linux-x25
1 linux-nilfs
1 lvs-devel
1 netfilter
1 linux-oxnas
1 lm-sensors
1 acpica-devel
1 smatch
1 wireless-regdb
1 netfs
1 powertop
1 dtrace
1 yocto-patches
1 ../../../../../../../barebox
1 ../../../../../../../linux-aspeed
git clone https://yhbt.net/lore/pub/scm/linux/kernel/git/sj/damo.git