From b20fc90252e43b00fe0129ed6c6ed0eb3a878668 Mon Sep 17 00:00:00 2001 From: Yuanzheng Song Date: Thu, 17 Feb 2022 17:30:35 +0800 Subject: [PATCH] add utils_memory README issue: #I4U62I Signed-off-by: Yuanzheng Song --- README.en.md | 51 ++++++++++++++++++++++++------------------------ README.md | 55 ++++++++++++++++++++++++++-------------------------- 2 files changed, 53 insertions(+), 53 deletions(-) diff --git a/README.en.md b/README.en.md index bbab745..acde9b4 100644 --- a/README.en.md +++ b/README.en.md @@ -1,36 +1,37 @@ -# utils_memory +# The Part of Memory System Library -#### Description -{**When you're done, you can delete the content in this README and update the file with details for others getting started with your repository**} +- [Introduction](#section_introduction) +- [Directory Structure](#section_catalogue) +- [Memory System Library](#section_libraries) + - [libdmabufheap system library](#section_libdmabufheap) +- [Usage Guidelines](#section_usage) -#### Software Architecture -Software architecture description +## Introduction -#### Installation +The part of *Memory system Library* 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. -1. xxxx -2. xxxx -3. xxxx +## Directory Structure -#### Instructions +``` +/utils/memory +└── libdmabufheap # DMA memory allocation system library +    ├── BUILD.gn +    ├── include # DMA memory allocation system library header directory +    │   └── dmabuf_alloc.h +    ├── src # DMA memory allocation system library source directory +    │   └── dmabuf_alloc.c +    └── test # DMA memory allocation system library usecase directory +``` +## Memory System Libraries -1. xxxx -2. xxxx -3. xxxx +The memory system library is a component of the system library that integrates memory operations and manages them in a unified manner. -#### Contribution +### libdmabufheap system library -1. Fork the repository -2. Create Feat_xxx branch -3. Commit your code -4. Create Pull Request +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. +## Usage Guidelines -#### Gitee Feature +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: -1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md -2. Gitee blog [blog.gitee.com](https://blog.gitee.com) -3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) -4. The most valuable open source project [GVP](https://gitee.com/gvp) -5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) -6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +` "utils:utils_memory":{} ` \ No newline at end of file diff --git a/README.md b/README.md index f3691ad..0df06af 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,38 @@ -# utils_memory +# 内存系统库 -#### 介绍 -{**以下是 Gitee 平台说明,您可以替换此简介** -Gitee 是 OSCHINA 推出的基于 Git 的代码托管平台(同时支持 SVN)。专为开发者提供稳定、高效、安全的云端软件开发协作平台 -无论是个人、团队、或是企业,都能够用 Gitee 实现代码托管、项目管理、协作开发。企业项目请看 [https://gitee.com/enterprises](https://gitee.com/enterprises)} +- [简介](#section_introduction) +- [目录](#section_catalogue) +- [内存系统库](#section_libraries) + - [libdmabufheap系统库](#section_libdmabufheap) +- [使用说明](#section_usage) -#### 软件架构 -软件架构说明 +## 简介 +内存系统库部件位于公共基础库子系统中,为上层业务提供对应的操作内存的系统库,保证上层业务的稳定性。 -#### 安装教程 +## 目录 -1. xxxx -2. xxxx -3. xxxx +``` +/utils/memory +└── libdmabufheap # DMA内存分配链接库 +    ├── BUILD.gn +    ├── include # DMA内存分配链接库头文件目录 +    │   └── dmabuf_alloc.h +    ├── src # DMA内存分配链接库源代码目录 +    │   └── dmabuf_alloc.c +    └── test # DMA内存分配链接库自测用例目录 +``` +## 内存系统库 -#### 使用说明 +内存系统库是集成内存操作的系统库的部件,对内存操作的系统库进行统一管理。 -1. xxxx -2. xxxx -3. xxxx +### libdmabufheap系统库 -#### 参与贡献 +为业务提供分配共享内存的接口,通过在硬件设备和用户空间之间分配和共享内存,实现 +设备、进程间零拷贝内存,提升执行效率。 -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request +## 使用说明 +系统开发者可以通过配置productdefine/common/products下的产品定义json文件,增加或移除本部件,来启用或停用本部件。 -#### 特技 - -1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +` "utils:utils_memory":{} ` \ No newline at end of file -- Gitee