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

// Copyright 2022 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

use crate::{ok, sys, AsHandleRef, Guest, Handle, HandleBased, HandleRef, Packet, Status};

#[derive(Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
#[repr(transparent)]
pub struct Vcpu(Handle);
impl_handle_based!(Vcpu);

impl Vcpu {
    /// Create a VCPU, for use with `guest` that begins execution at `entry`.
    pub fn create(guest: &Guest, entry: usize) -> Result<Vcpu, Status> {
        unsafe {
            let mut vcpu_handle = 0;
            ok(sys::zx_vcpu_create(guest.raw_handle(), 0, entry, &mut vcpu_handle))?;
            Ok(Self::from(Handle::from_raw(vcpu_handle)))
        }
    }

    /// Enter a VCPU, causing it to resume execution.
    pub fn enter(&self) -> Result<Packet, Status> {
        let mut packet = Default::default();
        ok(unsafe { sys::zx_vcpu_enter(self.raw_handle(), &mut packet) })?;
        Ok(Packet(packet))
    }

    /// Kick a VCPU, causing it to stop execution.
    pub fn kick(&self) -> Result<(), Status> {
        ok(unsafe { sys::zx_vcpu_kick(self.raw_handle()) })
    }

    /// Raise an interrupt on a VCPU.
    pub fn interrupt(&self, vector: u32) -> Result<(), Status> {
        ok(unsafe { sys::zx_vcpu_interrupt(self.raw_handle(), vector) })
    }

    /// Read the state of a VCPU.
    pub fn read_state(&self) -> Result<sys::zx_vcpu_state_t, Status> {
        let mut state = sys::zx_vcpu_state_t::default();
        let status = unsafe {
            sys::zx_vcpu_read_state(
                self.raw_handle(),
                sys::ZX_VCPU_STATE,
                std::ptr::from_mut(&mut state).cast::<u8>(),
                std::mem::size_of_val(&state),
            )
        };
        ok(status).map(|_| state)
    }

    /// Write the state of a VCPU.
    pub fn write_state(&self, state: &sys::zx_vcpu_state_t) -> Result<(), Status> {
        let status = unsafe {
            sys::zx_vcpu_write_state(
                self.raw_handle(),
                sys::ZX_VCPU_STATE,
                std::ptr::from_ref(state).cast::<u8>(),
                std::mem::size_of_val(state),
            )
        };
        ok(status)
    }

    /// Write the result of an IO trap to a VCPU.
    pub fn write_io(&self, state: &sys::zx_vcpu_io_t) -> Result<(), Status> {
        let status = unsafe {
            sys::zx_vcpu_write_state(
                self.raw_handle(),
                sys::ZX_VCPU_IO,
                std::ptr::from_ref(state).cast::<u8>(),
                std::mem::size_of_val(state),
            )
        };
        ok(status)
    }
}

#[derive(Debug, Clone, Copy)]
pub enum VcpuContents {
    Interrupt { mask: u64, vector: u8 },
    Startup { id: u64, entry: sys::zx_gpaddr_t },
    Exit { retcode: i64 },
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::Resource;
    use fidl_fuchsia_kernel as fkernel;
    use fuchsia_component::client::connect_to_protocol;
    use zx::HandleBased;

    async fn get_hypervisor() -> Resource {
        let resource = connect_to_protocol::<fkernel::HypervisorResourceMarker>()
            .unwrap()
            .get()
            .await
            .unwrap();
        unsafe { Resource::from(Handle::from_raw(resource.into_raw())) }
    }

    #[fuchsia::test]
    async fn vcpu_normal_create() {
        let hypervisor = get_hypervisor().await;
        let (guest, _vmar) = match Guest::normal(&hypervisor) {
            Err(Status::NOT_SUPPORTED) => {
                println!("Hypervisor not supported");
                return;
            }
            result => result.unwrap(),
        };
        let _vcpu = Vcpu::create(&guest, 0).unwrap();
    }

    #[fuchsia::test]
    async fn vcpu_normal_interrupt() {
        let hypervisor = get_hypervisor().await;
        let (guest, _vmar) = match Guest::normal(&hypervisor) {
            Err(Status::NOT_SUPPORTED) => {
                println!("Hypervisor not supported");
                return;
            }
            result => result.unwrap(),
        };
        let vcpu = Vcpu::create(&guest, 0).unwrap();

        vcpu.interrupt(0).unwrap();
    }

    #[fuchsia::test]
    async fn vcpu_normal_read_write_state() {
        let hypervisor = get_hypervisor().await;
        let (guest, _vmar) = match Guest::normal(&hypervisor) {
            Err(Status::NOT_SUPPORTED) => {
                println!("Hypervisor not supported");
                return;
            }
            result => result.unwrap(),
        };
        let vcpu = Vcpu::create(&guest, 0).unwrap();

        let state = vcpu.read_state().unwrap();
        vcpu.write_state(&state).unwrap();
    }
}