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
//! Virtual machine control structure.
//!
//! Virtual machine control data structures (VMCS) are structures used by x86 during virtual machine execution.
//! VMCS stores detailed information on how a virtual machine will operate,
//! including its CPU and memory, IO configurations, interrupt handling, and other hardware settings.
//! The configuration for the VMCS in Project 2 is called "no_ept_vm." This setup does not virtualize the memory,
//! and instead directly maps guest virtual addresses to the corresponding host virtual addresses.
//!
//! ## Tasks
//! In this project, you are required to configure the guest CR3 and RIP registers.
//! The guest page table is stored at the vbsp_vcpu_state.mem.page_table.
//! Setting the guest RIP register should be set to the entry point of the guest virtual machine.
//!
//! If you implement the page table in project 1 incorrectly, even if you pass the test cases,
//! then the virtual machine will not operate properly.
//!
use crate::{
    hypercall::HypercallCtx,
    vmexit::{cpuid, hypercall, msr, pio},
};
use keos::{
    addressing::{Pa, Va, PAGE_MASK},
    mm::Page,
};
use kev::{
    vcpu::{
        segmentation::{Segment, SEGMENT_TABLE},
        table::SystemTableRegister,
        Cr0, Cr4, GenericVCpuState, Rflags, VmexitResult,
    },
    vm::{Gpa, Gva},
    vm_control::*,
    vmcs::{ActiveVmcs, Field},
    vmexits::VmexitController,
    VmError,
};
use project1::page_table::{PageTable, PageTableMappingError, Permission};

/// The Vmstate of NoEptVmState.
#[derive(Default)]
pub struct NoEptVmState {
    code: &'static [u8],
}

/// Error for setup_vbsp.
#[derive(Debug)]
pub enum Error {
    /// Error that occurs when page table mapping failed.
    PageTableMappingError(PageTableMappingError),
    /// Error that occurs when vmwrite instruction failed.
    VmError(VmError),
}

impl NoEptVmState {
    /// Create a new instance of NoEptVmState
    pub fn new(code: &'static [u8]) -> Self {
        Self { code }
    }
}

impl kev::vm::VmState for NoEptVmState {
    type VcpuState = NoEptVcpuState;
    type Error = Error;

    fn vcpu_state(&self) -> Self::VcpuState {
        let (mut pio_ctl, hypercall_ctl, cpuid_ctl, mut msr_ctl) = (
            pio::Controller::new(),
            hypercall::Controller::new(HypercallCtx),
            cpuid::Controller::new(),
            msr::Controller::new(),
        );
        pio_ctl.register(3, crate::pio::PioHandlerDummy);
        pio_ctl.register(0x3f8, crate::pio::PioHandlerPrint);
        pio_ctl.register(0xbb, crate::pio::PioHandlerQueue::new());

        assert!(msr_ctl.insert(0xabc, crate::msr::StackMsr::new()));

        NoEptVcpuState {
            mem: NoEpt {
                page_table: PageTable::new(),
            },
            vmexit_controller: (pio_ctl, (hypercall_ctl, (cpuid_ctl, msr_ctl))),
        }
    }

    fn setup_vbsp(
        &self,
        vbsp_generic_state: &mut GenericVCpuState,
        vbsp_vcpu_state: &mut Self::VcpuState,
    ) -> Result<(), Self::Error> {
        const ENTRY: Va = Va::new(0x4000).unwrap();
        const WRITABLE: Va = Va::new(0x2000).unwrap();

        // allocate a page to be written by guest
        let pg = Page::new().expect("Failed to allocate writable page");
        vbsp_vcpu_state
            .mem
            .page_table
            .map(
                WRITABLE,
                pg,
                Permission::READ | Permission::WRITE | Permission::EXECUTABLE,
            )
            .map_err(Error::PageTableMappingError)?;

        // Prepare code pages.
        let pgs = keos::mm::ContigPages::new((self.code.len() + 0xfff) & !0xfff)
            .expect("Failed to allocate code page")
            .split();
        // Copy code to page
        let (mut srcs, mut dsts) = (self.code.array_chunks::<0x1000>(), pgs.iter());
        while let Some(src) = srcs.next() {
            let dst = dsts.next().unwrap();
            unsafe {
                core::slice::from_raw_parts_mut(dst.va().into_usize() as *mut u8, 0x1000)
                    .copy_from_slice(src);
            }
        }
        unsafe {
            let src = srcs.remainder();
            core::slice::from_raw_parts_mut(
                dsts.next().unwrap().va().into_usize() as *mut u8,
                0x1000,
            )[..src.len()]
                .copy_from_slice(src);
        }

        // Map into page table.
        let mut base = ENTRY;
        for pg in pgs.into_iter() {
            vbsp_vcpu_state
                .mem
                .page_table
                .map(base, pg, Permission::READ | Permission::EXECUTABLE)
                .map_err(Error::PageTableMappingError)?;
            base = base + 0x1000;
        }
        let gdt = SystemTableRegister::new(unsafe { &SEGMENT_TABLE });
        let base = gdt.address & !(PAGE_MASK as u64);
        for va in (base..gdt.address + gdt.size as u64).step_by(0x1000) {
            let va = Va::new(va as usize).unwrap();
            unsafe {
                vbsp_vcpu_state
                    .mem
                    .page_table
                    .do_map(va, va.into_pa(), Permission::READ)
                    .map_err(Error::PageTableMappingError)?;
            }
        }
        // Run a guest on 64bit mode directly.
        let vmcs = &vbsp_generic_state.vmcs;
        vmcs.write(
            Field::GuestCsSelector,
            Segment::KernelCode.into_selector().pack() as u64,
        )
        .map_err(Error::VmError)?;
        vmcs.write(
            Field::GuestEsSelector,
            Segment::KernelData.into_selector().pack() as u64,
        )
        .map_err(Error::VmError)?;
        vmcs.write(
            Field::GuestSsSelector,
            Segment::KernelData.into_selector().pack() as u64,
        )
        .map_err(Error::VmError)?;
        vmcs.write(
            Field::GuestDsSelector,
            Segment::KernelData.into_selector().pack() as u64,
        )
        .map_err(Error::VmError)?;
        vmcs.write(
            Field::GuestFsSelector,
            Segment::KernelData.into_selector().pack() as u64,
        )
        .map_err(Error::VmError)?;
        vmcs.write(
            Field::GuestGsSelector,
            Segment::KernelData.into_selector().pack() as u64,
        )
        .map_err(Error::VmError)?;
        vmcs.write(
            Field::GuestTrSelector,
            Segment::KernelData.into_selector().pack() as u64,
        )
        .map_err(Error::VmError)?;
        vmcs.write(Field::GuestLdtrSelector, 0)
            .map_err(Error::VmError)?;

        vmcs.write(Field::GuestCsBase, 0).map_err(Error::VmError)?;
        vmcs.write(Field::GuestEsBase, 0).map_err(Error::VmError)?;
        vmcs.write(Field::GuestSsBase, 0).map_err(Error::VmError)?;
        vmcs.write(Field::GuestDsBase, 0).map_err(Error::VmError)?;
        vmcs.write(Field::GuestFsBase, 0).map_err(Error::VmError)?;
        vmcs.write(Field::GuestGsBase, 0).map_err(Error::VmError)?;
        vmcs.write(Field::GuestLdtrBase, 0)
            .map_err(Error::VmError)?;
        vmcs.write(
            Field::GuestGdtrBase,
            SystemTableRegister::new(unsafe { &SEGMENT_TABLE }).address,
        )
        .map_err(Error::VmError)?;
        vmcs.write(Field::GuestIdtrBase, 0)
            .map_err(Error::VmError)?;
        vmcs.write(Field::GuestTrBase, 0).map_err(Error::VmError)?;

        vmcs.write(Field::GuestCsLimit, u64::MAX)
            .map_err(Error::VmError)?;
        vmcs.write(Field::GuestEsLimit, u64::MAX)
            .map_err(Error::VmError)?;
        vmcs.write(Field::GuestSsLimit, u64::MAX)
            .map_err(Error::VmError)?;
        vmcs.write(Field::GuestDsLimit, u64::MAX)
            .map_err(Error::VmError)?;
        vmcs.write(Field::GuestFsLimit, u64::MAX)
            .map_err(Error::VmError)?;
        vmcs.write(Field::GuestGsLimit, u64::MAX)
            .map_err(Error::VmError)?;
        vmcs.write(Field::GuestLdtrLimit, 0xffff)
            .map_err(Error::VmError)?;
        vmcs.write(Field::GuestGdtrLimit, 0xffff)
            .map_err(Error::VmError)?;
        vmcs.write(Field::GuestIdtrLimit, 0xffff)
            .map_err(Error::VmError)?;
        vmcs.write(Field::GuestTrLimit, 0x67)
            .map_err(Error::VmError)?;

        vmcs.write(Field::GuestCsAccessRights, 0xa09b)
            .map_err(Error::VmError)?;
        vmcs.write(Field::GuestEsAccessRights, 0xc093)
            .map_err(Error::VmError)?;
        vmcs.write(Field::GuestSsAccessRights, 0xc093)
            .map_err(Error::VmError)?;
        vmcs.write(Field::GuestDsAccessRights, 0xc093)
            .map_err(Error::VmError)?;
        vmcs.write(Field::GuestFsAccessRights, 0xc093)
            .map_err(Error::VmError)?;
        vmcs.write(Field::GuestGsAccessRights, 0xc093)
            .map_err(Error::VmError)?;
        vmcs.write(Field::GuestTrAccessRights, 0x8b)
            .map_err(Error::VmError)?;
        vmcs.write(Field::GuestLdtrAccessRights, 0x10000)
            .map_err(Error::VmError)?;

        vmcs.write(Field::GuestActivityState, 0)
            .map_err(Error::VmError)?;
        vmcs.write(Field::GuestInterruptibilityState, 0)
            .map_err(Error::VmError)?;

        vmcs.write(Field::GuestCr0, Cr0::current().bits())
            .map_err(Error::VmError)?;
        vmcs.write(Field::GuestCr4, Cr4::current().bits())
            .map_err(Error::VmError)?;
        vmcs.write(Field::GuestIa32Efer, 0x500)
            .map_err(Error::VmError)?;

        vmcs.write(Field::GuestLinkPointer, 0xffff_ffff)
            .map_err(Error::VmError)?;
        vmcs.write(Field::GuestLinkPointerHi, 0xffff_ffff)
            .map_err(Error::VmError)?;

        vmcs.write(Field::GuestDr7, 0).map_err(Error::VmError)?;
        vmcs.write(Field::GuestIa32Debugctl, 0)
            .map_err(Error::VmError)?;

        vmcs.write(Field::GuestRflags, Rflags::_1.bits())
            .map_err(Error::VmError)?;

        // Setup guest Cr3, and Guest Rip to `ENTRY`.
        todo!();
        Ok(())
    }
}

struct NoEpt {
    page_table: PageTable,
}
impl kev::Probe for NoEpt {
    fn gpa2hpa(&self, _vmcs: &ActiveVmcs, _gpa: Gpa) -> Option<Pa> {
        // Because the term `gpa` is not existed when ept is not existed, we cannot be reachable here.
        unreachable!()
    }
    fn gva2hpa(&self, _vmcs: &ActiveVmcs, gva: Gva) -> Option<Pa> {
        // In this type of VM, gva is same as hva.
        let (va, ofs) = {
            let gva = unsafe { gva.into_usize() };
            (Va::new(gva & !PAGE_MASK)?, gva & PAGE_MASK)
        };
        self.page_table
            .walk(va)
            .map(|pte| pte.pa())
            .ok()?
            .map(|pa| pa + ofs)
    }
}

/// The Vcpu state of NoEptVmState.
pub struct NoEptVcpuState {
    mem: NoEpt,
    vmexit_controller: (
        pio::Controller,
        (
            hypercall::Controller<crate::hypercall::HypercallCtx>,
            (cpuid::Controller, msr::Controller),
        ),
    ),
}

impl kev::vcpu::VCpuState for NoEptVcpuState {
    fn pinbase_ctls(&self) -> VmcsPinBasedVmexecCtl {
        VmcsPinBasedVmexecCtl::EXTERNAL_INTERRUPT_EXITING
    }
    fn procbase_ctls(&self) -> VmcsProcBasedVmexecCtl {
        VmcsProcBasedVmexecCtl::HLT_EXITING
            | VmcsProcBasedVmexecCtl::CR3LOADEXIT
            | VmcsProcBasedVmexecCtl::UNCONDIOEXIT
    }
    fn procbase_ctls2(&self) -> VmcsProcBasedSecondaryVmexecCtl {
        VmcsProcBasedSecondaryVmexecCtl::ENABLE_RDTSCP
    }
    fn entry_ctls(&self) -> VmcsEntryCtl {
        VmcsEntryCtl::IA32E_MODE_GUEST | VmcsEntryCtl::LOAD_IA32_EFER
    }
    fn exit_ctls(&self) -> VmcsExitCtl {
        VmcsExitCtl::HOST_ADDRESS_SPACE_SIZE | VmcsExitCtl::ACK_INTR_ON_EXIT
    }
    fn init_guest_state(&self, _vmcs: &ActiveVmcs) -> Result<(), VmError> {
        Ok(())
    }

    fn handle_vmexit(
        &mut self,
        generic_vcpu_state: &mut GenericVCpuState,
    ) -> Result<VmexitResult, VmError> {
        // Hint: Use Vmcs.
        let exit_reason = generic_vcpu_state
            .vmcs
            .exit_reason()
            .expect("unexpected vmexit.");
        let Self {
            mem,
            vmexit_controller,
        } = self;
        vmexit_controller.handle(exit_reason, mem, generic_vcpu_state)
    }
}