.. SPDX-License-Identifier: GPL-2.0
.. include:: ../../../disclaimer-zh_CN.rst

:Original: Documentation/admin-guide/mm/damon/start.rst

:翻译:

 司延腾 Yanteng Si <siyanteng@loongson.cn>

:校译:

========
入门指南
========

本文通过演示DAMON的默认用户空间工具，简要地介绍了如何使用DAMON。请注意，为了简洁
起见，本文档只描述了它的部分功能。更多细节请参考该工具的使用文档。
`doc <https://github.com/damonitor/damo/blob/next/USAGE.md>`_ .


前提条件
========

内核
----

首先，你要确保你当前系统中跑的内核构建时选定了这个功能选项 ``CONFIG_DAMON_*=y``.


用户空间工具
------------

在演示中，我们将使用DAMON的默认用户空间工具，称为DAMON Operator（DAMO）。它可以在
https://github.com/damonitor/damo找到。下面的例子假设DAMO在你的$PATH上。当然，但
这并不是强制性的。

因为DAMO使用了DAMON的sysfs接口（详情请参考:doc:`usage`），你应该确保
``sysfs`` 被挂载。


拍摄数据访问模式快照
====================

下面的命令展示程序在执行时刻的内存访问模式。::

    $ git clone https://github.com/sjp38/masim; cd masim; make
    $ sudo damo start "./masim ./configs/stairs.cfg --quiet"
    $ sudo damo report access
    heatmap: 641111111000000000000000000000000000000000000000000000[...]33333333333333335557984444[...]7
    # min/max temperatures: -1,840,000,000, 370,010,000, column size: 3.925 MiB
    0   addr 86.182 TiB   size 8.000 KiB   access 0 %   age 14.900 s
    1   addr 86.182 TiB   size 8.000 KiB   access 60 %  age 0 ns
    2   addr 86.182 TiB   size 3.422 MiB   access 0 %   age 4.100 s
    3   addr 86.182 TiB   size 2.004 MiB   access 95 %  age 2.200 s
    4   addr 86.182 TiB   size 29.688 MiB  access 0 %   age 14.100 s
    5   addr 86.182 TiB   size 29.516 MiB  access 0 %   age 16.700 s
    6   addr 86.182 TiB   size 29.633 MiB  access 0 %   age 17.900 s
    7   addr 86.182 TiB   size 117.652 MiB access 0 %   age 18.400 s
    8   addr 126.990 TiB  size 62.332 MiB  access 0 %   age 9.500 s
    9   addr 126.990 TiB  size 13.980 MiB  access 0 %   age 5.200 s
    10  addr 126.990 TiB  size 9.539 MiB   access 100 % age 3.700 s
    11  addr 126.990 TiB  size 16.098 MiB  access 0 %   age 6.400 s
    12  addr 127.987 TiB  size 132.000 KiB access 0 %   age 2.900 s
    total size: 314.008 MiB
    $ sudo damo stop

上面示例的第一条命令下载并构建一个名为 ``masim`` 的人工内存访问
生成程序。第二条命令要求 DAMO 用给定命令启动该程序，并让 DAMON
监测新启动的进程。第三条命令从 DAMON 取回该进程当前被监测访问
模式的快照，并以人类可读的格式显示该模式。

输出的第一行以单行热图格式显示各区域的相对访问温度（热度）。热图
中的每一列表示被监测虚拟地址空间上大小相同的区域。列在该行中的
位置和列上的数字表示该区域的相对位置和访问温度。``[...]`` 表示
虚拟地址空间中未映射的巨大区域。第二行显示帮助理解热图的附加信息。

从第三行开始，输出的每一行显示进程的哪个虚拟地址范围
（``addr XX size XX``）被访问得有多频繁（``access XX %``），以及
持续了多长时间（``age XX``）。例如，大小约为 9.5 MiB 的第十一个
区域在最近 3.7 秒内被访问得最频繁。最后，第四条命令停止 DAMON。

请注意，DAMON 不仅能监测虚拟地址空间，还能监测包括物理地址空间在内
的多种地址空间。


记录数据访问模式
================

下面的命令记录了一个程序的内存访问模式，并将监测结果保存到文件中。 ::

    $ ./masim ./configs/zigzag.cfg &
    $ sudo damo record -o damon.data $(pidof masim)

第一行命令再次运行该人工内存访问生成器程序。生成器将重复地逐一访问两个
100 MiB大小的内存区域。你可以用你的真实工作负载来代替它。最后一行要求 ``damo`` 将
访问模式记录在 ``damon.data`` 文件中。


将记录的模式可视化
==================

你可以在heatmap中直观地看到这种模式，显示哪个内存区域（X轴）何时被访问（Y轴）以及访
问的频率（数字）。::

    $ sudo damo report heatmap
    22222222222222222222222222222222222222211111111111111111111111111111111111111100
    44444444444444444444444444444444444444434444444444444444444444444444444444443200
    44444444444444444444444444444444444444433444444444444444444444444444444444444200
    33333333333333333333333333333333333333344555555555555555555555555555555555555200
    33333333333333333333333333333333333344444444444444444444444444444444444444444200
    22222222222222222222222222222222222223355555555555555555555555555555555555555200
    00000000000000000000000000000000000000288888888888888888888888888888888888888400
    00000000000000000000000000000000000000288888888888888888888888888888888888888400
    33333333333333333333333333333333333333355555555555555555555555555555555555555200
    88888888888888888888888888888888888888600000000000000000000000000000000000000000
    88888888888888888888888888888888888888600000000000000000000000000000000000000000
    33333333333333333333333333333333333333444444444444444444444444444444444444443200
    00000000000000000000000000000000000000288888888888888888888888888888888888888400
    [...]
    # access_frequency:  0  1  2  3  4  5  6  7  8  9
    # x-axis: space (139728247021568-139728453431248: 196.848 MiB)
    # y-axis: time (15256597248362-15326899978162: 1 m 10.303 s)
    # resolution: 80x40 (2.461 MiB and 1.758 s for each character)

你也可以直观地看到工作集的大小分布，按大小排序。::

    $ sudo damo report wss --range 0 101 10
    # <percentile> <wss>
    # target_id     18446632103789443072
    # avr:  107.708 MiB
      0             0 B |                                                           |
     10      95.328 MiB |****************************                               |
     20      95.332 MiB |****************************                               |
     30      95.340 MiB |****************************                               |
     40      95.387 MiB |****************************                               |
     50      95.387 MiB |****************************                               |
     60      95.398 MiB |****************************                               |
     70      95.398 MiB |****************************                               |
     80      95.504 MiB |****************************                               |
     90     190.703 MiB |*********************************************************  |
    100     196.875 MiB |***********************************************************|

在上述命令中使用 ``--sortby`` 选项，可以显示工作集的大小是如何按时间顺序变化的。::

    $ sudo damo report wss --range 0 101 10 --sortby time
    # <percentile> <wss>
    # target_id     18446632103789443072
    # avr:  107.708 MiB
      0       3.051 MiB |                                                           |
     10     190.703 MiB |***********************************************************|
     20      95.336 MiB |*****************************                              |
     30      95.328 MiB |*****************************                              |
     40      95.387 MiB |*****************************                              |
     50      95.332 MiB |*****************************                              |
     60      95.320 MiB |*****************************                              |
     70      95.398 MiB |*****************************                              |
     80      95.398 MiB |*****************************                              |
     90      95.340 MiB |*****************************                              |
    100      95.398 MiB |*****************************                              |


数据访问模式感知的内存管理
==========================

以下命令使每一个大小>=4K的内存区域在你的工作负载中没有被访问>=60秒，就会被换掉。 ::

    $ sudo damo start --damos_access_rate 0 0 --damos_sz_region 4K max \
                      --damos_age 60s max --damos_action pageout \
                      --target_pid <pid of your workload>
