packages/etmem
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

!65 update README file

Browse Source 
From: @liubo254 
Reviewed-by: @louhongxiang 
Signed-off-by: @liuzhiqiang26
This commit is contained in:
openeuler-ci-bot 2023-03-22 01:25:54 +00:00 committed by Gitee
commit 084676aa6b
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
2 changed files with 428 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

537
README.md
View File

@ -6,19 +6,22 @@
etmem内存分级扩展技术，通过DRAM+内存压缩/高性能存储新介质形成多级内存存储，对内存数据进行分级，将分级后的内存冷数据从内存介质迁移到高性能存储介质中，达到内存容量扩展的目的，从而实现内存成本下降。 etmem内存分级扩展技术，通过DRAM+内存压缩/高性能存储新介质形成多级内存存储，对内存数据进行分级，将分级后的内存冷数据从内存介质迁移到高性能存储介质中，达到内存容量扩展的目的，从而实现内存成本下降。
## 安装教程 ## 编译教程
1. 下载etmem源码 1. 下载etmem源码
$ git clone https://gitee.com/src-openeuler/etmem.git $ git clone https://gitee.com/src-openeuler/etmem.git
2. 编译安装 2. 编译和运行依赖
etmem的编译和运行依赖于libboundscheck组件
3. 编译
a) 下载代码包手动编译 a) 下载代码包手动编译
$ tar -xf 1.0.tar.gz $ tar -xf 1.1.tar.gz
$ cd etmem-1.0 $ cd etmem-1.1
手动打入patch 手动打入patch
@ -32,6 +35,28 @@ etmem内存分级扩展技术，通过DRAM+内存压缩/高性能存储新介质
b) 下载etmem相关rpm包进行安装 b) 下载etmem相关rpm包进行安装
## 注意事项
### 运行依赖
etmem作为内存扩展工具，需要依赖于内核态的特性支持，为了可以识别内存访问情况和支持主动将内存写入swap分区来达到内存垂直扩展的需求，etmem在运行时需要插入etmem_scan和etmem_swap模块：
```
modprobe etmem_scan
modprobe etmem_swap
```
### 权限限制
运行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文件
## 使用说明 ## 使用说明
@ -47,173 +72,459 @@ $ etmemd -l 0 -s etmemd_socket
options： options：
-l|--log-level <log-level> Log level -l|\-\-log-level <log-level> Log level
-s|--socket <sockect name> Socket name to listen to
-h|--help Show this message -s|\-\-socket <sockect name> Socket name to listen to
-h|\-\-help Show this message
-m|\-\-mode-systemctl mode used to start(systemctl)
#### 命令行参数说明 #### 命令行参数说明
| 参数 | 参数含义 | 是否必须 | 是否有参数 | 参数范围 | 示例说明 | | 参数 | 参数含义 | 是否必须 | 是否有参数 | 参数范围 | 示例说明 |
| --------------- | ---------------------------------- | -------- | ---------- | --------------------- | ------------------------------------------------------------ | | --------------- | ---------------------------------- | -------- | ---------- | --------------------- | ------------------------------------------------------------ |
| -l或--log-level | etmemd日志级别 | 否 | 是 | 0~3 | 0：debug级别 1：info级别 2：warning级别 3：error级别 只有大于等于配置的级别才会打印到/var/log/message文件中 | | -l或\-\-log-level | etmemd日志级别 | 否 | 是 | 0~3 | 0：debug级别 1：info级别 2：warning级别 3：error级别 只有大于等于配置的级别才会打印到/var/log/message文件中 |
| -s或--socket | etmemd监听的名称，用于与客户端交互 | 是 | 是 | 107个字符之内的字符串 | 指定服务端监听的名称 | | -s或\-\-socket | etmemd监听的名称，用于与客户端交互 | 是 | 是 | 107个字符之内的字符串 | 指定服务端监听的名称 |
| -h或--help | 帮助信息 | 否 | 否 | NA | 执行时带有此参数会打印后退出 | | -h或\-\-help | 帮助信息 | 否 | 否 | NA | 执行时带有此参数会打印后退出 |
| -m或\-\-mode-systemctl| etmemd作为service被拉起时，命令中可以使用此参数来支持fork模式启动| 否| 否| NA| NA|
### etmem配置文件 ### etmem配置文件
在运行etmem进程之前，需要管理员预先规划哪些进程需要做内存扩展，将进程信息配置到etmem配置文件中，并配置内存扫描的周期、扫描次数、内存冷热阈值等信息。 在运行etmem进程之前，需要管理员预先规划哪些进程需要做内存扩展，将进程信息配置到etmem配置文件中，并配置内存扫描的周期、扫描次数、内存冷热阈值等信息。
配置文件的示例文件在安装etmem软件包后，放置在/etc/etmem/example_conf.yaml，示例内容为： 配置文件的示例文件在源码包中，放置在/etc/etmem文件路径下，按照功能划分为3个示例文件，
``` ```
options: /etc/etmem/cslide_conf.yaml
loop : 3 /etc/etmem/slide_conf.yaml
interval : 1 /etc/etmem/thirdparty_conf.yaml
sleep: 2 ```
policies: 示例内容分别为：
type : pid/name
value : 123456/mysql ```
max_threads: 3 [project]
engine : slide name=test
param: loop=1
T: 3 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
``` ```
配置文件各字段说明： 配置文件各字段说明：
| **置项** | **配置项含义** | **是否必须** | **是否有参数** | **参数范围** | **示例说明** | | 配置项 | 配置项含义 | 是否必须 | 是否有参数 | 参数范围 | 示例说明 |
| ----------- | ------------------------------------------------------------ | ------------ | -------------- | ------------------------- | ------------------------------------------------------------ | |-----------|---------------------|------|-------|------------|-----------------------------------------------------------------|
| options | project公用配置段起始标识 | 是 | 否 | NA | 每个配置文件有且仅有一个此字段，并且文件以此字段开始 | | [project] | project公用配置段起始标识 | 否 | 否 | NA | project参数的开头标识，表示下面的参数直到另外的[xxx]或文件结尾为止的范围内均为project section的参数 |
| loop | 内存扫描的循环次数 | 是 | 是 | 1~120 | loop:3 //扫描3次 | | name | project的名字 | 是 | 是 | 64个字以内的字符串 | 用来标识project，engine和task在配置时需要指定要挂载到的project |
| interval | 每次内存扫描的时间间隔 | 是 | 是 | 1~1200 | interval:5 //每次扫描之间间隔5s | | loop | 内存扫描的循环次数 | 是 | 是 | 1~10 | loop=3 //扫描3次 |
| sleep | 每个内存扫描+操作的大周期之间时间间隔 | 是 | 是 | 1~1200 | sleep:10 //每次大周期之间间隔10s | | interval | 每次内存扫描的时间间隔 | 是 | 是 | 1~1200 | interval=5 //每次扫描之间间隔5s |
| policies | project中各task任务配置段起始标识 | 是 | 否 | NA | 一个project中可以配置多个task，每个task以policies:开头 | | sleep | 每个内存扫描+操作的大周期之间时间间隔 | 是 | 是 | 1~1200 | sleep=10 //每次大周期之间间隔10s |
| type | 目标进程识别的方式 | 是 | 是 | pid/name | pid代表通过进程号识别，name代表通过进程名称识别 | | sysmem_threshold| slide engine的配置项，系统内存换出阈值 | 否 | 是 | 0~100 | sysmem_threshold=50 //系统内存剩余量小于50%时，etmem才会触发内存换出|
| value | 目标进程识别的具体字段 | 是 | 是 | 实际的进程号/进程名称 | 与type字段配合使用，指定目标进程的进程号或进程名称，由使用者保证配置的正确及唯一性 | | swapcache_high_wmark| slide engine的配置项，swacache可以占用系统内存的比例，高水线 | 否 | 是 | 1~100 | swapcache_high_wmark=5 //swapcache内存占用量可以为系统内存的5%，超过该比例，etmem会触发swapcache回收<br> 注： swapcache_high_wmark需要大于swapcache_low_wmark|
| max_threads | etmemd内部线程池最大线程数，每个线程处理一个进程/子进程的内存扫描+操作任务 | 否 | 是 | 1~2 * core数 + 1，默认为1 | 对外部无表象，控制etmemd服务端内部处理线程个数，当目标进程有多个子进程时，配置越大，并发执行的个数也多，但占用资源也越多 | | swapcache_low_wmark| slide engine的配置项，swacache可以占用系统内存的比例，低水线 | 否 | 是 | [1~swapcache_high_wmark) | swapcache_low_wmark=3 //触发swapcache回收后，系统会将swapcache内存占用量回收到低于3%|
| engine | 扫描引擎类型 | 是 | 是 | slide | 声明使用slide引擎进行冷热内存识别 | | [engine] | engine公用配置段起始标识 | 否 | 否 | NA | engine参数的开头标识，表示下面的参数直到另外的[xxx]或文件结尾为止的范围内均为engine section的参数 |
| param | 扫描引擎私有参数配置起始标识 | 是 | 否 | NA | 引擎私有参数配置段以此标识起始，每个task对应一种引擎，每个引擎对应一个param及其字段 | | project | 声明所在的project | 是 | 是 | 64个字以内的字符串 | 已经存在名字为test的project，则可以写为project=test |
| T | slide引擎的水线配置 | 是 | 否 | 1~3 * loop | 水线阈值，大于等于此值的内存会被识别为热内存，反之为冷内存 | | engine | 声明所在的engine | 是 | 是 | slide/cslide/thridparty | 声明使用的是slide或cslide或thirdparty策略 |
| node_pair | cslide engine的配置项，声明系统中AEP和DRAM的node pair | engine为cslide时必须配置 | 是 | 成对配置AEP和DRAM的node号，AEP和DRAM之间用逗号隔开，没对pair之间用分号隔开 | node_pair=2,0;3,1 |
| hot_threshold | cslide engine的配置项，声明内存冷热水线的阈值 | engine为cslide时必须配置 | 是 | >= 0的整数 | hot_threshold=3 //访问次数小于3的内存会被识别为冷内存 |
|node_mig_quota|cslide engine的配置项，流控，声明每次DRAM和AEP互相迁移时单向最大流量|engine为cslide时必须配置|是|>= 0的整数|node_mig_quota=1024 //单位为MB，AEP到DRAM或DRAM到AEP搬迁一次最大1024M|
|node_hot_reserve|cslide engine的配置项，声明DRAM中热内存的预留空间大小|engine为cslide时必须配置|是|>= 0的整数|node_hot_reserve=1024 //单位为MB，当所有虚拟机热内存大于此配置值时，热内存也会迁移到AEP中|
|eng_name|thirdparty engine的配置项，声明engine自己的名字，供task挂载|engine为thirdparty时必须配置|是|64个字以内的字符串|eng_name=my_engine //对此第三方策略engine挂载task时，task中写明engine=my_engine|
|libname|thirdparty engine的配置项，声明第三方策略的动态库的地址，绝对地址|engine为thirdparty时必须配置|是|64个字以内的字符串|libname=/user/lib/etmem_fetch/code_test/my_engine.so|
|ops_name|thirdparty engine的配置项，声明第三方策略的动态库中操作符号的名字|engine为thirdparty时必须配置|是|64个字以内的字符串|ops_name=my_engine_ops //第三方策略实现接口的结构体的名字|
|engine_private_key|thirdparty engine的配置项，预留给第三方策略自己解析私有参数的配置项，选配|否|否|根据第三方策略私有参数自行限制|根据第三方策略私有engine参数自行配置|
| [task] | task公用配置段起始标识 | 否 | 否 | NA | task参数的开头标识，表示下面的参数直到另外的[xxx]或文件结尾为止的范围内均为task section的参数 |
| project | 声明所挂的project | 是 | 是 | 64个字以内的字符串 | 已经存在名字为test的project，则可以写为project=test |
| engine | 声明所挂的engine | 是 | 是 | 64个字以内的字符串 | 所要挂载的engine的名字 |
| name | task的名字 | 是 | 是 | 64个字以内的字符串 | name=background1 //声明task的名字是backgound1 |
| type | 目标进程识别的方式 | 是 | 是 | pid/name | pid代表通过进程号识别，name代表通过进程名称识别 |
| value | 目标进程识别的具体字段 | 是 | 是 | 实际的进程号/进程名称 | 与type字段配合使用，指定目标进程的进程号或进程名称，由使用者保证配置的正确及唯一性 |
| T | engine为slide的task配置项，声明内存冷热水线的阈值 | engine为slide时必须配置 | 是 | 0~loop * 3 | T=3 //访问次数小于3的内存会被识别为冷内存 |
| max_threads | engine为slide的task配置项，etmemd内部线程池最大线程数，每个线程处理一个进程/子进程的内存扫描+操作任务 | 否 | 是 | 1~2 * core数 + 1，默认为1 | 对外部无表象，控制etmemd服务端内部处理线程个数，当目标进程有多个子进程时，配置越大，并发执行的个数也多，但占用资源也越多 |
| vm_flags | engine为cslide的task配置项，通过指定flag扫描的vma，不配置此项时扫描则不会区分 | engine为cslide时必须配置 | 是 | 当前只支持ht | vm_flags=ht //扫描flags为ht（大页）的vma内存 |
| anon_only | engine为cslide的task配置项，标识是否只扫描匿名页 | 否 | 是 | yes/no | anon_only=no //配置为yes时只扫描匿名页，配置为no时非匿名页也会扫描 |
| ign_host | engine为cslide的task配置项，标识是否忽略host上的页表扫描信息 | 否 | 是 | yes/no | ign_host=no //yes为忽略，no为不忽略 |
| task_private_key | engine为thirdparty的task配置项，预留给第三方策略的task解析私有参数的配置项，选配 | 否 | 否 | 根据第三方策略私有参数自行限制 | 根据第三方策略私有task参数自行配置 |
| swap_threshold |slide engine的配置项，进程内存换出阈值 | 否 | 是 | 进程可用内存绝对值 | swap_threshold=10g //进程占用内存在低于10g时不会触发换出。<br>当前版本下，仅支持g/G作为内存绝对值单位。与sysmem_threshold配合使用，仅系统内存低于阈值时，进行白名单中进程阈值判断 |
| swap_flag|slide engine的配置项，进程指定内存换出 | 否 | 是 | yes/no | swap_flag=yes//使能进程指定内存换出 |
### etmem工程创建/删除/查询
### etmem project/engine/task对象的创建和删除
#### 场景描述 #### 场景描述
1）管理员创建etmem工程（一个工程可包含多个etmem任务） 1）管理员创建etmem的project/engine/task（一个工程可包含多个etmem engine，一个engine可以包含多个任务）
2）管理员查询已有的etmem工程 2）管理员删除已有的etmem project/engine/task（删除工程前，会自动先停止该工程中的所有任务）
3）管理员删除已有的etmem工程（删除工程前，会自动先停止该工程中的所有任务）
#### 使用方法 #### 使用方法
通过etmem二进制执行工程创建/删除/查询操作，前提是服务端已经成功运行，并且配置文件/etc/etmem/example_conf.yaml内容正确。 运行etmem二进制，通过第二个参数指定为obj，来进行创建或删除动作，对project/engine/task则是通过配置文件中配置的内容来进行识别和区分。前提是etmem配置文件已配置正确，etmemd进程已启动。
添加工程： 添加对象：
etmem project add -n test -f /etc/etmem/example_conf.yaml -s etmemd_socket etmem obj add -f /etc/etmem/slide_conf.yaml -s etmemd_socket
删除工程： 删除对象：
etmem project del -n test -s etmemd_socket etmem obj del -f /etc/etmem/slide_conf.yaml -s etmemd_socket
查询工程：
etmem project show -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.
#### 命令行参数说明
| 参数 | 参数含义 | 是否必须 | 是否有参数 | 示例说明 |
| ------------ | ------------------------------------------------------------ | -------- | ---------- | -------------------------------------------------------- |
| -f或\-\-file | 指定对象的配置文件 | add，del子命令必须包含 | 是 | 需要指定路径名称 |
| -s或\-\-socket | 与etmemd服务端通信的socket名称，需要与etmemd启动时指定的保持一致 | add，del子命令必须包含 | 是 | 必须配置，在有多个etmemd时，由管理员选择与哪个etmemd通信 |
### 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 etmem project help
#### 帮助信息 #### 帮助信息
Usage: Usage:
etmem project add [options]
etmem project del [options]
etmem project show
etmem project help
Options: etmem project start [options]
-f|--file <conf_file> Add configuration file
-n|--name <proj_name> Add project name
-s|--sock <sock_name> Socket name to connect
Notes: etmem project stop [options]
\1. Project name and socket name must be given when execute add or del option.
\2. Configuration file must be given when execute add option. etmem project show [options]
\3. Socket name must be given when execute show option.
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.
#### 命令行参数说明 #### 命令行参数说明
add命令：
| 参数 | 参数含义 | 是否必须 | 是否有参数 | 示例说明 | | 参数 | 参数含义 | 是否必须 | 是否有参数 | 示例说明 |
| ------------ | ------------------------------------------------------------ | -------- | ---------- | -------------------------------------------------------- | | ------------ | ------------------------------------------------------------ | -------- | ---------- | -------------------------------------------------------- |
| -n或--name | 指定project名称 | 是 | 是 | project名称，与配置文件一一对应 | | -n或\-\-name | 指定project名称 | start，stop，show子命令必须包含 | 是 | project名称，与配置文件一一对应 |
| -f或--file | 指定project的配置文件 | 是 | 是 | 需要指定路径名称 | | -s或\-\-socket | 与etmemd服务端通信的socket名称，需要与etmemd启动时指定的保持一致 | start，stop，show子命令必须包含 | 是 | 必须配置，在有多个etmemd时，由管理员选择与哪个etmemd通信 |
| -s或--socket | 与etmemd服务端通信的socket名称，需要与etmemd启动时指定的保持一致 | 是 | 是 | 必须配置，在有多个etmemd时，由管理员选择与哪个etmemd通信 |
del命令： ### etmem支持随系统自启动
| 参数 | 参数含义 | 是否必须 | 是否有参数 | 示例说明 |
| ------------ | ------------------------------------------------------------ | -------- | ---------- | -------------------------------------------------------- |
| -n或--name | 指定project名称 | 是 | 是 | project名称，与配置文件一一对应 |
| -s或--socket | 与etmemd服务端通信的socket名称，需要与etmemd启动时指定的保持一致 | 是 | 是 | 必须配置，在有多个etmemd时，由管理员选择与哪个etmemd通信 |
show命令：
| 参数 | 参数含义 | 是否必须 | 是否有参数 | 示例说明 |
| ------------ | ------------------------------------------------------------ | -------- | ---------- | -------------------------------------------------------- |
| -s或--socket | 与etmemd服务端通信的socket名称，需要与etmemd启动时指定的保持一致 | 是 | 是 | 必须配置，在有多个etmemd时，由管理员选择与哪个etmemd通信 |
### etmem任务启动/停止
#### 场景描述 #### 场景描述
在已经通过etmem project add添加工程之后，在还未调用etmem project del删除工程之前，可以对etmem的工程进行启动和停止。 etmemd支持由用户配置systemd配置文件后，以fork模式作为systemd服务被拉起运行
1）管理员启动已添加的工程
2）管理员停止已启动的工程
在管理员调用project del删除工程时，如果工程已经启动，则会自动停止。
#### 使用方法 #### 使用方法
通过etmem二进制执行任务启动/停止操作，前提是服务端已经成功运行，配置文件/etc/etmem/example_conf.yaml内容正确，且etmem工程已经创建。 编写service配置文件，来启动etmemd，必须使用-m参数来指定此模式，例如
启动工程 etmemd -l 0 -s etmemd_socket -m
etmem migrate start -n test -s etmemd_socket
停止工程
etmem migrate stop -n test -s etmemd_socket
打印帮助
etmem migrate help
#### 帮助信息 #### 帮助信息
Usage: options:
etmem migrate start [options]
etmem migrate stop [options]
etmem migrate help
Options: -l|\-\-log-level <log-level> Log level
-n|--name <proj_name> Add project name
-s|--sock <sock_name> Socket name to connect
Notes: -s|\-\-socket <sockect name> Socket name to listen to
Project name and socket name must be given when execute start or stop option.
-m|\-\-mode-systemctl mode used to start(systemctl)
-h|\-\-help Show this message
#### 命令行参数说明 #### 命令行参数说明
| 参数 | 参数含义 | 是否必须 | 是否有参数 | 参数范围 | 实例说明 |
|----------------|------------|------|-------|------|-----------|
| -l或\-\-log-level | etmemd日志级别 | 否 | 是 | 0~3 | 0：debug级别；1：info级别；2：warning级别；3：error级别；只有大于等于配置的级别才会打印到/var/log/message文件中|
| -s或\-\-socket |etmemd监听的名称，用于与客户端交互 | 是 | 是| 107个字符之内的字符串| 指定服务端监听的名称|
|-m或\-\-mode-systemctl | etmemd作为service被拉起时，命令中需要指定此参数来支持 | 否 | 否 | NA | NA |
| -h或\-\-help | 帮助信息 | 否 |否 |NA |执行时带有此参数会打印后退出|
| 参数 | 参数含义 | 是否必须 | 是否有参数 | 示例说明 |
| ------------ | ------------------------------------------------------------ | -------- | ---------- | -------------------------------------------------------- |
| -n或--name | 指定project名称 | 是 | 是 | project名称，与配置文件一一对应 |
| -s或--socket | 与etmemd服务端通信的socket名称，需要与etmemd启动时指定的保持一致 | 是 | 是 | 必须配置，在有多个etmemd时，由管理员选择与哪个etmemd通信 | ### 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的场景
#### 命令行参数说明
| 参数 | 参数含义 | 是否必须 | 是否有参数 | 实例说明 |
|----|------|------|-------|------|
|-n或\-\-proj_name| 指定project的名字| 是| 是| 指定已经存在，所需要执行的project的名字|
|-s或\-\-socket| 与etmemd服务端通信的socket名称，需要与etmemd启动时指定的保持一致| 是| 是| 必须配置，在有多个etmemd时，由管理员选择与哪个etmemd通信|
|-e或\-\-engine| 指定执行的引擎的名字| 是| 是| 指定已经存在的，所需要执行的引擎的名字|
|-t或\-\-task_name| 指定执行的任务的名字| 否| 是| 指定已经存在的，所需要执行的任务的名字|
## 参与贡献 ## 参与贡献

5
etmem.spec
View File

@ -2,7 +2,7 @@
Name: etmem Name: etmem
Version: 1.1 Version: 1.1
Release: 2 Release: 3
Summary: etmem Summary: etmem
License: MulanPSL-2.0 License: MulanPSL-2.0
URL: https://gitee.com/openeuler/etmem URL: https://gitee.com/openeuler/etmem
@ -60,6 +60,9 @@ install -m 0644 userswap/include/uswap_api.h $RPM_BUILD_ROOT%{_includedir}
%postun -p /sbin/ldconfig %postun -p /sbin/ldconfig
%changelog %changelog
* Thu Mar 16 2023 liubo <liubo254@huawei.com> 1.1-3
- update the README file.
* Tue Mar 7 2023 Huang Yang <huangyang@loongson.cn> 1.1-2 * Tue Mar 7 2023 Huang Yang <huangyang@loongson.cn> 1.1-2
- add loongarch64 support - add loongarch64 support