etmem

介绍

随着CPU算力的发展，尤其是ARM核成本的降低，内存成本和内存容量成为约束业务成本和性能的核心痛点，因此如何节省内存成本，如何扩大内存容量成为存储迫切要解决的问题。

etmem内存分级扩展技术，通过DRAM+内存压缩/高性能存储新介质形成多级内存存储，对内存数据进行分级，将分级后的内存冷数据从内存介质迁移到高性能存储介质中，达到内存容量扩展的目的，从而实现内存成本下降。

编译教程

1. 下载etmem源码

   $ git clone https://gitee.com/openeuler/etmem.git

2. 编译和运行依赖

   etmem的编译和运行依赖于libboundscheck组件

3. 编译

   $ cd etmem

   $ mkdir build

   $ cd build

   $ cmake ..

   $ make

注意事项

运行依赖

etmem作为内存扩展工具，需要依赖于内核态的特性支持，为了可以识别内存访问情况和支持主动将内存写入swap分区来达到内存垂直扩展的需求，etmem在运行时需要插入etmem_scan和etmem_swap模块：

modprobe etmem_scan
modprobe etmem_swap

openuler21.03、21.09、20.03 LTS SP2以及20.03 LTS SP3均支持etmem内存扩展相关特性，可以直接使用以上内核。

权限限制

运行etmem进程需要root权限，root用户具有系统最高权限，在使用root用户进行操作时，请严格按照操作指导进行操作，避免其他操作造成系统管理及安全风险。

使用约束

• etmem的客户端和服务端需要在同一个服务器上部署，不支持跨服务器通信的场景。
• etmem仅支持扫描进程名小于或等于15个字符长度的目标进程。
• 在使用AEP介质进行内存扩展的时候，依赖于系统可以正确识别AEP设备并将AEP设备初始化为numa node。并且配置文件中的vm_flags字段只能配置为ht。
• 引擎私有命令仅针对对应引擎和引擎下的任务有效，比如cslide所支持的showhostpages和showtaskpages。
• 第三方策略实现代码中，eng_mgt_func接口中的fd不能写入0xff和0xfe字。
• 支持在一个工程内添加多个不同的第三方策略动态库，以配置文件中的eng_name来区分。
• 禁止并发扫描同一个进程。未加载etmem_scan和etmem_swap ko时，禁止使用/proc/xxx/idle_pages和/proc/xxx/swap_pages文件

使用说明

启动etmemd进程

使用方法

通过运行etmemd二进制运行服务端进程，例如：

$ etmemd -l 0 -s etmemd_socket

帮助信息

options：

-l|--log-level Log level

-s|--socket Socket name to listen to

-h|--help Show this message

-m|--mode-systemctl mode used to start(systemctl)

命令行参数说明

etmem配置文件

在运行etmem进程之前，需要管理员预先规划哪些进程需要做内存扩展，将进程信息配置到etmem配置文件中，并配置内存扫描的周期、扫描次数、内存冷热阈值等信息。

配置文件的示例文件在源码包中，放置在/etc/etmem文件路径下，按照功能划分为3个示例文件，

/etc/etmem/cslide_conf.yaml
/etc/etmem/slide_conf.yaml
/etc/etmem/thirdparty_conf.yaml

示例内容分别为：

[project]
name=test
loop=1
interval=1
sleep=1

#slide引擎示例
[engine]
name=slide
project=test

[task]
project=test
engine=slide
name=background_slide
type=name
value=mysql
T=1
max_threads=1

#cslide引擎示例
[engine]
name=cslide
project=test
node_pair=2,0;3,1
hot_threshold=1
node_mig_quota=1024
node_hot_reserve=1024

[task]
project=test
engine=cslide
name=background_cslide
type=pid
name=23456
vm_flags=ht
anon_only=no
ign_host=no

#thirdparty引擎示例
[engine]
name=thirdparty
project=test
eng_name=my_engine
libname=/usr/lib/etmem_fetch/my_engine.so
ops_name=my_engine_ops
engine_private_key=engine_private_value

[task]
project=test
engine=my_engine
name=backgroud_third
type=pid
value=12345
task_private_key=task_private_value

配置文件各字段说明：

etmem project/engine/task对象的创建和删除

场景描述

1）管理员创建etmem的project/engine/task（一个工程可包含多个etmem engine，一个engine可以包含多个任务）

2）管理员删除已有的etmem project/engine/task（删除工程前，会自动先停止该工程中的所有任务）

使用方法

运行etmem二进制，通过第二个参数指定为obj，来进行创建或删除动作，对project/engine/task则是通过配置文件中配置的内容来进行识别和区分。前提是etmem配置文件已配置正确，etmemd进程已启动。

添加对象：

etmem obj add -f /etc/etmem/slide_conf.yaml -s etmemd_socket

删除对象：

etmem obj del -f /etc/etmem/slide_conf.yaml -s etmemd_socket

打印帮助：

etmem obj help

帮助信息

Usage:

etmem obj add [options]

etmem obj del [options]

etmem obj help

Options:

-f|--file <conf_file> Add configuration file

-s|--socket <socket_name> Socket name to connect

Notes:

1. Configuration file must be given.

命令行参数说明

etmem任务启动/停止/查询

场景描述

在已经通过etmem obj add添加工程之后，在还未调用etmem obj del删除工程之前，可以对etmem的工程进行启动和停止。

1）管理员启动已添加的工程

2）管理员停止已启动的工程

在管理员调用obj del删除工程时，如果工程已经启动，则会自动停止。

使用方法

对于已经添加成功的工程，可以通过etmem project的命令来控制工程的启动和停止，命令示例如下：

启动工程

etmem project start -n test -s etmemd_socket

停止工程

etmem project stop -n test -s etmemd_socket

查询工程

etmem project show -n test -s etmemd_socket

打印帮助

etmem project help

帮助信息

Usage:

etmem project start [options]

etmem project stop [options]

etmem project show [options]

etmem project help

Options:

-n|--name <proj_name> Add project name

-s|--socket <socket_name> Socket name to connect

Notes:

1. Project name and socket name must be given when execute add or del option.

2. Socket name must be given when execute show option.

命令行参数说明

etmem支持随系统自启动

场景描述

etmemd支持由用户配置systemd配置文件后，以fork模式作为systemd服务被拉起运行

使用方法

编写service配置文件，来启动etmemd，必须使用-m参数来指定此模式，例如

etmemd -l 0 -s etmemd_socket -m

帮助信息

options:

-l|--log-level Log level

-s|--socket Socket name to listen to

-m|--mode-systemctl mode used to start(systemctl)

-h|--help Show this message

命令行参数说明

etmem支持第三方内存扩展策略

场景描述

etmem支持用户注册第三方内存扩展策略，同时提供扫描模块动态库，运行时通过第三方策略淘汰算法淘汰内存。

用户使用etmem所提供的扫描模块动态库并实现对接etmem所需要的结构体中的接口

使用方法

用户使用自己实现的第三方扩展淘汰策略，主要需要按下面步骤进行实现和操作：

1. 按需调用扫描模块提供的扫描接口，

2. 按照etmem头文件中提供的函数模板来实现各个接口，最终封装成结构体

3. 编译出第三方扩展淘汰策略的动态库

4. 在配置文件中按要求声明类型为thirdparty的engine

5. 将动态库的名称和接口结构体的名称按要求填入配置文件中task对应的字段

其他操作步骤与使用etmem的其他engine类似

接口结构体模板

struct engine_ops {

/* 针对引擎私有参数的解析，如果有，需要实现，否则置NULL */

int (*fill_eng_params)(GKeyFile *config, struct engine *eng);

/* 针对引擎私有参数的清理，如果有，需要实现，否则置NULL */

void (*clear_eng_params)(struct engine *eng);

/* 针对任务私有参数的解析，如果有，需要实现，否则置NULL */

int (*fill_task_params)(GKeyFile *config, struct task *task);

/* 针对任务私有参数的清理，如果有，需要实现，否则置NULL */

void (*clear_task_params)(struct task *tk);

/* 启动任务的接口 */

int (*start_task)(struct engine *eng, struct task *tk);

/* 停止任务的接口 */

void (*stop_task)(struct engine *eng, struct task *tk);

/* 填充pid相关私有参数 */

int (*alloc_pid_params)(struct engine *eng, struct task_pid **tk_pid);

/* 销毁pid相关私有参数 */

void (*free_pid_params)(struct engine *eng, struct task_pid **tk_pid);

/* 第三方策略自身所需要的私有命令支持，如果没有，置为NULL */

int (*eng_mgt_func)(struct engine *eng, struct task *tk, char *cmd, int fd);

};

配置文件示例如下所示，具体含义请参考配置文件说明章节：

#thirdparty

[engine]

name=thirdparty

project=test

eng_name=my_engine

libname=/user/lib/etmem_fetch/code_test/my_engine.so

ops_name=my_engine_ops

engine_private_key=engine_private_value

[task]

project=test

engine=my_engine

name=background1

type=pid

value=1798245

task_private_key=task_private_value

注意 ：

用户需使用etmem所提供的扫描模块动态库并实现对接etmem所需要的结构体中的接口

eng_mgt_func接口中的fd不能写入0xff和0xfe字

支持在一个工程内添加多个不同的第三方策略动态库，以配置文件中的eng_name来区分

etmem支持使用AEP进行内存扩展

场景描述

使用etmem组件包，使能内存分级扩展至AEP的通路。

在节点内对虚拟机的大页进行扫描，并通过cslide引擎进行策略淘汰，将冷内存搬迁至AEP中

使用方法

使用cslide引擎进行内存扩展，参数示例如下，具体参数含义请参考配置文件说明章节

#cslide

[engine]

name=cslide

project=test

node_pair=2,0;3,1

hot_threshold=1

node_mig_quota=1024

node_hot_reserve=1024

[task]

project=test

engine=cslide

name=background1

type=pid

value=1823197

vm_flags=ht

anon_only=no

ign_host=no

注意 ：禁止并发扫描同一个进程

同时，此cslide策略支持私有的命令

• showtaskpages
• showhostpages

针对使用此策略引擎的engine和engine所有的task，可以通过这两个命令分别查看task相关的页面访问情况和虚拟机的host上系统大页的使用情况。

示例命令如下：

etmem engine showtaskpages <-t task_name> -n proj_name -e cslide -s etmemd_socket

etmem engine showhostpages -n proj_name -e cslide -s etmemd_socket

注意 ：showtaskpages和showhostpages仅支持引擎使用cslide的场景

命令行参数说明

etmem支持利用PSI策略使能cgroup 粒度内存扩展

PSI 特性能够识别和量化资源竞争导致的业务中断，及其对复杂负载乃至整个系统在时间上的影响。 etmem 通过获取 psi 压力信息，动态调节每轮的换出内存量，从而降低内存换出后对整体业务性能的影响。 PSI的相关资料介绍

场景描述

使用etmem组件包，在cgroup v1场景下，不断检测 cgroup 中PSI 控制参数，查看PSI压力情况是否满足要求，动态调整cgroup 粒度的内存占用量，达到cgroup 粒度内存扩展的目的。

注意事项

1. etmem 在使用PSI策略时，依赖内核kernel开启了PSI 配置，即内核cmdline 中需要添加启动参数：

psi=1

2. etmem 利用swap内存到其他介质的方式来实现内存扩展，因此，在启动etmem前需要先挂载swap分区，可以直接挂载磁盘作为swap分区，或利用ZRAM方式进行挂载。

• 磁盘作为swap分区

fdisk /dev/nvme1n1 创建swap分区
mkswap /dev/nvme1n1p1
swapon /dev/nvme1n1p1
swapon -s          查看swap分区

• ZRAM作为swap分区

modprobe zram
echo 90G > /sys/block/zram0/disksize
mkswap /dev/zram0
swapon /dev/zram0
swapon -s          查看swap分区

使用方法

1、启动etmemd 进程

etmemd -l 0 -s etmemd_socket &
# 命令行参数信息见 启动etmemd 进程章节

2、编写PSI策略配置文件 示例配置文件如下：

[project]
name=test
scan_type=psi
interval=6

[engine]
name=psi
project=test

[task]
project=test
engine=psi
name=psi_task
cg_path=isulad
pressure=0.1
reclaim_rate=0.01
limit_min_bytes=209715200

配置参数含义与解释如下：

3、加载配置工程与任务

编写完成配置文件后，通过etmem客户端命令加载工程到etmemd服务端。

etmem obj add -f /etc/etmem/psi_conf.yaml  -s etmemd_socket

若需要更新psi_conf.yaml配置信息，可重新添加工程：

etmem obj del -f /etc/etmem/psi_conf.yaml  -s etmemd_socket
etmem obj add -f /etc/etmem/psi_conf.yaml  -s etmemd_socket

若需要添加多个task对应的多个cg_path信息，可单独配置[task]单元字段，并进行添加：

etmem obj del -f /etc/etmem/psi_task.yaml  -s etmemd_socket

注：

• 因etmem要操作多个多个cgroup进程的控制字段，基于安全要求，etmem以root权限运行，其配置文件要求权限为600/400.
• 不支持同一个配置文件中添加多个相同的字段[task/engine/project]名称，后面的会覆盖掉前面的，若需要添加多个task，需要多个配置文件

4、启动工程 在已经通过etmem obj add添加工程之后，在还未调用etmem obj del删除工程之前，可以对etmem的工程进行启动和停止。

etmem project start -n test -s etmemd_socket

工程启动后，etmem相关调试日志会存储到/var/log/message中，每一轮的回收信息会以 DEBUG等级打印到/var/log/message中，可以通过调整日志等级后查看。

5、停止工程 运行结束后，可通过etmem project 命令停止工程。

etmem project stop -n test -s etmemd_socket

查询工程

etmem project show -n test -s etmemd_socket

删除工程

etmem obj del -f /etc/etmem/psi_task.yaml  -s etmemd_socket

etmem支持利用硬件访存事件进行内存数据分级

编译

在原流程基础上,使用下面指令替换cmake .. $ cmake -DENABLE_PMU=ON ..

项目依赖

本项目依赖 libpfm4, 可以指令安装libpfm-devel; 在执行安装指令之后, libpfm4 的头文件通常默认安装到路径 /usr/include/perfmon . 要在cmake项目中正确包含头文件，需要设置环境变量 CMAKE_INCLUDE_PATH . export CMAKE_INCLUDE_PATH=$CMAKE_INCLUDE_PATH:/usr/include/perfmon

使用方法

参考etmem/conf/pmu_conf.yaml, 并在[task]添加下面三个配置参数

[task]
sample_period=5000  
vma_updata_rate=5
cpu_set_size=16

配置参数含义与解释如下： 配置文件各字段说明：

参与贡献

1. Fork本仓库
2. 新建个人分支
3. 提交代码
4. 新建Pull Request