diff --git a/README.md b/README.md index e9281b398d742d6eb0ddbebefd3f20829c85cc76..f0b41818c67499e5e2c1d581769efa24dc681516 100644 --- a/README.md +++ b/README.md @@ -1,72 +1,71 @@ -# 内存基础库部件 +# The Part of Memory Base Libraries -- [简介](#section_introduction) -- [部件架构图](#section_architecture) -- [目录](#section_catalogue) -- [内存基础库](#section_libraries) - - [libdmabufheap系统库](#section_libdmabufheap) - - [libmeminfo系统库（规划中）](#section_libmeminfo) - - [libmemleak系统库（规划中）](#section_libmemleak) - - [libpurgeable系统库（规划中）](#section_libpurgeable) - - [libspeculative系统库（规划中）](#section_libspeculative) -- [使用说明](#section_usage) -- [相关仓](#section_projects) +- [Introduction](#section_introduction) +- [Architecture](#section_architecture) +- [Directory Structure](#section_catalogue) +- [Memory Base Libraries](#section_libraries) + - [libdmabufheap system library](#section_libdmabufheap) + - [libmeminfo system library (planning)](#section_libmeminfo) + - [libmemleak system library (planning)](#section_libmemleak) + - [libpurgeable system library (planning)](#section_libpurgeable) + - [libspeculative system library (planning)](#section_libspeculative) +- [Usage Guidelines](#section_usage) +- [Repositories Involved](#section_projects) -## 简介 +## Introduction -内存基础库部件位于公共基础库子系统中，为上层业务提供对应的操作内存的系统库，保证上层业务的稳定性。 +The part of *Memory base libraries* belongs to the subsystem named *Utils Subsystem*. It provides the system library for upper-layer services to operate memory, ensuring the stability of upper-layer services. -## 部件架构图 +## Architecture -**图1** 内存基础库部件架构图 +**Figure 1** Memory Base Libraries architecture -![](figures/zh-cn_image_fwk.png) +![](figures/en-us_image_fwk.png) -## 目录 +## Directory Structure ``` /utils/memory -├── libdmabufheap # DMA (Direct Memory Access) 内存分配链接库 -│   ├── include # DMA内存分配链接库头文件目录 -│   ├── src # DMA内存分配链接库源代码目录 -│   └── test # DMA内存分配链接库自测用例目录 -├── libmeminfo # 内存占用查询库 -├── libmemleak # 内存泄漏检测库 -├── libpurgeable # 可丢弃类型内存管理库 -└── libspeculative # 投机类型内存管理库 +├── libdmabufheap # DMA (Direct Memory Access) memory allocation system library +│   ├── include # DMA memory allocation system library header directory +│   ├── src # DMA memory allocation system library source directory +│   └── test # DMA memory allocation system library usecase directory +├── libmeminfo # Memory footprint management library +├── libmemleak # Memory leak detection library +├── libpurgeable # Purgeable memory management library +└── libspeculative # Speculative memory management library ``` -## 内存基础库 +## Memory Base Libraries -内存基础库是集成内存操作的系统库的部件，对内存操作的系统库进行统一管理。 +*Memory base libraries* is a component of the system library that integrates memory operations and manages them in a unified manner. -### libdmabufheap系统库 +### libdmabufheap system library -为业务提供分配共享内存的接口，通过在硬件设备和用户空间之间分配和共享内存，实现 -设备、进程间零拷贝内存，提升执行效率。 +The memory system library provides interfaces for services to allocate and share shared memory. By allocating and sharing memory between hardware devices and user space, zero-copy memory between devices and processes is implemented to improve execution efficiency. -### libmeminfo系统库（规划中） +### libmeminfo system library (planning) -提供内存占用查询接口。主要提供给内存占用维测（hidumper）、低内存查杀服务（lmks）使用。 +It provides interfaces for memory usage queries. It is mainly used by memory footprint management service(hidumper) and low-memory killing service(lmks). -### libmemleak系统库（规划中） +### libmemleak system library (planning) -配合malloc_debug做native heap内存泄漏检测。 +It cooperates with malloc_debug to detect memory leaks of native heap. -### libpurgeable系统库（规划中） +### libpurgeable system library (planning) -提供可丢弃类型内存的管理接口。主要提供给多媒体业务图形图像编解码库使用。 +It provides management interfaces for discardable-type memory. It is mainly used by graphics and image codec libraries. -### libspeculative系统库（规划中） +### libspeculative system library (planning) -提供投机类型内存管理接口。主要提供给系统服务使用，用于缓存预读。 +It provides management interfaces for speculative-type memory. It is mainly used by system services for data pre-loading. -## 使用说明 +## Usage Guidelines -系统开发者可以通过配置productdefine/common/products下的产品定义json文件，增加或移除本部件，来启用或停用本部件。 +System developers can add or remove this part by configuring the product definition JSON file under **/productdefine/common/products** to enable or disable this part: ` "utils:utils_memory":{} ` -## 相关仓 +## Repositories Involved -[公共基础库子系统](https://gitee.com/openharmony/utils) \ No newline at end of file +[utils](https://gitee.com/openharmony/utils) \ No newline at end of file diff --git a/README_zh.md b/README_zh.md index f0b41818c67499e5e2c1d581769efa24dc681516..e9281b398d742d6eb0ddbebefd3f20829c85cc76 100644 --- a/README_zh.md +++ b/README_zh.md @@ -1,71 +1,72 @@ -# The Part of Memory Base Libraries +# 内存基础库部件 -- [Introduction](#section_introduction) -- [Architecture](#section_architecture) -- [Directory Structure](#section_catalogue) -- [Memory Base Libraries](#section_libraries) - - [libdmabufheap system library](#section_libdmabufheap) - - [libmeminfo system library (planning)](#section_libmeminfo) - - [libmemleak system library (planning)](#section_libmemleak) - - [libpurgeable system library (planning)](#section_libpurgeable) - - [libspeculative system library (planning)](#section_libspeculative) -- [Usage Guidelines](#section_usage) -- [Repositories Involved](#section_projects) +- [简介](#section_introduction) +- [部件架构图](#section_architecture) +- [目录](#section_catalogue) +- [内存基础库](#section_libraries) + - [libdmabufheap系统库](#section_libdmabufheap) + - [libmeminfo系统库（规划中）](#section_libmeminfo) + - [libmemleak系统库（规划中）](#section_libmemleak) + - [libpurgeable系统库（规划中）](#section_libpurgeable) + - [libspeculative系统库（规划中）](#section_libspeculative) +- [使用说明](#section_usage) +- [相关仓](#section_projects) -## Introduction +## 简介 -The part of *Memory base libraries* belongs to the subsystem named *Utils Subsystem*. It provides the system library for upper-layer services to operate memory, ensuring the stability of upper-layer services. +内存基础库部件位于公共基础库子系统中，为上层业务提供对应的操作内存的系统库，保证上层业务的稳定性。 -## Architecture +## 部件架构图 -**Figure 1** Memory Base Libraries architecture +**图1** 内存基础库部件架构图 -![](figures/en-us_image_fwk.png) +![](figures/zh-cn_image_fwk.png) -## Directory Structure +## 目录 ``` /utils/memory -├── libdmabufheap # DMA (Direct Memory Access) memory allocation system library -│   ├── include # DMA memory allocation system library header directory -│   ├── src # DMA memory allocation system library source directory -│   └── test # DMA memory allocation system library usecase directory -├── libmeminfo # Memory footprint management library -├── libmemleak # Memory leak detection library -├── libpurgeable # Purgeable memory management library -└── libspeculative # Speculative memory management library +├── libdmabufheap # DMA (Direct Memory Access) 内存分配链接库 +│   ├── include # DMA内存分配链接库头文件目录 +│   ├── src # DMA内存分配链接库源代码目录 +│   └── test # DMA内存分配链接库自测用例目录 +├── libmeminfo # 内存占用查询库 +├── libmemleak # 内存泄漏检测库 +├── libpurgeable # 可丢弃类型内存管理库 +└── libspeculative # 投机类型内存管理库 ``` -## Memory Base Libraries +## 内存基础库 -*Memory base libraries* is a component of the system library that integrates memory operations and manages them in a unified manner. +内存基础库是集成内存操作的系统库的部件，对内存操作的系统库进行统一管理。 -### libdmabufheap system library +### libdmabufheap系统库 -The memory system library provides interfaces for services to allocate and share shared memory. By allocating and sharing memory between hardware devices and user space, zero-copy memory between devices and processes is implemented to improve execution efficiency. +为业务提供分配共享内存的接口，通过在硬件设备和用户空间之间分配和共享内存，实现 +设备、进程间零拷贝内存，提升执行效率。 -### libmeminfo system library (planning) +### libmeminfo系统库（规划中） -It provides interfaces for memory usage queries. It is mainly used by memory footprint management service(hidumper) and low-memory killing service(lmks). +提供内存占用查询接口。主要提供给内存占用维测（hidumper）、低内存查杀服务（lmks）使用。 -### libmemleak system library (planning) +### libmemleak系统库（规划中） -It cooperates with malloc_debug to detect memory leaks of native heap. +配合malloc_debug做native heap内存泄漏检测。 -### libpurgeable system library (planning) +### libpurgeable系统库（规划中） -It provides management interfaces for discardable-type memory. It is mainly used by graphics and image codec libraries. +提供可丢弃类型内存的管理接口。主要提供给多媒体业务图形图像编解码库使用。 -### libspeculative system library (planning) +### libspeculative系统库（规划中） -It provides management interfaces for speculative-type memory. It is mainly used by system services for data pre-loading. +提供投机类型内存管理接口。主要提供给系统服务使用，用于缓存预读。 -## Usage Guidelines +## 使用说明 -System developers can add or remove this part by configuring the product definition JSON file under **/productdefine/common/products** to enable or disable this part: +系统开发者可以通过配置productdefine/common/products下的产品定义json文件，增加或移除本部件，来启用或停用本部件。 ` "utils:utils_memory":{} ` -## Repositories Involved +## 相关仓 -[utils](https://gitee.com/openharmony/utils) \ No newline at end of file +[公共基础库子系统](https://gitee.com/openharmony/utils) \ No newline at end of file