axvisor 0.5.5

A lightweight type-1 hypervisor based on ArceOS
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

// Copyright 2025 The Axvisor Team
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use alloc::collections::BTreeMap;
use alloc::vec::Vec;

use spin::Mutex;

use crate::vmm::VMRef;

/// Represents a list of VMs,
/// stored in a BTreeMap where the key is the VM ID and the value is a reference to the VM.
struct VMList {
    vm_list: BTreeMap<usize, VMRef>,
}

impl VMList {
    /// Creates a new, empty `VMList`.
    const fn new() -> VMList {
        VMList {
            vm_list: BTreeMap::new(),
        }
    }

    /// Adds a new VM to the list.
    ///
    /// If a VM with the given ID already exists, a warning is logged, and the VM is not added.
    ///
    /// # Arguments
    ///
    /// * `vm_id` - The unique identifier for the VM.
    /// * `vm` - A reference to the VM that will be added.
    fn push_vm(&mut self, vm_id: usize, vm: VMRef) {
        if self.vm_list.contains_key(&vm_id) {
            warn!("VM[{vm_id}] already exists, push VM failed, just return ...");
            return;
        }
        self.vm_list.insert(vm_id, vm);
    }

    /// Removes a VM from the list by its ID.
    ///
    /// # Arguments
    ///
    /// * `vm_id` - The unique identifier of the VM to be removed.
    ///
    /// # Returns
    ///
    /// Returns `Some(VMRef)` if the VM was successfully removed, or `None` if the VM with the given ID did not exist.
    #[allow(unused)]
    fn remove_vm(&mut self, vm_id: usize) -> Option<VMRef> {
        self.vm_list.remove(&vm_id)
    }

    /// Retrieves a VM from the list by its ID.
    ///
    /// # Arguments
    ///
    /// * `vm_id` - The unique identifier of the VM to be retrieved.
    ///
    /// # Returns
    ///
    /// Returns `Some(VMRef)` if the VM exists, or `None` if the VM with the given ID does not exist.
    fn get_vm_by_id(&self, vm_id: usize) -> Option<VMRef> {
        self.vm_list.get(&vm_id).cloned()
    }
}

// A global list of VMs, protected by a mutex for thread-safe access.
static GLOBAL_VM_LIST: Mutex<VMList> = Mutex::new(VMList::new());

/// Adds a VM to the global VM list.
///
/// # Arguments
///
/// * `vm` - A reference to the VM instance.
pub fn push_vm(vm: VMRef) {
    GLOBAL_VM_LIST.lock().push_vm(vm.id(), vm)
}

/// Removes a VM from the global VM list by its ID.
///
/// # Arguments
///
/// * `vm_id` - The unique identifier of the VM to be removed.
///
/// # Returns
///
/// * `Option<VMRef>` - The removed VM reference if it exists, or `None` if not.
#[allow(unused)]
pub fn remove_vm(vm_id: usize) -> Option<VMRef> {
    GLOBAL_VM_LIST.lock().remove_vm(vm_id)
}

/// Retrieves a VM from the global VM list by its ID.
///
/// # Arguments
///
/// * `vm_id` - The unique identifier of the VM to retrieve.
///
/// # Returns
///
/// * `Option<VMRef>` - The VM reference if it exists, or `None` if not.
#[allow(unused)]
pub fn get_vm_by_id(vm_id: usize) -> Option<VMRef> {
    GLOBAL_VM_LIST.lock().get_vm_by_id(vm_id)
}

pub fn get_vm_list() -> Vec<VMRef> {
    let global_vm_list = GLOBAL_VM_LIST.lock().vm_list.clone();
    let mut vm_list = Vec::with_capacity(global_vm_list.len());
    for (_id, vm) in global_vm_list {
        vm_list.push(vm.clone());
    }
    vm_list
}