1# MMIO
2
3MMIO是“内存映射IO”的缩写,它被广泛应用于与硬件设备的交互之中。
4
5## 地址空间管理
6
7DragonOS中实现了MMIO地址空间的管理机制,本节将介绍它们。
8
9### 为什么需要MMIO地址空间自动分配?
10
11  由于计算机上的很多设备都需要MMIO的地址空间,而每台计算机上所连接的各种设备的对MMIO地址空间的需求是不一样的。如果我们为每个类型的设备都手动指定一个MMIO地址,会使得虚拟地址空间被大大浪费,也会增加系统的复杂性。并且,我们在将来还需要为不同的虚拟内存区域做异常处理函数。因此,我们需要一套能够自动分配MMIO地址空间的机制。
12
13### 这套机制提供了什么功能?
14
15- 为驱动程序分配4K到1GB的MMIO虚拟地址空间
16- 对于这些虚拟地址空间,添加到VMA中进行统一管理
17- 可以批量释放这些地址空间
18
19### 这套机制是如何实现的?
20
21  这套机制本质上是使用了伙伴系统来对MMIO虚拟地址空间进行维护。在`mm/mm.h`中指定了MMIO的虚拟地址空间范围,这个范围是`0xffffa10000000000`开始的1TB的空间。也就是说,这个伙伴系统为MMIO维护了这1TB的虚拟地址空间。
22
23### 地址空间分配过程
24
251. 初始化MMIO-mapping模块,在mmio的伙伴系统中创建512个1GB的`__mmio_buddy_addr_region`
262. 驱动程序使用`mmio_create`请求分配地址空间。
273. `mmio_create`对申请的地址空间大小按照2的n次幂进行对齐,然后从buddy中申请内存地址空间
284. 创建VMA,并将VMA标记为`VM_IO|VM_DONTCOPY`。MMIO的vma只绑定在`initial_mm`下,且不会被拷贝。
295. 分配完成
30
31一旦MMIO地址空间分配完成,它就像普通的vma一样,可以使用mmap系列函数进行操作。
32
33### MMIO的映射过程
34
35  在得到了虚拟地址空间之后,当我们尝试往这块地址空间内映射内存时,我们可以调用`mm_map`函数,对这块区域进行映射。
36
37  该函数会对MMIO的VMA的映射做出特殊处理。即:创建`Page`结构体以及对应的`anon_vma`. 然后会将对应的物理地址,填写到页表之中。
38
39### MMIO虚拟地址空间的释放
40
41  当设备被卸载时,驱动程序可以调用`mmio_release`函数对指定的mmio地址空间进行释放。
42
43  释放的过程中,`mmio_release`将执行以下流程:
44
451. 取消mmio区域在页表中的映射。
462. 将释放MMIO区域的VMA
473. 将地址空间归还给mmio的伙伴系统。
48
49## MMIO的伙伴算法
50
51### 伙伴的定义
52
53  同时满足以下三个条件的两个内存块被称为伙伴内存块:
54
551. 两个内存块的大小相同
562. 两个内存块的内存地址连续
573. 两个内存块由同一个大块内存分裂得到
58
59### 伙伴算法
60
61  伙伴(buddy)算法的作用是维护以及组织大块连续内存块的分配和回收,以减少系统时运行产生的外部碎片。伙伴系统中的每个内存块的大小均为$2^n$。 在DragonOS中,伙伴系统内存池共维护了1TB的连续存储空间,最大的内存块大小为$1G$,即$2^{30}B$,最小的内存块大小为$4K$,即 $2^{12}B$。
62
63  伙伴算法的核心思想是当应用申请内存时,每次都分配比申请的内存大小更大的最小内存块,同时分配出去的内存块大小为$2^nB$。(e.g. 假设某应用申请了$3B$内存,显然并没有整数值n,使$2^n = 3$ ,且$3 \in [2^1,2^2]$,所以系统会去取一块大小为$2^2B$的内存块,将它分配给申请的应用,本次申请内存操作顺利完成。)
64
65  那么当伙伴系统中没有如此“合适”的内存块时该怎么办呢?系统先会去寻找更大的内存块,如果找到了,则会将大内存块分裂成合适的内存块分配给应用。(e.g. 假设申请$3B$内存,此时系统中比$3B$大的最小内存块的大小为$16B$,那么$16B$会被分裂成两块$8B$的内存块,一块放入内存池中,一块继续分裂成两块$4B$的内存块。两块$4B$的内存块,一块放入内存池中,一块分配给应用。至此,本次申请内存操作顺利完成。)
66
67  如果系统没有找到更大的内存块,系统将会尝试合并较小的内存块,直到符合申请空间的大小。(e.g. 假设申请$3B$内存,系统检查内存池发现只有两个$2B$的内存块,那么系统将会把这两个$2B$的内存块合并成一块$4B$的内存块,并分配给应用。至此,本次申请内存操作顺利完成。)
68
69  最后,当系统既没有找到大块内存,又无法成功合并小块内存时,就会通知应用内存不够,无法分配内存。
70
71### 伙伴算法的数据结构
72
73```
74
75                                  MmioBuddyMemPool
76
77┌─────────────────────────────────────────────────────────────────────────────────────┐
78│                                                                                     │
79│                                 pool_start_addr                                     │
80│                                                                                     │
81├─────────────────────────────────────────────────────────────────────────────────────┤
82│                                                                                     │
83│                                    pool_size                                        │
84│                                                                                     │
85├─────────────────────────────────────────────────────────────────────────────────────┤
86│                                                                                     │
87│                                                                                     │
88│                                   free_regions                                      │
89│                                                                                     │
90│                                  ┌────────────┐                                     │
91│                                  │            │     ┌───────┐     ┌────────┐        │
92│                                  │ ┌────────┬─┼────►│       ├────►│        │        │
93│                                  │ │  list  │ │     │ vaddr │     │ vaddr  │        │
94│                                  │ │        │◄├─────┤       │◄────┤        │        │
95│                  MmioFreeRegionList├────────┤ │     └───────┘     └────────┘        │
96│                                  │ │num_free│ │                                     │
97│                                  │ └────────┘ │  MmioBuddyAddrRegion                │
98│          MMIO_BUDDY_MIN_EXP - 12 │      0     │                                     │
99│                                  ├────────────┤                                     │
100│                                  │      1     │                                     │
101│                                  ├────────────┤                                     │
102│                                  │      2     │                                     │
103│                                  ├────────────┤                                     │
104│                                  │      3     │                                     │
105│                                  ├────────────┤                                     │
106│                                  │     ...    │                                     │
107│                                  ├────────────┤                                     │
108│                                  │     ...    │                                     │
109│                                  ├────────────┤                                     │
110│          MMIO_BUDDY_MAX_EXP - 12 │     18     │                                     │
111│                                  └────────────┘                                     │
112│                                                                                     │
113│                                                                                     │
114│                                                                                     │
115└─────────────────────────────────────────────────────────────────────────────────────┘
116```
117
118```rust
119
120/// 最大的内存块为1G,其幂为30
121const MMIO_BUDDY_MAX_EXP: u32 = PAGE_1G_SHIFT;
122/// 最小的内存块为4K,其幂为12
123const MMIO_BUDDY_MIN_EXP: u32 = PAGE_4K_SHIFT;
124/// 内存池数组的大小为18
125const MMIO_BUDDY_REGION_COUNT: u32 = MMIO_BUDDY_MAX_EXP - MMIO_BUDDY_MIN_EXP + 1;
126
127/// buddy内存池
128pub struct MmioBuddyMemPool {
129    /// 内存池的起始地址
130    pool_start_addr: u64,
131    /// 内存池大小:初始化为1TB
132    pool_size: u64,
133    /// 空闲内存块链表数组
134    /// MMIO_BUDDY_REGION_COUNT = MMIO_BUDDY_MAX_EXP - MMIO_BUDDY_MIN_EXP + 1
135    free_regions: [SpinLock<MmioFreeRegionList>; MMIO_BUDDY_REGION_COUNT as usize],
136}
137
138/// 空闲内存块链表结构体
139pub struct MmioFreeRegionList {
140    /// 存储了空闲内存块信息的结构体的链表
141    list: LinkedList<Box<MmioBuddyAddrRegion>>,
142    /// 当前链表空闲块的数量
143    num_free: i64,
144}
145
146/// mmio伙伴系统内部的地址区域结构体
147pub struct MmioBuddyAddrRegion {
148    /// 内存块的起始地址
149    vaddr: u64,
150}
151
152```
153
154### 设计思路
155
156&emsp;&emsp;DragonOS中,使用`MmioBuddyMemPool`结构体作为buddy(为表述方便,以下将伙伴算法简称为buddy)内存池的数据结构,其记录了内存池的起始地址(pool_start_addr)以及内存池中内存块的总大小(pool_size),同时其维护了大小为`MMIO_BUDDY_REGION_COUNT`的双向链表数组(free_regions)。`free_regions`中的各个链表维护了若干空闲内存块(MmioBuddyAddrRegion)。
157
158&emsp;&emsp;`free_regions`的下标(index)与内存块的大小有关。由于每个内存块大小都为$2^{n}$ bytes,那么可以令$exp = n$。index与exp的换算公式如下:$index = exp - 12$。e.g. 一个大小为$2^{12}$ bytes的内存块,其$exp = 12$,使用上述公式计算得$index = 12 -12 = 0$,所以该内存块会被存入`free_regions[0].list`中。通过上述换算公式,每次取出或释放$2^n$大小的内存块,只需要操作`free_regions[n -12]`即可。DragonOS中,buddy内存池最大的内存块大小为$1G =  2^{30}bytes$,最小的内存块大小为 $4K =  2^{12} bytes$,所以$index\in[0,18]$。
159
160&emsp;&emsp;作为内存分配机制,buddy服务于所有进程,为了解决在各个进程之间实现free_regions中的链表数据同步的问题,`free_regions`中的链表类型采用加了 {ref}`自旋锁 <_spinlock_doc_spinlock>`(SpinLock)的空闲内存块链表(MmioFreeRegionList),`MmioFreeRegionList`中封装有真正的存储了空闲内存块信息的结构体的链表(list)和对应链表长度(num_free)。有了自选锁后,同一时刻只允许一个进程修改某个链表,如取出链表元素(申请内存)或者向链表中插入元素(释放内存)。
161
162&emsp;&emsp;`MmioFreeRegionList`中的元素类型为`MmioBuddyAddrRegion`结构体,`MmioBuddyAddrRegion`记录了内存块的起始地址(vaddr)。
163
164### 伙伴算法内部api
165
166**P.S 以下函数均为MmioBuddyMemPool的成员函数。系统中已经创建了一个MmioBuddyMemPool类型的全局引用`MMIO_POOL`,如要使用以下函数,请以`MMIO_POOL.xxx()`形式使用,以此形式使用则不需要传入self。**
167
168| **函数名**                                                           | **描述**                                                    |
169|:----------------------------------------------------------------- |:--------------------------------------------------------- |
170| __create_region(&self, vaddr)                                     | 将虚拟地址传入,创建新的内存块地址结构体                                      |
171| __give_back_block(&self, vaddr, exp)                              | 将地址为vaddr,幂为exp的内存块归还给buddy                               |
172| __buddy_split(&self,region,exp,list_guard)                        | 将给定大小为$2^{exp}$的内存块一分为二,并插入内存块大小为$2^{exp-1}$的链表中          |
173| __query_addr_region(&self,exp,list_guard)                         | 从buddy中申请一块大小为$2^{exp}$的内存块                               |
174| mmio_buddy_query_addr_region(&self,exp)                           | 对query_addr_region进行封装,**请使用这个函数,而不是__query_addr_region** |
175| __buddy_add_region_obj(&self,region,list_guard)                   | 往指定的地址空间链表中添加一个内存块                                        |
176| __buddy_block_vaddr(&self, vaddr, exp)                            | 根据地址和内存块大小,计算伙伴块虚拟内存的地址                                   |
177| __pop_buddy_block( &self, vaddr,exp,list_guard)                   | 寻找并弹出指定内存块的伙伴块                                            |
178| __buddy_pop_region( &self,        list_guard)                     | 从指定空闲链表中取出内存区域                                            |
179| __buddy_merge(&self,exp,list_guard,high_list_guard)               | 合并所有$2^{exp}$大小的内存块                                       |
180| __buddy_merge_blocks(&self,region_1,region_2,exp,high_list_guard) | 合并两个**已经从链表中取出的**内存块                                      |
181
182### 伙伴算法对外api
183
184| **函数名**                                         | **描述**                                      |
185| ----------------------------------------------- | ------------------------------------------- |
186| __mmio_buddy_init()                             | 初始化buddy系统,**在mmio_init()中调用,请勿随意调用**       |
187| __exp2index(exp)                                | 将$2^{exp}$的exp转换成内存池中的数组的下标(index)          |
188| mmio_create(size,vm_flags,res_vaddr,res_length) | 创建一块根据size对齐后的大小的mmio区域,并将其vma绑定到initial_mm |
189| mmio_release(vaddr, length)                     | 取消地址为vaddr,大小为length的mmio的映射并将其归还到buddy中    |
190