ahrightos-kernel 0.1.0

RISC-V 64 Rust teaching kernel for AhRightOS.
Documentation
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
/*
 * ============================================
 * RISC-V 页表管理模块
 * ============================================
 * 功能:页表遍历、映射、取消映射
 *
 * 教学特色:
 * - 详细的过程日志输出
 * - 每一步都可视化
 * - 便于理解 Sv39 三级页表机制
 * ============================================
 */

use super::{PageTable, PageTableEntry, PageTableFlags, PhysAddr, SimpleFrameAllocator, VirtAddr};

/// 遍历页表,将虚拟地址转换为物理地址
///
/// # 参数
/// - `root_paddr`: 根页表的物理地址
/// - `vaddr`: 要转换的虚拟地址
///
/// # 返回
/// - Some(PhysAddr): 转换成功
/// - None: 页面未映射
///
/// # 教学说明
/// RISC-V Sv39 使用三级页表:
/// - Level 2: VPN[2] (bits 38-30)
/// - Level 1: VPN[1] (bits 29-21)
/// - Level 0: VPN[0] (bits 20-12)
/// - Offset: bits 11-0
pub fn walk_page_table(root_paddr: PhysAddr, vaddr: VirtAddr) -> Option<PhysAddr> {
    // 获取根页表指针
    let root_table = unsafe { &*(root_paddr.as_usize() as *const PageTable) };

    // Level 2: VPN[2]
    let vpn2 = vaddr.vpn2();
    let pte2 = root_table.get_entry(vpn2);

    if !pte2.is_valid() {
        return None; // 页面未映射
    }

    if pte2.is_leaf() {
        // Huge page (1GB)
        let offset = vaddr.as_usize() & 0x3FFF_FFFF;
        return Some(PhysAddr::new(pte2.phys_addr().as_usize() + offset));
    }

    // Level 1: VPN[1]
    let table1 = unsafe { &*(pte2.phys_addr().as_usize() as *const PageTable) };
    let vpn1 = vaddr.vpn1();
    let pte1 = table1.get_entry(vpn1);

    if !pte1.is_valid() {
        return None;
    }

    if pte1.is_leaf() {
        // Large page (2MB)
        let offset = vaddr.as_usize() & 0x1F_FFFF;
        return Some(PhysAddr::new(pte1.phys_addr().as_usize() + offset));
    }

    // Level 0: VPN[0]
    let table0 = unsafe { &*(pte1.phys_addr().as_usize() as *const PageTable) };
    let vpn0 = vaddr.vpn0();
    let pte0 = table0.get_entry(vpn0);

    if !pte0.is_valid() {
        return None;
    }

    // 4KB page
    let offset = vaddr.page_offset();
    Some(PhysAddr::new(pte0.phys_addr().as_usize() + offset))
}

/// 可视化页表遍历(教学版本,带详细输出)
///
/// # 教学特色
/// 这个函数会打印每一步的查找过程,帮助理解页表遍历
pub fn walk_page_table_verbose(root_paddr: PhysAddr, vaddr: VirtAddr) -> Option<PhysAddr> {
    crate::serial_println!("\n╔════════════════════════════════════════╗");
    crate::serial_println!("║     页表遍历过程(Sv39)              ║");
    crate::serial_println!("╠════════════════════════════════════════╣");
    crate::serial_println!("║ 虚拟地址: {:#018x}            ║", vaddr.as_usize());
    crate::serial_println!("║ 根页表:   {:#018x}            ║", root_paddr.as_usize());
    crate::serial_println!("╚════════════════════════════════════════╝");

    // VPN 分解
    let vpn2 = vaddr.vpn2();
    let vpn1 = vaddr.vpn1();
    let vpn0 = vaddr.vpn0();
    let offset = vaddr.page_offset();

    crate::serial_println!("\n[1] 虚拟地址分解:");
    crate::serial_println!("    VPN[2] = {:3} (bits 38-30)", vpn2);
    crate::serial_println!("    VPN[1] = {:3} (bits 29-21)", vpn1);
    crate::serial_println!("    VPN[0] = {:3} (bits 20-12)", vpn0);
    crate::serial_println!("    Offset = {:#05x} (bits 11-0)", offset);

    let root_table = unsafe { &*(root_paddr.as_usize() as *const PageTable) };

    // Level 2
    crate::serial_println!("\n[2] Level 2 查找 (VPN[2] = {}):", vpn2);
    let pte2 = root_table.get_entry(vpn2);

    if !pte2.is_valid() {
        crate::serial_println!("    ✗ 页表项无效 (V=0)");
        return None;
    }

    crate::serial_println!("    ✓ 页表项有效");
    crate::serial_println!("    PPN = {:#x}", pte2.ppn());
    crate::serial_println!("    Flags = {:#04x}", pte2.flags());

    if pte2.is_leaf() {
        crate::serial_println!("    → 这是一个 1GB 大页");
        let paddr = PhysAddr::new(pte2.phys_addr().as_usize() + (vaddr.as_usize() & 0x3FFF_FFFF));
        crate::serial_println!(
            "\n✓ 转换完成: {:#x} → {:#x}\n",
            vaddr.as_usize(),
            paddr.as_usize()
        );
        return Some(paddr);
    }

    crate::serial_println!("    → 指向下一级页表");

    // Level 1
    let table1_paddr = pte2.phys_addr();
    crate::serial_println!("\n[3] Level 1 查找 (VPN[1] = {}):", vpn1);
    crate::serial_println!("    页表地址: {:#x}", table1_paddr.as_usize());

    let table1 = unsafe { &*(table1_paddr.as_usize() as *const PageTable) };
    let pte1 = table1.get_entry(vpn1);

    if !pte1.is_valid() {
        crate::serial_println!("    ✗ 页表项无效 (V=0)");
        return None;
    }

    crate::serial_println!("    ✓ 页表项有效");
    crate::serial_println!("    PPN = {:#x}", pte1.ppn());
    crate::serial_println!("    Flags = {:#04x}", pte1.flags());

    if pte1.is_leaf() {
        crate::serial_println!("    → 这是一个 2MB 大页");
        let paddr = PhysAddr::new(pte1.phys_addr().as_usize() + (vaddr.as_usize() & 0x1F_FFFF));
        crate::serial_println!(
            "\n✓ 转换完成: {:#x} → {:#x}\n",
            vaddr.as_usize(),
            paddr.as_usize()
        );
        return Some(paddr);
    }

    crate::serial_println!("    → 指向下一级页表");

    // Level 0
    let table0_paddr = pte1.phys_addr();
    crate::serial_println!("\n[4] Level 0 查找 (VPN[0] = {}):", vpn0);
    crate::serial_println!("    页表地址: {:#x}", table0_paddr.as_usize());

    let table0 = unsafe { &*(table0_paddr.as_usize() as *const PageTable) };
    let pte0 = table0.get_entry(vpn0);

    if !pte0.is_valid() {
        crate::serial_println!("    ✗ 页表项无效 (V=0)");
        return None;
    }

    crate::serial_println!("    ✓ 页表项有效 (4KB 页)");
    crate::serial_println!("    PPN = {:#x}", pte0.ppn());
    crate::serial_println!("    Flags = {:#04x}", pte0.flags());

    let paddr = PhysAddr::new(pte0.phys_addr().as_usize() + offset);
    crate::serial_println!("\n[5] 最终物理地址:");
    crate::serial_println!("    物理页帧: {:#x}", pte0.phys_addr().as_usize());
    crate::serial_println!("    页内偏移: {:#x}", offset);
    crate::serial_println!("    物理地址: {:#x}", paddr.as_usize());

    crate::serial_println!(
        "\n✓ 转换完成: {:#x} → {:#x}\n",
        vaddr.as_usize(),
        paddr.as_usize()
    );

    Some(paddr)
}

/// 映射单个页面
///
/// # 参数
/// - `root_table`: 根页表(可变引用)
/// - `vaddr`: 虚拟地址
/// - `paddr`: 物理地址
/// - `flags`: 页表标志位
/// - `allocator`: 帧分配器(用于分配中间页表)
///
/// # 教学说明
/// 这个函数会自动分配中间页表(如果需要)
pub fn map_page(
    root_table: &mut PageTable,
    vaddr: VirtAddr,
    paddr: PhysAddr,
    flags: usize,
    allocator: &mut SimpleFrameAllocator,
) -> Result<(), &'static str> {
    // Level 2
    let vpn2 = vaddr.vpn2();
    let pte2 = root_table.get_entry_mut(vpn2);

    // Intermediate PTEs point to the next page-table level. Access
    // permissions, including User, belong only on the final leaf PTE.
    let intermediate_flags = PageTableFlags::Valid as usize;

    let table1 = if !pte2.is_valid() {
        let frame = allocator.allocate().ok_or("Out of memory")?;
        let table1_paddr = frame.start_address();

        pte2.set(table1_paddr.as_usize() >> 12, intermediate_flags);

        let table1 = unsafe { &mut *(table1_paddr.as_usize() as *mut PageTable) };
        table1.zero();
        table1
    } else {
        unsafe { &mut *(pte2.phys_addr().as_usize() as *mut PageTable) }
    };

    // Level 1
    let vpn1 = vaddr.vpn1();
    let pte1 = table1.get_entry_mut(vpn1);

    let table0 = if !pte1.is_valid() {
        let frame = allocator.allocate().ok_or("Out of memory")?;
        let table0_paddr = frame.start_address();

        pte1.set(table0_paddr.as_usize() >> 12, intermediate_flags);

        let table0 = unsafe { &mut *(table0_paddr.as_usize() as *mut PageTable) };
        table0.zero();
        table0
    } else {
        unsafe { &mut *(pte1.phys_addr().as_usize() as *mut PageTable) }
    };

    // Level 0 - 设置最终映射
    let vpn0 = vaddr.vpn0();
    let pte0 = table0.get_entry_mut(vpn0);

    if pte0.is_valid() {
        return Err("Page already mapped");
    }

    // 设置叶子页表项
    pte0.set(
        paddr.as_usize() >> 12,
        flags | PageTableFlags::Valid as usize,
    );

    // 刷新 TLB
    unsafe {
        core::arch::asm!(
            "sfence.vma {0}, zero",
            in(reg) vaddr.as_usize(),
        );
    }

    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::memory::{PageTableFlags, PAGE_SIZE};

    #[test_case]
    fn user_mapping_keeps_intermediate_ptes_permissionless() {
        let mut allocator = crate::memory::SimpleFrameAllocator::new(0x8060_0000, 0x8070_0000);
        let root_frame = allocator.allocate().expect("root page table");
        let root = unsafe { &mut *(root_frame.start_address().as_usize() as *mut PageTable) };
        root.zero();

        let user_vaddr = VirtAddr::new(0x10078);
        let user_page = VirtAddr::new(user_vaddr.as_usize() & !(PAGE_SIZE - 1));
        let user_frame = allocator.allocate().expect("user frame");
        let leaf_flags = PageTableFlags::Read as usize
            | PageTableFlags::Execute as usize
            | PageTableFlags::User as usize;

        map_page(
            root,
            user_page,
            user_frame.start_address(),
            leaf_flags,
            &mut allocator,
        )
        .expect("map user page");

        let pte2 = root.get_entry(user_vaddr.vpn2());
        assert!(pte2.is_valid());
        assert!(!pte2.is_leaf());
        assert_eq!(pte2.flags(), PageTableFlags::Valid as usize);

        let table1 = unsafe { &*(pte2.phys_addr().as_usize() as *const PageTable) };
        let pte1 = table1.get_entry(user_vaddr.vpn1());
        assert!(pte1.is_valid());
        assert!(!pte1.is_leaf());
        assert_eq!(pte1.flags(), PageTableFlags::Valid as usize);

        let table0 = unsafe { &*(pte1.phys_addr().as_usize() as *const PageTable) };
        let pte0 = table0.get_entry(user_vaddr.vpn0());
        assert!(pte0.is_valid());
        assert!(pte0.is_leaf());
        assert_ne!(pte0.flags() & PageTableFlags::User as usize, 0);
        assert_ne!(pte0.flags() & PageTableFlags::Execute as usize, 0);
    }
}

/// 可视化页面映射(教学版本)
pub fn map_page_verbose(
    root_table: &mut PageTable,
    vaddr: VirtAddr,
    paddr: PhysAddr,
    flags: usize,
    allocator: &mut SimpleFrameAllocator,
) -> Result<(), &'static str> {
    crate::serial_println!("\n╔════════════════════════════════════════╗");
    crate::serial_println!("║        页面映射过程                    ║");
    crate::serial_println!("╠════════════════════════════════════════╣");
    crate::serial_println!("║ 虚拟地址: {:#018x}            ║", vaddr.as_usize());
    crate::serial_println!("║ 物理地址: {:#018x}            ║", paddr.as_usize());
    crate::serial_println!("║ 标志位:   {:#010x}                ║", flags);
    crate::serial_println!("╚════════════════════════════════════════╝");

    let result = map_page(root_table, vaddr, paddr, flags, allocator);

    if result.is_ok() {
        crate::serial_println!("✓ 映射成功!\n");
    } else {
        crate::serial_println!("✗ 映射失败: {:?}\n", result);
    }

    result
}

/// 取消页面映射
///
/// # 返回
/// - Ok(PhysAddr): 原来映射的物理地址
/// - Err: 页面未映射
pub fn unmap_page(root_table: &mut PageTable, vaddr: VirtAddr) -> Result<PhysAddr, &'static str> {
    // 遍历页表找到最后一级
    let vpn2 = vaddr.vpn2();
    let pte2 = root_table.get_entry_mut(vpn2);

    if !pte2.is_valid() {
        return Err("Page not mapped");
    }

    let table1 = unsafe { &mut *(pte2.phys_addr().as_usize() as *mut PageTable) };

    let vpn1 = vaddr.vpn1();
    let pte1 = table1.get_entry_mut(vpn1);

    if !pte1.is_valid() {
        return Err("Page not mapped");
    }

    let table0 = unsafe { &mut *(pte1.phys_addr().as_usize() as *mut PageTable) };

    let vpn0 = vaddr.vpn0();
    let pte0 = table0.get_entry_mut(vpn0);

    if !pte0.is_valid() {
        return Err("Page not mapped");
    }

    let paddr = pte0.phys_addr();

    // 清除页表项
    *pte0 = PageTableEntry::new();

    // 刷新 TLB
    unsafe {
        core::arch::asm!(
            "sfence.vma {0}, zero",
            in(reg) vaddr.as_usize(),
        );
    }

    Ok(paddr)
}

/// 简化的地址转换(从当前页表)
pub fn translate_addr(vaddr: VirtAddr) -> Option<PhysAddr> {
    use riscv::register::satp;

    // 读取 satp 获取根页表地址
    let satp_value = satp::read();
    let root_ppn = satp_value.ppn();
    let root_paddr = PhysAddr::new(root_ppn << 12);

    walk_page_table(root_paddr, vaddr)
}