someboot 0.4.0

Sparreal OS kernel
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

use core::{arch::naked_asm, mem::offset_of};

use crate::{entry::PrimaryCpuInitInfo, smp::PerCpuMeta};

const RISCV_LINUX_IMAGE_TEXT_OFFSET: usize = 0x20_0000;
const RISCV_LINUX_IMAGE_FLAGS: usize = 0;
const RISCV_LINUX_IMAGE_VERSION: usize = 0x0000_0002;
const RISCV_LINUX_IMAGE_MAGIC: usize = 0x0056_4353_4952;
const RISCV_LINUX_IMAGE_MAGIC2: usize = 0x0543_5352;

#[unsafe(naked)]
#[unsafe(no_mangle)]
#[unsafe(link_section = ".head.text")]
pub unsafe extern "C" fn _head() -> ! {
    naked_asm!(
        ".option push",
        ".option norvc",
        ".option norelax",
        // The RISC-V Image header reserves exactly 8 bytes for code0/code1.
        "2: auipc t0, %pcrel_hi({kernel_entry})",
        "jalr zero, %pcrel_lo(2b)(t0)",
        ".option pop",
        // text_offset
        ".quad {text_offset}",
        // image_size
        ".quad __kernel_load_end - _head",
        // flags
        ".quad {flags}",
        // version + reserved
        ".word {version}",
        ".word 0",
        // reserved
        ".quad 0",
        // magic + magic2 + reserved
        ".quad {magic}",
        ".word {magic2}",
        ".word 0",
        kernel_entry = sym kernel_entry,
        text_offset = const RISCV_LINUX_IMAGE_TEXT_OFFSET,
        flags = const RISCV_LINUX_IMAGE_FLAGS,
        version = const RISCV_LINUX_IMAGE_VERSION,
        magic = const RISCV_LINUX_IMAGE_MAGIC,
        magic2 = const RISCV_LINUX_IMAGE_MAGIC2,
    )
}

#[unsafe(naked)]
pub unsafe extern "C" fn kernel_entry(_hart_id: usize, _fdt_addr: usize) -> ! {
    naked_asm!(
        ".option push",
        ".option norelax",
        "lla gp, __global_pointer$",
        ".option pop",
        "mv t2, a1",
        "lla sp, __cpu0_stack_top",
        "addi sp, sp, -{boot_info_stack_size}",
        "li t0, {abi_magic}",
        "sw t0, {abi_magic_offset}(sp)",
        "li t0, {abi_version}",
        "sh t0, {abi_version_offset}(sp)",
        "li t0, {record_size}",
        "sh t0, {record_size_offset}(sp)",
        "sd a0, {hart_id_offset}(sp)",
        "sd zero, {cpu_meta_paddr_offset}(sp)",
        "sd zero, {early_trap_cause_offset}(sp)",
        "sd zero, {early_trap_pc_offset}(sp)",
        "sd zero, {early_trap_value_offset}(sp)",
        "csrw sscratch, sp",
        "mv tp, zero",
        "mv a0, t2",
        "lla t1, {primary_head_entry}",
        "jr t1",
        primary_head_entry = sym primary_head_entry,
        abi_magic = const super::boot::ABI_MAGIC_VALUE,
        abi_version = const super::boot::ABI_VERSION_VALUE,
        record_size = const super::boot::RECORD_SIZE,
        boot_info_stack_size = const super::boot::STACK_SIZE,
        abi_magic_offset = const super::boot::ABI_MAGIC_OFFSET,
        abi_version_offset = const super::boot::ABI_VERSION_OFFSET,
        record_size_offset = const super::boot::RECORD_SIZE_OFFSET,
        hart_id_offset = const super::boot::HART_ID_OFFSET,
        cpu_meta_paddr_offset = const super::boot::CPU_META_PADDR_OFFSET,
        early_trap_cause_offset = const super::boot::EARLY_TRAP_CAUSE_OFFSET,
        early_trap_pc_offset = const super::boot::EARLY_TRAP_PC_OFFSET,
        early_trap_value_offset = const super::boot::EARLY_TRAP_VALUE_OFFSET,
    )
}

fn primary_head_entry(fdt_addr: usize) -> ! {
    super::relocate::apply();
    primary_entry(fdt_addr)
}

fn primary_entry(fdt_addr: usize) -> ! {
    clear_bss();
    early_trap_init();
    unsafe {
        crate::fdt::FDT_ADDR = fdt_addr;
    }

    <<super::Arch as crate::ArchTrait>::Console as crate::console::ArchConsoleOps>::init();
    println!("RISC-V64 SBI kernel entry.");

    let kernel_code_start_lma = ext_sym_addr!(_head);
    let kernel_code_end_lma = ext_sym_addr!(__kernel_code_end);

    crate::entry::primary_init_early(PrimaryCpuInitInfo {
        kernel_start: kernel_code_start_lma.into(),
        kernel_end: kernel_code_end_lma.into(),
        kernel_start_link: crate::consts::VM_LOAD_ADDRESS.into(),
    });
    super::paging::enable_mmu()
}

/// Re-establishes the standard global pointer after entering the high virtual
/// mapping, before any shared Rust code observes the new address space.
///
/// # Safety
///
/// The caller must jump here only after mapping this function and
/// `__global_pointer$` at their linked virtual addresses and installing a
/// valid virtual kernel stack.
#[unsafe(naked)]
pub(crate) unsafe extern "C" fn mmu_entry() -> ! {
    naked_asm!(
        ".option push",
        ".option norelax",
        "lla gp, __global_pointer$",
        ".option pop",
        "lla t0, {mmu_entry_rust}",
        "jr t0",
        mmu_entry_rust = sym mmu_entry_rust,
    )
}

fn mmu_entry_rust() -> ! {
    super::relocate::reset();
    super::trap::setup();
    crate::prime_entry()
}

/// Re-establishes `gp` on the secondary CPU's high virtual mapping and then
/// tail-calls the shared secondary entry in `a1` with its metadata argument
/// recovered from the boot record in `a0`.
///
/// # Safety
///
/// The caller must provide mapped linked addresses, a valid virtual kernel
/// stack, the mapped boot record in `a0`, and the shared entry address in `a1`.
#[unsafe(naked)]
pub(crate) unsafe extern "C" fn secondary_mmu_entry(
    _cpu_boot_info_paddr: usize,
    _entry: usize,
) -> ! {
    naked_asm!(
        ".option push",
        ".option norelax",
        "lla gp, __global_pointer$",
        ".option pop",
        "ld a0, {cpu_meta_offset}(a0)",
        "jr a1",
        cpu_meta_offset = const super::boot::CPU_META_PADDR_OFFSET,
    )
}

unsafe extern "C" {
    fn __kernel_code_end();
    fn __bss_start();
    fn __bss_stop();
    fn __cpu0_stack();
    fn __cpu0_stack_top();
}

#[unsafe(naked)]
unsafe extern "C" fn secondary_early_trap() -> ! {
    naked_asm!(
        "csrr t3, sscratch",
        "csrr t0, scause",
        "csrr t1, sepc",
        "csrr t2, stval",
        "sd t0, {early_trap_cause_offset}(t3)",
        "sd t1, {early_trap_pc_offset}(t3)",
        "sd t2, {early_trap_value_offset}(t3)",
        "1:",
        "j 1b",
        early_trap_cause_offset = const super::boot::EARLY_TRAP_CAUSE_OFFSET,
        early_trap_pc_offset = const super::boot::EARLY_TRAP_PC_OFFSET,
        early_trap_value_offset = const super::boot::EARLY_TRAP_VALUE_OFFSET,
    )
}

#[unsafe(naked)]
pub(crate) unsafe extern "C" fn _secondary_entry(_hartid: usize, _cpu_meta_paddr: usize) -> ! {
    naked_asm!(
        "csrci sstatus, 2",
        "csrw sie, zero",
        ".option push",
        ".option norelax",
        "lla gp, __global_pointer$",
        ".option pop",
        "mv t2, a1",
        "ld sp, {stack_top_offset}(t2)",
        "addi sp, sp, -{boot_info_stack_size}",
        "li t0, {abi_magic}",
        "sw t0, {abi_magic_offset}(sp)",
        "li t0, {abi_version}",
        "sh t0, {abi_version_offset}(sp)",
        "li t0, {record_size}",
        "sh t0, {record_size_offset}(sp)",
        "sd a0, {hart_id_offset}(sp)",
        "sd t2, {cpu_meta_paddr_offset}(sp)",
        "sd zero, {early_trap_cause_offset}(sp)",
        "sd zero, {early_trap_pc_offset}(sp)",
        "sd zero, {early_trap_value_offset}(sp)",
        "csrw sscratch, sp",
        "lla t0, {secondary_early_trap}",
        "csrw stvec, t0",
        "mv tp, zero",
        "mv a0, sp",
        "lla t1, {secondary_start}",
        "jr t1",
        secondary_start = sym secondary_start,
        secondary_early_trap = sym secondary_early_trap,
        stack_top_offset = const offset_of!(PerCpuMeta, stack_top),
        abi_magic = const super::boot::ABI_MAGIC_VALUE,
        abi_version = const super::boot::ABI_VERSION_VALUE,
        record_size = const super::boot::RECORD_SIZE,
        boot_info_stack_size = const super::boot::STACK_SIZE,
        abi_magic_offset = const super::boot::ABI_MAGIC_OFFSET,
        abi_version_offset = const super::boot::ABI_VERSION_OFFSET,
        record_size_offset = const super::boot::RECORD_SIZE_OFFSET,
        hart_id_offset = const super::boot::HART_ID_OFFSET,
        cpu_meta_paddr_offset = const super::boot::CPU_META_PADDR_OFFSET,
        early_trap_cause_offset = const super::boot::EARLY_TRAP_CAUSE_OFFSET,
        early_trap_pc_offset = const super::boot::EARLY_TRAP_PC_OFFSET,
        early_trap_value_offset = const super::boot::EARLY_TRAP_VALUE_OFFSET,
    )
}

fn secondary_start(cpu_boot_info_paddr: usize) -> ! {
    super::paging::enable_mmu_secondary(cpu_boot_info_paddr)
}

fn clear_bss() {
    let start = __bss_start as *const () as usize;
    let end = __bss_stop as *const () as usize;
    let stack_start = __cpu0_stack as *const () as usize;
    let stack_end = __cpu0_stack_top as *const () as usize;

    clear_bss_range(start, stack_start.min(end));
    clear_bss_range(stack_end.max(start), end);
}

fn clear_bss_range(start: usize, end: usize) {
    if end <= start {
        return;
    }

    unsafe {
        core::ptr::write_bytes(start as *mut u8, 0, end - start);
    }
}

fn early_trap_init() {
    super::disable_local_irqs();
    let _ = super::sbi::set_timer(u64::MAX);

    if crate::consts::VM_LOAD_ADDRESS == crate::consts::KERNEL_LOAD_ADDRESS {
        super::trap::setup();
    }
}