更新日期: 2022/06/01 来源: https://gitee.com/weharmony/kernel_liteos_a_note
vm_shellcmd.c
浏览该文件的文档.
1/*
2 * Copyright (c) 2013-2019 Huawei Technologies Co., Ltd. All rights reserved.
3 * Copyright (c) 2020-2021 Huawei Device Co., Ltd. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without modification,
6 * are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this list of
9 * conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
12 * of conditions and the following disclaimer in the documentation and/or other materials
13 * provided with the distribution.
14 *
15 * 3. Neither the name of the copyright holder nor the names of its contributors may be used
16 * to endorse or promote products derived from this software without specific prior written
17 * permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
21 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
23 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
26 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
27 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
28 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
29 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32#include "stdlib.h"
33#include "stdio.h"
34#include "ctype.h"
35#include "los_printf.h"
36#include "string.h"
37#include "securec.h"
38#ifdef LOSCFG_SHELL
39#include "shcmd.h"
40#include "shell.h"
41#endif
42#include "los_oom.h"
43#include "los_vm_dump.h"
44#include "los_process_pri.h"
45#ifdef LOSCFG_FS_VFS
46#include "path_cache.h"
47#endif
48
49#ifdef LOSCFG_KERNEL_VM
50
51#define ARGC_2 2
52#define ARGC_1 1
53#define ARGC_0 0
54#define VMM_CMD "vmm"
55#define OOM_CMD "oom"
56#define VMM_PMM_CMD "v2p"
57//dump内核空间
58LITE_OS_SEC_TEXT_MINOR VOID OsDumpKernelAspace(VOID)
59{
60 LosVmSpace *kAspace = LOS_GetKVmSpace();
61 if (kAspace != NULL) {
62 OsDumpAspace(kAspace);
63 } else {
64 VM_ERR("kernel aspace is NULL");
65 }
66 return;
67}
68
69LITE_OS_SEC_TEXT_MINOR INT32 OsPid(const CHAR *str)
70{
71 UINT32 len = strlen(str);
72 if (len <= 2) { // pid range is 0~63, max pid string length is 2
73 for (UINT32 i = 0; i < len; i++) {
74 if (isdigit(str[i]) == 0) {
75 return -1;
76 }
77 }
78 return atoi(str);
79 }
80 return -1;
81}
82
83LITE_OS_SEC_TEXT_MINOR VOID OsPrintUsage(VOID)
84{
85 PRINTK("-a, print all vm address space information\n"
86 "-k, print the kernel vm address space information\n"
87 "pid(0~63), print process[pid] vm address space information\n"
88 "-h | --help, print vmm command usage\n");
89}
90
91LITE_OS_SEC_TEXT_MINOR VOID OsDoDumpVm(pid_t pid)
92{
93 LosProcessCB *processCB = NULL;
94
96 PRINTK("\tThe process [%d] not valid\n", pid);
97 return;
98 }
99
100 processCB = OS_PCB_FROM_PID(pid);
101 if (!OsProcessIsUnused(processCB) && (processCB->vmSpace != NULL)) {
102 OsDumpAspace(processCB->vmSpace);
103 } else {
104 PRINTK("\tThe process [%d] not active\n", pid);
105 }
106}
107///查看进程的虚拟内存使用情况。vmm [-a / -h / --help], vmm [pid]
108LITE_OS_SEC_TEXT_MINOR UINT32 OsShellCmdDumpVm(INT32 argc, const CHAR *argv[])
109{
110 if (argc == 0) { //没有参数 使用 # vmm 查看所有进程使用虚拟内存的情况
112 } else if (argc == 1) {
113 pid_t pid = OsPid(argv[0]);
114 if (strcmp(argv[0], "-a") == 0) { //# vmm -a 查看所有进程使用虚拟内存的情况
116 } else if (strcmp(argv[0], "-k") == 0) {//# vmm -k 查看内核进程使用虚拟内存的情况
118 } else if (pid >= 0) { //# vmm 3 查看3号进程使用虚拟内存的情况
119 OsDoDumpVm(pid);
120 } else if (strcmp(argv[0], "-h") == 0 || strcmp(argv[0], "--help") == 0) { //# vmm -h 或者 vmm --help
121 OsPrintUsage();
122 } else {
123 PRINTK("%s: invalid option: %s\n", VMM_CMD, argv[0]); //格式错误,输出规范格式
124 OsPrintUsage();
125 }
126 } else { //多于一个参数 例如 # vmm 3 9
127 OsPrintUsage();
128 }
129
130 return OS_ERROR;
131}
132
133LITE_OS_SEC_TEXT_MINOR VOID V2PPrintUsage(VOID)
134{
135 PRINTK("pid vaddr(0x1000000~0x3e000000), print physical address of virtual address\n"
136 "-h | --help, print v2p command usage\n");
137}
138///v2p 虚拟内存对应的物理内存
139LITE_OS_SEC_TEXT_MINOR UINT32 OsShellCmdV2P(INT32 argc, const CHAR *argv[])
140{
141 UINT32 vaddr;
142 PADDR_T paddr;
143 CHAR *endPtr = NULL;
144
145 if (argc == 0) {
147 } else if (argc == 1) {
148 if (strcmp(argv[0], "-h") == 0 || strcmp(argv[0], "--help") == 0) {
150 }
151 } else if (argc == 2) {
152 pid_t pid = OsPid(argv[0]);
153 vaddr = strtoul((CHAR *)argv[1], &endPtr, 0);
154 if ((endPtr == NULL) || (*endPtr != 0) || !LOS_IsUserAddress(vaddr)) {
155 PRINTK("vaddr %s invalid. should be in range(0x1000000~0x3e000000) \n", argv[1]);
156 return OS_ERROR;
157 } else {
158 if (pid >= 0) {
159 if (pid < g_taskMaxNum) {
160 LosProcessCB *processCB = OS_PCB_FROM_PID(pid);
161 if (!OsProcessIsUnused(processCB)) {
162 paddr = 0;
163 LOS_ArchMmuQuery(&processCB->vmSpace->archMmu, (VADDR_T)vaddr, &paddr, 0);
164 if (paddr == 0) {
165 PRINTK("vaddr %#x is not in range or mapped\n", vaddr);
166 } else {
167 PRINTK("vaddr %#x is paddr %#x\n", vaddr, paddr);
168 }
169 } else {
170 PRINTK("\tThe process [%d] not active\n", pid);
171 }
172 } else {
173 PRINTK("\tThe process [%d] not valid\n", pid);
174 }
175 } else {
176 PRINTK("%s: invalid option: %s %s\n", VMM_PMM_CMD, argv[0], argv[1]);
177 }
178 }
179 }
180
181 return LOS_OK;
182}
183///查看系统内存物理页及pagecache物理页使用情况 , Debug版本才具备的命令 # pmm
184LITE_OS_SEC_TEXT_MINOR UINT32 OsShellCmdDumpPmm(VOID)
185{
186 OsVmPhysDump();
187
190 return OS_ERROR;
191}
192
193LITE_OS_SEC_TEXT_MINOR VOID OomPrintUsage(VOID)
194{
195 PRINTK("\t-i [interval], set oom check interval (ms)\n" //设置oom线程任务检查的时间间隔。
196 "\t-m [mem byte], set oom low memory threshold (Byte)\n" //设置低内存阈值。
197 "\t-r [mem byte], set page cache reclaim memory threshold (Byte)\n" //设置pagecache内存回收阈值。
198 "\t-h | --help, print vmm command usage\n"); //使用帮助。
199}
200///查看和设置低内存阈值以及pagecache内存回收阈值。参数缺省时,显示oom功能当前配置信息。
201//当系统内存不足时,会打印出内存不足的提示信息。
202LITE_OS_SEC_TEXT_MINOR UINT32 OsShellCmdOom(INT32 argc, const CHAR *argv[])
203{
204 UINT32 lowMemThreshold;
205 UINT32 reclaimMemThreshold;
206 UINT32 checkInterval;
207 CHAR *endPtr = NULL;
208
209 if (argc == ARGC_0) {
210 OomInfodump();
211 } else if (argc == ARGC_1) {
212 if (strcmp(argv[0], "-h") != 0 && strcmp(argv[0], "--help") != 0) {
213 PRINTK("%s: invalid option: %s\n", OOM_CMD, argv[0]);
214 }
216 } else if (argc == ARGC_2) {
217 if (strcmp(argv[0], "-m") == 0) {
218 lowMemThreshold = strtoul((CHAR *)argv[1], &endPtr, 0);
219 if ((endPtr == NULL) || (*endPtr != 0)) {
220 PRINTK("[oom] low mem threshold %s(byte) invalid.\n", argv[1]);
221 return OS_ERROR;
222 } else {
223 OomSetLowMemThreashold(lowMemThreshold);//设置低内存阈值
224 }
225 } else if (strcmp(argv[0], "-i") == 0) {
226 checkInterval = strtoul((CHAR *)argv[1], &endPtr, 0);
227 if ((endPtr == NULL) || (*endPtr != 0)) {
228 PRINTK("[oom] check interval %s(us) invalid.\n", argv[1]);
229 return OS_ERROR;
230 } else {
231 OomSetCheckInterval(checkInterval);//设置oom线程任务检查的时间间隔
232 }
233 } else if (strcmp(argv[0], "-r") == 0) {
234 reclaimMemThreshold = strtoul((CHAR *)argv[1], &endPtr, 0);
235 if ((endPtr == NULL) || (*endPtr != 0)) {
236 PRINTK("[oom] reclaim mem threshold %s(byte) invalid.\n", argv[1]);
237 return OS_ERROR;
238 } else {
239 OomSetReclaimMemThreashold(reclaimMemThreshold);//设置pagecache内存回收阈值
240 }
241 } else {
242 PRINTK("%s: invalid option: %s %s\n", OOM_CMD, argv[0], argv[1]);
244 }
245 } else {
246 PRINTK("%s: invalid option\n", OOM_CMD);
248 }
249
250 return OS_ERROR;
251}
252
253#ifdef LOSCFG_SHELL_CMD_DEBUG
254SHELLCMD_ENTRY(oom_shellcmd, CMD_TYPE_SHOW, OOM_CMD, 2, (CmdCallBackFunc)OsShellCmdOom);//采用shell命令静态注册方式
255SHELLCMD_ENTRY(vm_shellcmd, CMD_TYPE_SHOW, VMM_CMD, 1, (CmdCallBackFunc)OsShellCmdDumpVm);//采用shell命令静态注册方式 vmm
256SHELLCMD_ENTRY(v2p_shellcmd, CMD_TYPE_SHOW, VMM_PMM_CMD, 1, (CmdCallBackFunc)OsShellCmdV2P);//采用shell命令静态注册方式 v2p
257#endif
258
259#ifdef LOSCFG_SHELL
260SHELLCMD_ENTRY(pmm_shellcmd, CMD_TYPE_SHOW, "pmm", 0, (CmdCallBackFunc)OsShellCmdDumpPmm);//采用shell命令静态注册方式
261#endif
262#endif
263
@ CMD_TYPE_SHOW
用户怎么输入就怎么显示出现,包括 \0 这些字符也都会存在
Definition: shell.h:89
LITE_OS_SEC_BSS UINT32 g_taskMaxNum
任务最大数量 默认128个
Definition: los_task.c:150
STATUS_T LOS_ArchMmuQuery(const LosArchMmu *archMmu, VADDR_T vaddr, PADDR_T *paddr, UINT32 *flags)
LOS_ArchMmuQuery 获取进程空间虚拟地址对应的物理地址以及映射属性。 本函数是内核高频函数,通过MMU查询虚拟地址是否映射过,带走映射的物理地址和权限
Definition: los_arch_mmu.c:569
LITE_OS_SEC_TEXT_MINOR VOID OomSetCheckInterval(UINT32 checkInterval)
设置监控间隔
Definition: oom.c:208
LITE_OS_SEC_TEXT_MINOR VOID OomSetReclaimMemThreashold(UINT32 reclaimMemThreshold)
设置回收内存的门槛
Definition: oom.c:190
LITE_OS_SEC_TEXT_MINOR VOID OomSetLowMemThreashold(UINT32 lowMemThreshold)
设置低内存门槛
Definition: oom.c:176
LITE_OS_SEC_TEXT_MINOR VOID OomInfodump(VOID)
Definition: oom.c:165
STATIC INLINE BOOL OsProcessIsUnused(const LosProcessCB *processCB)
STATIC INLINE BOOL OsProcessIDUserCheckInvalid(UINT32 pid)
unsigned long PADDR_T
Definition: los_typedef.h:207
signed int INT32
Definition: los_typedef.h:60
unsigned long VADDR_T
Definition: los_typedef.h:208
unsigned int UINT32
Definition: los_typedef.h:57
char CHAR
Definition: los_typedef.h:63
VOID OsDumpAspace(LosVmSpace *space)
dump 指定虚拟空间的信息
Definition: los_vm_dump.c:396
VOID OsDumpAllAspace(VOID)
查看所有进程使用虚拟内存的情况
Definition: los_vm_dump.c:430
VOID OsVmPhysDump(VOID)
dump 物理内存
Definition: los_vm_dump.c:516
STATIC INLINE BOOL LOS_IsUserAddress(VADDR_T vaddr)
虚拟地址是否在用户空间
Definition: los_vm_map.h:275
LosVmSpace * LOS_GetKVmSpace(VOID)
内核空间只有g_kVmSpace一个,所有的内核进程都共用一个内核空间
Definition: los_vm_map.c:130
void PathCacheMemoryDump(void)
Definition: path_cache.c:81
LosVmSpace * vmSpace
虚拟空间,每个进程都有一个属于自己的虚拟内存地址空间
Definition: los_vm_map.h:146
LosArchMmu archMmu
Definition: los_vm_map.h:157
u32_t(* CmdCallBackFunc)(u32_t argc, const char **argv)
Definition: types_adapt.h:86
void VnodeMemoryDump(void)
Definition: vnode.c:706
LITE_OS_SEC_TEXT_MINOR UINT32 OsShellCmdDumpPmm(VOID)
查看系统内存物理页及pagecache物理页使用情况 , Debug版本才具备的命令 # pmm
Definition: vm_shellcmd.c:184
LITE_OS_SEC_TEXT_MINOR VOID OsPrintUsage(VOID)
Definition: vm_shellcmd.c:83
LITE_OS_SEC_TEXT_MINOR INT32 OsPid(const CHAR *str)
Definition: vm_shellcmd.c:69
LITE_OS_SEC_TEXT_MINOR UINT32 OsShellCmdDumpVm(INT32 argc, const CHAR *argv[])
查看进程的虚拟内存使用情况。vmm [-a / -h / –help], vmm [pid]
Definition: vm_shellcmd.c:108
SHELLCMD_ENTRY(oom_shellcmd, CMD_TYPE_SHOW, OOM_CMD, 2,(CmdCallBackFunc) OsShellCmdOom)
LITE_OS_SEC_TEXT_MINOR VOID OsDumpKernelAspace(VOID)
Definition: vm_shellcmd.c:58
LITE_OS_SEC_TEXT_MINOR UINT32 OsShellCmdV2P(INT32 argc, const CHAR *argv[])
v2p 虚拟内存对应的物理内存
Definition: vm_shellcmd.c:139
LITE_OS_SEC_TEXT_MINOR VOID OsDoDumpVm(pid_t pid)
Definition: vm_shellcmd.c:91
LITE_OS_SEC_TEXT_MINOR UINT32 OsShellCmdOom(INT32 argc, const CHAR *argv[])
查看和设置低内存阈值以及pagecache内存回收阈值。参数缺省时,显示oom功能当前配置信息。
Definition: vm_shellcmd.c:202
LITE_OS_SEC_TEXT_MINOR VOID V2PPrintUsage(VOID)
Definition: vm_shellcmd.c:133
LITE_OS_SEC_TEXT_MINOR VOID OomPrintUsage(VOID)
Definition: vm_shellcmd.c:193