• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 内存调测
2
3
4内存调测方法旨在辅助定位动态内存相关问题，提供了基础的动态内存池信息统计手段，向用户呈现内存池水线、碎片率等信息；提供了内存泄漏检测手段，方便用户准确定位存在内存泄漏的代码行，也可以辅助分析系统各个模块内存的使用情况；提供了踩内存检测手段，可以辅助定位越界踩内存的场景。
5
6
7## 内存信息统计
8
9
10### 基础概念
11
12内存信息包括内存池大小、内存使用量、剩余内存大小、最大空闲内存、内存水线、内存节点数统计、碎片率等。
13
14- 内存水线：即内存池的最大使用量，每次申请和释放时，都会更新水线值，实际业务可根据该值，优化内存池大小；
15
16- 碎片率：衡量内存池的碎片化程度，碎片率高表现为内存池剩余内存很多，但是最大空闲内存块很小，可以用公式（fragment=100-100\*最大空闲内存块大小/剩余内存大小）来度量；
17
18- 其他参数：通过调用接口（详见[内存管理](../kernel/kernel-mini-basic-memory.md)章节接口说明），扫描内存池的节点信息，统计出相关信息。
19
20
21### 功能配置
22
23LOSCFG_MEM_WATERLINE：开关宏，默认打开；若关闭这个功能，在target_config.h中将这个宏定义为0。如需获取内存水线，需要打开该配置。
24
25
26### 开发指导
27
28
29#### 开发流程
30
31关键结构体介绍：
32
33
34```
35typedef struct {
36    UINT32 totalUsedSize;       // 内存池的内存使用量
37    UINT32 totalFreeSize;       // 内存池的剩余内存大小
38    UINT32 maxFreeNodeSize;     // 内存池的最大空闲内存块大小
39    UINT32 usedNodeNum;         // 内存池的非空闲内存块个数
40    UINT32 freeNodeNum;         // 内存池的空闲内存块个数
41#if (LOSCFG_MEM_WATERLINE == 1) // 默认打开，如需关闭，在target_config.h中将该宏设置为0
42    UINT32 usageWaterLine;      // 内存池的水线值
43#endif
44} LOS_MEM_POOL_STATUS;
45```
46
47- 内存水线获取：调用LOS_MemInfoGet接口，第1个参数是内存池首地址，第2个参数是LOS_MEM_POOL_STATUS类型的句柄，其中字段usageWaterLine即水线值。
48
49- 内存碎片率计算：同样调用LOS_MemInfoGet接口，可以获取内存池的剩余内存大小和最大空闲内存块大小，然后根据公式（fragment=100-100\*最大空闲内存块大小/剩余内存大小）得出此时的动态内存池碎片率。
50
51
52#### 编程实例
53
54本实例实现如下功能：
55
561.创建一个监控任务，用于获取内存池的信息；
57
582.调用LOS_MemInfoGet接口，获取内存池的基础信息；
59
603.利用公式算出使用率及碎片率。
61
62
63#### 示例代码
64
65代码实现如下：
66
67本演示代码在 ./kernel/liteos_m/testsuites/src/osTest.c 中编译验证，在TestTaskEntry中调用验证入口函数MemTest。
68
69```
70#include <stdio.h>
71#include <string.h>
72#include "los_task.h"
73#include "los_memory.h"
74#include "los_config.h"
75
76#define TEST_TASK_PRIO  5
77void MemInfoTaskFunc(void)
78{
79    LOS_MEM_POOL_STATUS poolStatus = {0};
80
81    /* pool为要统计信息的内存地址，此处以OS_SYS_MEM_ADDR为例 */
82    void *pool = OS_SYS_MEM_ADDR;
83    LOS_MemInfoGet(pool, &poolStatus);
84    /* 算出内存池当前的碎片率百分比 */
85    float fragment = 100 - poolStatus.maxFreeNodeSize * 100.0 / poolStatus.totalFreeSize;
86    /* 算出内存池当前的使用率百分比 */
87    float usage = LOS_MemTotalUsedGet(pool) * 100.0 / LOS_MemPoolSizeGet(pool);
88    printf("usage = %f, fragment = %f, maxFreeSize = %d, totalFreeSize = %d, waterLine = %d\n", usage, fragment,
89    		poolStatus.maxFreeNodeSize, poolStatus.totalFreeSize, poolStatus.usageWaterLine);
90}
91
92int MemTest(void)
93{
94    unsigned int ret;
95    unsigned int taskID;
96    TSK_INIT_PARAM_S taskStatus = {0};
97    taskStatus.pfnTaskEntry = (TSK_ENTRY_FUNC)MemInfoTaskFunc;
98    taskStatus.uwStackSize  = LOSCFG_BASE_CORE_TSK_DEFAULT_STACK_SIZE;
99    taskStatus.pcName       = "memInfo";
100    taskStatus.usTaskPrio   = TEST_TASK_PRIO;
101    ret = LOS_TaskCreate(&taskID, &taskStatus);
102    if (ret != LOS_OK) {
103        printf("task create failed\n");
104        return -1;
105    }
106    return 0;
107}
108```
109
110
111#### 结果验证
112
113编译运行输出的结果如下：
114
115
116```
117usage = 0.458344, fragment = 0.000000, maxFreeSize = 16474928, totalFreeSize = 16474928, waterLine = 76816
118
119根据实际运行环境，上文中的数据会有差异，非固定结果
120```
121## 内存泄漏检测
122
123
124### 基础概念
125
126内存泄漏检测机制作为内核的可选功能，用于辅助定位动态内存泄漏问题。开启该功能，动态内存机制会自动记录申请内存时的函数调用关系（下文简称LR）。如果出现泄漏，就可以利用这些记录的信息，找到内存申请的地方，方便进一步确认。
127
128
129### 功能配置
130
1311. LOSCFG_MEM_LEAKCHECK：开关宏，默认关闭；若打开这个功能，在target_config.h中将这个宏定义为1。
132
1332. LOSCFG_MEM_RECORD_LR_CNT：记录的LR层数，默认3层；每层LR消耗sizeof(void \*)字节数的内存。
134
1353. LOSCFG_MEM_OMIT_LR_CNT：忽略的LR层数，默认4层，即从调用LOS_MemAlloc的函数开始记录，可根据实际情况调整。为啥需要这个配置？有3点原因如下：
136   - LOS_MemAlloc接口内部也有函数调用；
137   - 外部可能对LOS_MemAlloc接口有封装；
138   - LOSCFG_MEM_RECORD_LR_CNT 配置的LR层数有限；
139
140正确配置这个宏，将无效的LR层数忽略，就可以记录有效的LR层数，节省内存消耗。
141
142
143### 开发指导
144
145
146#### 开发流程
147
148该调测功能可以分析关键的代码逻辑中是否存在内存泄漏。开启这个功能，每次申请内存时，会记录LR信息。在需要检测的代码段前后，调用LOS_MemUsedNodeShow接口，每次都会打印指定内存池已使用的全部节点信息，对比前后两次的节点信息，新增的节点信息就是疑似泄漏的内存节点。通过LR，可以找到具体申请的代码位置，进一步确认是否泄漏。
149
150调用LOS_MemUsedNodeShow接口输出的节点信息格式如下：每1行为一个节点信息；第1列为节点地址，可以根据这个地址，使用GDB等手段查看节点完整信息；第2列为节点的大小，等于节点头大小+数据域大小；第3~5列为函数调用关系LR地址，可以根据这个值，结合汇编文件，查看该节点具体申请的位置。
151
152
153```
154node        size   LR[0]      LR[1]       LR[2]
1550x10017320: 0x528 0x9b004eba  0x9b004f60  0x9b005002
1560x10017848: 0xe0  0x9b02c24e  0x9b02c246  0x9b008ef0
1570x10017928: 0x50  0x9b008ed0  0x9b068902  0x9b0687c4
1580x10017978: 0x24  0x9b008ed0  0x9b068924  0x9b0687c4
1590x1001799c: 0x30  0x9b02c24e  0x9b02c246  0x9b008ef0
1600x100179cc: 0x5c  0x9b02c24e  0x9b02c246  0x9b008ef0
161```
162
163> ![icon-caution.gif](public_sys-resources/icon-caution.gif) **注意：**
164> 开启内存检测会影响内存申请的性能，且每个内存节点都会记录LR地址，内存开销也加大。
165
166
167#### 编程实例
168
169本实例实现如下功能：构建内存泄漏代码段。
170
1711. 调用LOS_MemUsedNodeShow接口，输出全部节点信息打印；
172
1732. 申请内存，但没有释放，模拟内存泄漏；
174
1753. 再次调用LOS_MemUsedNodeShow接口，输出全部节点信息打印；
176
1774. 将两次log进行对比，得出泄漏的节点信息；
178
1795. 通过LR地址，找出泄漏的代码位置；
180
181
182#### 示例代码
183
184代码实现如下：
185
186本演示代码在 ./kernel/liteos_m/testsuites/src/osTest.c 中编译验证，在TestTaskEntry中调用验证入口函数MemLeakTest。
187
188qemu平台运行时需确保target_config.h 中对应的LOSCFG_MEM_FREE_BY_TASKID为0。
189
190由于打开内存检测后，部分平台有其他任务运行，会频繁调用内存相关打印如：psp, start = xxxxx, end = xxxxxxx，请忽略打印或删除OsStackAddrGet函数中调用的打印即可。
191
192
193```
194#include <stdio.h>
195#include <string.h>
196#include "los_memory.h"
197#include "los_config.h"
198
199void MemLeakTest(void)
200{
201    LOS_MemUsedNodeShow(LOSCFG_SYS_HEAP_ADDR);
202    void *ptr1 = LOS_MemAlloc(LOSCFG_SYS_HEAP_ADDR, 8);
203    void *ptr2 = LOS_MemAlloc(LOSCFG_SYS_HEAP_ADDR, 8);
204    LOS_MemUsedNodeShow(LOSCFG_SYS_HEAP_ADDR);
205}
206```
207
208
209#### 结果验证
210
211编译运行输出示例log如下：
212
213
214```
215node         size   LR[0]       LR[1]       LR[2]
2160x20001b04:  0x24   0x08001a10  0x080035ce  0x080028fc
2170x20002058:  0x40   0x08002fe8  0x08003626  0x080028fc
2180x200022ac:  0x40   0x08000e0c  0x08000e56  0x0800359e
2190x20002594:  0x120  0x08000e0c  0x08000e56  0x08000c8a
2200x20002aac:  0x56   0x08000e0c  0x08000e56  0x08004220
221
222node         size   LR[0]       LR[1]       LR[2]
2230x20001b04:  0x24   0x08001a10  0x080035ce  0x080028fc
2240x20002058:  0x40   0x08002fe8  0x08003626  0x080028fc
2250x200022ac:  0x40   0x08000e0c  0x08000e56  0x0800359e
2260x20002594:  0x120  0x08000e0c  0x08000e56  0x08000c8a
2270x20002aac:  0x56   0x08000e0c  0x08000e56  0x08004220
2280x20003ac4:  0x1d   0x08001458  0x080014e0  0x080041e6
2290x20003ae0:  0x1d   0x080041ee  0x08000cc2  0x00000000
230
231根据实际运行环境，上文中的数据会有差异，非固定结果
232```
233
234对比两次log，差异如下，这些内存节点就是疑似泄漏的内存块：
235
236
237```
2380x20003ac4:  0x1d   0x08001458  0x080014e0  0x080041e6
2390x20003ae0:  0x1d   0x080041ee  0x08000cc2  0x00000000
240
241根据实际运行环境，上文中的数据会有差异，非固定结果
242```
243
244部分汇编文件如下:
245
246
247```
248                MemLeakTest:
249  0x80041d4: 0xb510         PUSH     {R4, LR}
250  0x80041d6: 0x4ca8         LDR.N    R4, [PC, #0x2a0]       ; g_memStart
251  0x80041d8: 0x0020         MOVS     R0, R4
252  0x80041da: 0xf7fd 0xf93e  BL       LOS_MemUsedNodeShow    ; 0x800145a
253  0x80041de: 0x2108         MOVS     R1, #8
254  0x80041e0: 0x0020         MOVS     R0, R4
255  0x80041e2: 0xf7fd 0xfbd9  BL       LOS_MemAlloc           ; 0x8001998
256  0x80041e6: 0x2108         MOVS     R1, #8
257  0x80041e8: 0x0020         MOVS     R0, R4
258  0x80041ea: 0xf7fd 0xfbd5  BL       LOS_MemAlloc           ; 0x8001998
259  0x80041ee: 0x0020         MOVS     R0, R4
260  0x80041f0: 0xf7fd 0xf933  BL       LOS_MemUsedNodeShow    ; 0x800145a
261  0x80041f4: 0xbd10         POP      {R4, PC}
262  0x80041f6: 0x0000         MOVS     R0, R0
263
264  根据实际运行环境，上文中的数据会有差异，非固定结果
265```
266
267其中，通过查找0x080041ee，就可以发现该内存节点是在MemLeakTest接口里申请的且是没有释放的。
268
269## 踩内存检测
270
271
272### 基础概念
273
274踩内存检测机制作为内核的可选功能，用于检测动态内存池的完整性。通过该机制，可以及时发现内存池是否发生了踩内存问题，并给出错误信息，便于及时发现系统问题，提高问题解决效率，降低问题定位成本。
275
276
277### 功能配置
278
279LOSCFG_BASE_MEM_NODE_INTEGRITY_CHECK：开关宏，默认关闭；若打开这个功能，在target_config.h中将这个宏定义为1。
280
2811. 开启这个功能，每次申请内存，会实时检测内存池的完整性。
282
2832. 如果不开启该功能，也可以调用LOS_MemIntegrityCheck接口检测，但是每次申请内存时，不会实时检测内存完整性，而且由于节点头没有魔鬼数字（开启时才有，省内存），检测的准确性也会相应降低，但对于系统的性能没有影响，故根据实际情况开关该功能。
284
285由于该功能只会检测出哪个内存节点被破坏了，并给出前节点信息（因为内存分布是连续的，当前节点最有可能被前节点破坏）。如果要进一步确认前节点在哪里申请的，需开启内存泄漏检测功能，通过LR记录，辅助定位。
286
287> ![icon-caution.gif](public_sys-resources/icon-caution.gif) **注意：**
288> 开启该功能，节点头多了魔鬼数字字段，会增大节点头大小。由于实时检测完整性，故性能影响较大；若性能敏感的场景，可以不开启该功能，使用LOS_MemIntegrityCheck接口检测。
289
290
291### 开发指导
292
293
294#### 开发流程
295
296通过调用LOS_MemIntegrityCheck接口检测内存池是否发生了踩内存，如果没有踩内存问题，那么接口返回0且没有log输出；如果存在踩内存问题，那么会输出相关log，详见下文编程实例的结果输出。
297
298
299#### 编程实例
300
301本实例实现如下功能：
302
3031. 申请两个物理上连续的内存块；
304
3052. 通过memset构造越界访问，踩到下个节点的头4个字节；
306
3073. 调用LOS_MemIntegrityCheck检测是否发生踩内存。
308
309
310#### 示例代码
311
312代码实现如下：
313
314本演示代码在 ./kernel/liteos_m/testsuites/src/osTest.c 中编译验证，在TestTaskEntry中调用验证入口函数MemIntegrityTest。
315
316qemu平台运行时需确保target_config.h 中对应的LOSCFG_MEM_FREE_BY_TASKID为0。
317
318由于执行时主动触发异常，执行结束后需要重启qemu（例如打开一个新的终端界面输入killall qemu-system-arm）
319
320
321```
322#include <stdio.h>
323#include <string.h>
324#include "los_memory.h"
325#include "los_config.h"
326
327void MemIntegrityTest(void)
328{
329    /* 申请两个物理连续的内存块 */
330    void *ptr1 = LOS_MemAlloc(LOSCFG_SYS_HEAP_ADDR, 8);
331    void *ptr2 = LOS_MemAlloc(LOSCFG_SYS_HEAP_ADDR, 8);
332    /* 第一个节点内存块大小是8字节，那么12字节的清零，会踩到第二个内存节点的节点头，构造踩内存场景 */
333    memset(ptr1, 0, 8 + 4);
334    LOS_MemIntegrityCheck(LOSCFG_SYS_HEAP_ADDR);
335}
336```
337
338
339#### 结果验证
340
341编译运行输出log如下：
342
343
344```
345
346/* 提示信息，检测到哪个字段被破坏了，用例构造了将下个节点的头4个字节清零，即魔鬼数字字段 */
347[ERR][IT_TST_INI][OsMemMagicCheckPrint], 1664, memory check error!
348memory used but magic num wrong, magic num = 0x0
349
350 /* 被破坏节点和其前节点关键字段信息，分别为其前节点地址、节点的魔鬼数字、节点的sizeAndFlag；可以看出被破坏节点的魔鬼数字字段被清零，符合用例场景 */
351 broken node head: 0x2103d7e8  0x0  0x80000020, prev node head: 0x2103c7cc  0xabcddcba  0x80000020
352
353 /* 节点的LR信息需要开启前文的内存泄漏检测功能才有有效输出 */
354 broken node head LR info:
355 LR[0]:0x2101906c
356 LR[1]:0x0
357 LR[2]:0x0
358
359 /* 通过LR信息，可以在汇编文件中查找前节点是哪里申请，然后排查其使用的准确性 */
360 pre node head LR info:
361 LR[0]:0x2101906c
362 LR[1]:0x0
363 LR[2]:0x0
364
365 /* 被破坏节点和其前节点的地址 */
366[ERR][IT_TST_INI]Memory integrity check error, cur node: 0x2103d784, pre node: 0x0
367
368 根据实际运行环境，上文中的数据会有差异，非固定结果
369```
370