API 文档标准化.

Signed-off-by: ithink.chan <chenyang@autoai.com>

Software/Development/OperatingSystem/Linux/Kernel/API/Linux_Kernel_内存分配.md

@@ -1,16 +1,28 @@
 # Linux Kernel 内存分配
 
-## kmalloc()
+## kmalloc/kzalloc/kfree
 
-函数原型：
+通过 kmalloc/kzalloc 分配内核空间，通过 kfree 释放。
+
+### kmalloc
+
+**函数原型：**
 
 ```c
 void *kmalloc(size_t size, gfp_t flags);
 ```
 
-kmalloc() 申请的内存位于物理内存映射区域，而且在物理上也是连续的，它们与真实的物理地址只有一个固定的偏移，因为存在较简单的转换关系，所以对申请的内存大小有限制，不能超过128KB。
-　　
-较常用的 flags（分配内存的方法）：
+**说明：**
+
+kmalloc() 申请的内存位于物理内存映射区域，而且在物理上也是连续的，它们与真实的物理地址只有一个固定的偏移，因为存在较简单的转换关系，所以对申请的内存大小有限制，最大只能开辟 128k-16 字节空间，16 个字节是被页描述符结构占用了。
+
+**参数：**
+
+size：要分配的内存大小，以字节为单位。
+
+flags：要分配内存的类型。
+
+较常用的 flags（分配内存的方法）如下：
 
 * GFP_ATOMIC —— 分配内存的过程是一个原子过程，分配内存的过程不会被（高优先级进程或中断）打断；
 * GFP_KERNEL —— 正常分配内存；
@@ -25,15 +37,13 @@ flags 的参考用法：
 | 用于DMA的内存，可以睡眠   | GFP_DMA \| GFP_KERNEL |
 | 用于DMA的内存，不可以睡眠 | GFP_DMA \|GFP_ATOMIC  |
 
-对应的内存释放函数为：
+**返回值：**
 
-```c
-void kfree(const void *objp);
-```
+申请成功返回有效的内存首地址，失败返回 NULL。
 
-## kzalloc()
+### kzalloc
 
-kzalloc() 函数与 kmalloc() 非常相似，参数及返回值是一样的，可以说是前者是后者的一个变种，因为 kzalloc() 实际上只是额外附加了 __GFP_ZERO 标志。所以它除了申请内核内存外，还会对申请到的内存内容清零。
+**函数原型：**
 
 ```c
 /**
@@ -47,27 +57,85 @@ static inline void *kzalloc(size_t size, gfp_t flags)
 }
 ```
 
-kzalloc() 对应的内存释放函数也是 kfree()。
+**说明：**
 
-## vmalloc()
+kzalloc() 函数与 kmalloc() 非常相似，参数及返回值是一样的，可以说是前者是后者的一个变种，因为 kzalloc() 实际上只是额外附加了 __GFP_ZERO 标志。所以它除了申请内核内存外，还会对申请到的内存内容清零。
 
-函数原型：
+**参数：**
+
+size：要分配的内存大小，以字节为单位。
+
+flags：要分配内存的类型。
+
+**返回值：**
+
+申请成功返回有效的内存首地址，失败返回 NULL。
+
+### kfree
+
+**函数原型：**
+
+```c
+void kfree(const void *addr);
+```
+
+**说明：**
+
+用于释放由 kmalloc/kzalloc 申请的内存。
+
+**参数：**
+
+addr：要释放的内存首地址指针
+
+**返回值：**
+
+无
+
+## vmalloc/vfree
+
+通过 vmalloc 分配内核空间，通过 vfree 释放。可以分配较大内存。使用 vmalloc 最著名的实例是内核对模块的实现，当模块被动态加载到内核当中时，就把模块装载到由 vmalloc() 分配的内存上。注意：vmalloc() 和 vfree() 可以睡眠，因此不能从中断上下文调用。
+
+### vmalloc
+
+**函数原型：**
 
 ```c
 void *vmalloc(unsigned long size);
 ```
 
+**说明：**
+
 vmalloc() 函数则会在虚拟内存空间给出一块连续的内存区，但这片连续的虚拟内存在物理内存中并不一定连续。由于 vmalloc() 没有保证申请到的是连续的物理内存，因此对申请的内存大小没有限制，如果需要申请较大的内存空间就需要用此函数了。
 
-对应的内存释放函数为：
+**参数：**
+
+size：要分配的内存大小，以字节为单位。
+
+**返回值：**
+
+申请成功返回有效的内存首地址，失败返回 NULL。
+
+### vfree
+
+**函数原型：**
 
 ```c
 void vfree(const void *addr);
 ```
 
-注意：vmalloc() 和 vfree() 可以睡眠，因此不能从中断上下文调用。
+**说明：**
 
-## 总结
+释放由 vmalloc 分配的内核空间。
+
+**参数：**
+
+addr：要释放的内存首地址指针
+
+**返回值：**
+
+无
+
+## kmalloc/kzalloc/vmalloc 的比较
 
 kmalloc()、kzalloc()、vmalloc() 的共同特点是：
 
@@ -83,4 +151,4 @@ kmalloc()、kzalloc()、vmalloc() 的区别是：
 4. kmalloc 分配内存的过程可以是原子过程（使用 GFP_ATOMIC），而 vmalloc 分配内存时则可能产生阻塞；
 5. kmalloc 分配内存的开销小，因此 kmalloc 比 vmalloc 要快。
 
-一般情况下，内存只有在要被 DMA 访问的时候才需要物理上连续，但为了性能上的考虑，内核中一般使用 kmalloc()，而只有在需要获得大块内存时才使用 vmalloc()。例如，当模块被动态加载到内核当中时，就把模块装载到由 vmalloc() 分配的内存上。
+一般情况下，内存只有在要被 DMA 访问的时候才需要物理上连续，但为了性能上的考虑，内核中一般使用 kmalloc()，而只有在需要获得大块内存时才使用 vmalloc()。