ros666/mm/
memory_set.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
//! 地址空间管理
//!
//! 地址空间管理模块实现了内核和用户的地址空间管理,提供了内核空间和用户空间的创建、映射、切换等功能。
use core::{arch::asm, cell::RefCell, ops::Range};

use crate::{
    extern_global,
    mm::{address::PAGE_SIZE_SV39, frame_allocator::MEMORY_END},
    task::{stack::USER_STACK_SIZE, task::TRAP_CONTEXT},
    trace,
    utils::safety::SyncRefCell,
};

use super::{
    address::{PhysicalAddress, PhysicalPageNumber, VPNRange, VirtualAddress, VirtualPageNumber},
    frame_allocator::{FrameTracker, StackFrameAllocator},
    page_table::{self, PTEFlags, PageTable, PageTableEntry},
};
use alloc::{collections::btree_map::BTreeMap, sync::Arc, vec::Vec};
use bitflags::bitflags;
use riscv::register::{satp, sstatus};
use xmas_elf::ElfFile;

use lazy_static::lazy_static;

/// 跳板地址常量
///
/// 用于存放用户态-内核态切换时的中间跳板代码
pub const TRAMPOLINE: usize = usize::MAX - PAGE_SIZE_SV39 + 1;

lazy_static! {
    /// 内核空间
    pub static ref KERNEL_SPACE: Arc<SyncRefCell<MemorySet>> = {
        Arc::new(SyncRefCell {
            ref_cell: RefCell::new(MemorySet::new_kernel()),
        })
    };
}

/// 映射类型
///
/// 映射类型包括线性映射(恒等映射)和页帧映射
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
pub enum MapType {
    Linear,
    Framed,
}

bitflags! {
    /// 映射权限标志
    #[derive(Copy, Clone, Debug)]
    pub struct MapPermission: u8 {
        const Read = 1 << 1;
        const Write = 1 << 2;
        const Execute = 1 << 3;
        const User = 1 << 4;
    }
}

/// 逻辑段
///
/// 逻辑段管理了一段虚拟内存,提供映射和访存权限控制
///
/// 在内核和应用程序初始化时,需要根据编译链接到的代码段、数据段等信息,创建逻辑段
pub struct MapArea {
    vpn_range: VPNRange,
    data: BTreeMap<VirtualPageNumber, FrameTracker>,
    map_type: MapType,
    permission: MapPermission,
}

/// 地址空间
///
/// 地址空间包含了一组虚拟内存,基于三级页表实现了虚拟内存到物理内存的映射
pub struct MemorySet {
    pub page_table: PageTable,
    pub areas: Vec<MapArea>,
}

impl MapArea {
    /// 创建新的 MapArea
    ///
    /// ## 参数
    /// * `vpn_range` - 虚拟页号范围
    /// * `map_type` - 映射类型
    /// * `permission` - 映射权限
    pub fn new(vpn_range: VPNRange, map_type: MapType, permission: MapPermission) -> Self {
        Self {
            vpn_range,
            data: BTreeMap::new(),
            map_type,
            permission,
        }
    }

    /// 映射虚拟页到物理页
    ///
    /// ## 参数
    /// * `page_table` - 页表
    pub fn map(&mut self, page_table: &mut PageTable) {
        for vpn in self.vpn_range {
            self.map_one(vpn, page_table);
        }
    }

    /// 取消映射虚拟页
    ///
    /// ## 参数
    /// * `page_table` - 页表
    pub fn unmap(&mut self, page_table: &mut PageTable) {
        for vpn in self.vpn_range {
            self.unmap_one(vpn, page_table);
        }
    }

    /// 获取虚拟页对应的物理页框
    ///
    /// ## 参数
    /// * `vpn` - 虚拟页号
    /// ## 返回值
    /// 返回对应的物理页框
    pub fn get_frame(&self, vpn: VirtualPageNumber) -> Option<&FrameTracker> {
        self.data.get(&vpn)
    }

    /// 获取映射权限
    ///
    /// ## 返回值
    /// 返回映射权限
    pub fn get_permission(&self) -> MapPermission {
        self.permission
    }

    /// 映射单个虚拟页到物理页
    ///
    /// ## 参数
    /// * `vpn` - 虚拟页号
    /// * `page_table` - 页表
    pub fn map_one(&mut self, vpn: VirtualPageNumber, page_table: &mut PageTable) {
        let ppn = match self.map_type {
            MapType::Linear => PhysicalPageNumber(vpn.0),
            MapType::Framed => {
                let frame = StackFrameAllocator::alloc_frame().unwrap();
                let ppn = frame.frame;
                self.data.insert(vpn, frame);
                ppn
            }
        };
        let flags = page_table::PTEFlags::from_bits(self.permission.bits()).unwrap();
        page_table.map(vpn, ppn, flags);
    }

    /// 取消映射单个虚拟页
    ///
    /// ## 参数
    /// * `vpn` - 虚拟页号
    /// * `page_table` - 页表
    pub fn unmap_one(&mut self, vpn: VirtualPageNumber, page_table: &mut PageTable) {
        match self.map_type {
            MapType::Linear => {}
            MapType::Framed => {
                self.data.remove(&vpn);
                // StackFrameAllocator::dealloc_frame(ppn);
            }
        }
        page_table.unmap(vpn);
    }

    /// 从源数据复制到映射区域
    ///
    /// ## 参数
    /// * `page_table` - 页表
    /// * `src` - 源数据
    pub fn copy_from(&mut self, page_table: &mut PageTable, src: &[u8]) {
        if self.map_type != MapType::Framed {
            panic!("copy_from: only support framed mapping");
        }
        let len = src.len();
        let mut offset = 0;
        let mut current_vpn = self.vpn_range.start;
        while offset < len {
            let vpn = current_vpn;
            let pte = page_table.translate(vpn).unwrap();
            let dst = PhysicalPageNumber::from(&pte).get_bytes_array();
            let src = &src[offset..];
            let copy_len = dst.len().min(src.len());
            dst[..copy_len].copy_from_slice(&src[..copy_len]);
            offset += copy_len;
            current_vpn.0 += 1;
        }
    }

    /// 从另一个 MapArea 创建新的 MapArea
    ///
    /// ## 参数
    /// * `another` - 另一个 MapArea
    /// ## 返回值
    /// 返回新的 MapArea
    pub fn from_another(another: &MapArea) -> Self {
        Self {
            vpn_range: another.vpn_range,
            data: BTreeMap::new(),
            map_type: another.map_type,
            permission: another.permission,
        }
    }
}

impl MemorySet {
    /// 创建一个空的 MemorySet
    pub fn empty() -> Self {
        Self {
            page_table: PageTable::new(),
            areas: Vec::new(),
        }
    }

    /// 获取页表 token
    ///
    /// token 即 satp (satp: Supervisor Address Translation and Protection) 寄存器的值
    ///
    /// 在启用 Sv39 页表时,satp 即作为三级页表的根节点。其第 60-63 位为模式位,为 0b100 时启用 Sv39 页表
    pub fn token(&self) -> usize {
        self.page_table.token()
    }

    /// 激活当前 MemorySet
    pub fn activate(&self) {
        let satp = self.page_table.token();
        unsafe {
            // NOTE:
            // 但是经测试,必须设置 SUM 位才能正常运行
            // 猜测是 内核态无法访问用户态内存 导致
            // 解决此 Bug 时间: 10.5 h. QAQ
            sstatus::set_sum();
            satp::write(satp);
            asm!("sfence.vma"); // 刷新 TLB
        }
    }

    /// 添加一个 MapArea 到 MemorySet
    ///
    /// ## 参数
    /// * `area` - 要添加的 MapArea
    /// * `data` - 可选的数据,用于初始化映射区域
    pub fn push(&mut self, mut area: MapArea, data: Option<&[u8]>) {
        area.map(&mut self.page_table);
        if let Some(data) = data {
            area.copy_from(&mut self.page_table, data);
        }
        self.areas.push(area);
    }

    /// 插入一个虚拟地址范围到 MemorySet
    ///
    /// ## 参数
    /// * `va_range` - 虚拟地址范围
    /// * `permission` - 映射权限
    pub fn insert(&mut self, va_range: Range<VirtualAddress>, permission: MapPermission) {
        self.push(
            MapArea::new(
                VPNRange::from_addr(va_range.start, va_range.end),
                MapType::Framed,
                permission,
            ),
            None,
        );
    }

    /// 移除一个 MapArea
    ///
    /// ## 参数
    /// * `start_vpn` - 要移除的 MapArea 的起始虚拟页号
    pub fn remove_area(&mut self, start_vpn: VirtualPageNumber) {
        let mut index = None;
        for (i, area) in self.areas.iter().enumerate() {
            if area.vpn_range.start == start_vpn {
                index = Some(i);
                break;
            }
        }
        if let Some(index) = index {
            let mut area = self.areas.remove(index);
            area.unmap(&mut self.page_table);
        }
    }

    /// 映射跳板
    pub fn map_trampoline(&mut self) {
        self.page_table.map(
            VirtualPageNumber::from(VirtualAddress::from(TRAMPOLINE)),
            PhysicalPageNumber::from(PhysicalAddress::from(extern_global!(__strampoline) as usize)),
            PTEFlags::Read | PTEFlags::Execute,
        );
    }

    /// 翻译虚拟页号到页表项
    ///
    /// ## 参数
    /// * `vpn` - 虚拟页号
    /// ## 返回值
    /// 返回对应的页表项
    pub fn translate(&self, vpn: VirtualPageNumber) -> Option<PageTableEntry> {
        self.page_table.translate(vpn)
    }

    /// 回收所有 MapArea
    pub fn recycle(&mut self) {
        self.areas.clear();
    }

    /// 创建内核 MemorySet
    pub fn new_kernel() -> Self {
        let _kernel_start = extern_global!(__kernel_start) as usize;
        let kernel_end = extern_global!(__kernel_end) as usize;
        let text_start = extern_global!(__text_start) as usize;
        let text_end = extern_global!(__text_end) as usize;
        let rodata_start = extern_global!(__rodata_start) as usize;
        let rodata_end = extern_global!(__rodata_end) as usize;
        let data_start = extern_global!(__data_start) as usize;
        let data_end = extern_global!(__data_end) as usize;
        let bss_start = extern_global!(__bss_start_stack) as usize;
        let bss_end = extern_global!(__bss_end) as usize;

        let mut memory_set = MemorySet::empty();
        memory_set.map_trampoline();
        trace!("mapping .text: [{:#x}, {:#x})", text_start, text_end);
        memory_set.push(
            MapArea::new(
                VPNRange::from_addr(
                    VirtualAddress::from(text_start),
                    VirtualAddress::from(text_end),
                ),
                MapType::Linear,
                MapPermission::Read | MapPermission::Execute,
            ),
            None,
        );
        trace!("mapping .rodata: [{:#x}, {:#x})", rodata_start, rodata_end);
        memory_set.push(
            MapArea::new(
                VPNRange::from_addr(
                    VirtualAddress::from(rodata_start),
                    VirtualAddress::from(rodata_end),
                ),
                MapType::Linear,
                MapPermission::Read,
            ),
            None,
        );
        trace!("mapping .data: [{:#x}, {:#x})", data_start, data_end);
        memory_set.push(
            MapArea::new(
                VPNRange::from_addr(
                    VirtualAddress::from(data_start),
                    VirtualAddress::from(data_end),
                ),
                MapType::Linear,
                MapPermission::Read | MapPermission::Write,
            ),
            None,
        );
        trace!("mapping .bss: [{:#x}, {:#x})", bss_start, bss_end);
        memory_set.push(
            MapArea::new(
                VPNRange::from_addr(
                    VirtualAddress::from(bss_start),
                    VirtualAddress::from(bss_end),
                ),
                MapType::Linear,
                MapPermission::Read | MapPermission::Write,
            ),
            None,
        );
        trace!("mapping heap: [{:#x}, {:#x})", kernel_end, MEMORY_END);
        memory_set.push(
            MapArea::new(
                VPNRange::from_addr(
                    VirtualAddress::from(kernel_end),
                    VirtualAddress::from(MEMORY_END),
                ),
                MapType::Linear,
                MapPermission::Read | MapPermission::Write,
            ),
            None,
        );

        // pub const MMIO: &[(usize, usize)] = &[
        //     (0x0010_0000, 0x00_2000), // VIRT_TEST/RTC  in virt machine
        //     (0x2000000, 0x10000),     // core local interrupter (CLINT)
        //     (0xc000000, 0x210000),    // VIRT_PLIC in virt machine
        //     (0x10000000, 0x9000),     // VIRT_UART0 with GPU  in virt machine
        // ];
        for pair in crate::drivers::block::MMIO {
            memory_set.push(
                MapArea::new(
                    VPNRange::from_addr(
                        VirtualAddress::from((*pair).0),
                        VirtualAddress::from((*pair).0 + (*pair).1),
                    ),
                    MapType::Linear,
                    MapPermission::Read | MapPermission::Write,
                ),
                None,
            );
        }
        memory_set
    }

    /// 从 ELF 文件创建用户 MemorySet
    ///
    /// ## 参数
    /// * `elf` - ELF 文件数据
    /// ## 返回值
    /// 返回创建的 MemorySet、用户栈顶地址和入口点地址
    pub fn from_elf_app(elf: &[u8]) -> (Self, usize, usize) {
        let elf = ElfFile::new(elf).unwrap();
        let elf_header = elf.header;
        let elf_magic = elf_header.pt1.magic;
        assert_eq!(elf_magic, [0x7f, 0x45, 0x4c, 0x46], "invalid elf file");
        let ph_count = elf_header.pt2.ph_count();
        let mut max_end = VirtualPageNumber(0);
        let mut memory_set = MemorySet::empty();
        memory_set.map_trampoline();
        for i in 0..ph_count {
            let ph = elf.program_header(i).unwrap();
            if ph.get_type().unwrap() != xmas_elf::program::Type::Load {
                continue;
            }
            let vpn_start = VirtualAddress::from(ph.virtual_addr() as usize).floor_page();
            let vpn_end = VirtualAddress::from(ph.virtual_addr() as usize + ph.mem_size() as usize)
                .ceil_page();
            let vpn_range = VPNRange::new(vpn_start, vpn_end);
            let map_type = MapType::Framed;
            let permission = {
                let mut flags = MapPermission::User;
                if ph.flags().is_read() {
                    flags |= MapPermission::Read;
                }
                if ph.flags().is_write() {
                    flags |= MapPermission::Write;
                }
                if ph.flags().is_execute() {
                    flags |= MapPermission::Execute;
                }
                flags
            };
            let map_area = MapArea::new(vpn_range, map_type, permission);
            max_end = map_area.vpn_range.end();
            let data = Some(&elf.input[ph.offset() as usize..][..ph.file_size() as usize]);
            memory_set.push(map_area, data);
        }
        let max_end_va = VirtualAddress::from(max_end);
        let mut user_stack_bottom: usize = max_end_va.into();
        user_stack_bottom += PAGE_SIZE_SV39;
        let user_stack_top = user_stack_bottom + USER_STACK_SIZE;
        memory_set.push(
            MapArea::new(
                VPNRange::from_addr(
                    VirtualAddress::from(user_stack_bottom),
                    VirtualAddress::from(user_stack_top),
                ),
                MapType::Framed,
                MapPermission::Read | MapPermission::Write | MapPermission::User,
            ),
            None,
        );
        // used in sbrk
        // memory_set.push(
        //     MapArea::new(
        //         VPNRange::from_addr(
        //             VirtualAddress::from(user_stack_top),
        //             VirtualAddress::from(user_stack_top),
        //         ),
        //         MapType::Framed,
        //         MapPermission::Read | MapPermission::Write | MapPermission::User,
        //     ),
        //     None,
        // );
        memory_set.push(
            MapArea::new(
                VPNRange::from_addr(
                    VirtualAddress::from(TRAP_CONTEXT),
                    VirtualAddress::from(TRAMPOLINE),
                ),
                MapType::Framed,
                MapPermission::Read | MapPermission::Write,
            ),
            None,
        );
        (
            memory_set,
            user_stack_top,
            elf.header.pt2.entry_point() as usize,
        )
    }

    /// 从已存在的用户 MemorySet 创建新的 MemorySet
    ///
    /// ## 参数
    /// * `user_space` - 已存在的用户 MemorySet
    /// ## 返回值
    /// 返回新的 MemorySet
    pub fn from_existed_user(user_space: &MemorySet) -> Self {
        let mut memory_set = MemorySet::empty();
        memory_set.map_trampoline();
        for area in user_space.areas.iter() {
            let new_area = MapArea::from_another(area);
            memory_set.push(new_area, None);
            for vpn in area.vpn_range {
                let src_ppn = PhysicalPageNumber::from(&user_space.translate(vpn).unwrap());
                let dst_ppn = PhysicalPageNumber::from(&memory_set.translate(vpn).unwrap());
                dst_ppn
                    .get_bytes_array()
                    .copy_from_slice(src_ppn.get_bytes_array());
            }
        }
        memory_set
    }
}

/// 地址空间重映射测试
///
/// Copied from [rCore-Tutorial-v3/memory_set.rs/memory_set.rs](https://github.com/rcore-os/rCore-Tutorial-v3/blob/main/os/src/mm/memory_set.rs)
pub fn remap_test() {
    let kernel_space = KERNEL_SPACE.ref_cell.borrow_mut();
    let mid_text: VirtualAddress =
        ((extern_global!(__text_start) as usize + extern_global!(__text_end) as usize) / 2).into();
    let mid_rodata: VirtualAddress =
        ((extern_global!(__rodata_start) as usize + extern_global!(__rodata_end) as usize) / 2)
            .into();
    let mid_data: VirtualAddress =
        ((extern_global!(__data_start) as usize + extern_global!(__data_end) as usize) / 2).into();
    assert_eq!(
        kernel_space
            .page_table
            .translate(mid_text.floor_page().into())
            .unwrap()
            .writable(),
        false
    );
    assert_eq!(
        kernel_space
            .page_table
            .translate(mid_rodata.floor_page().into())
            .unwrap()
            .writable(),
        false,
    );
    assert_eq!(
        kernel_space
            .page_table
            .translate(mid_data.floor_page().into())
            .unwrap()
            .executable(),
        false,
    );
    trace!("[Kernel] Remap test passed");
}