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
|
/** @file
* VM - The Virtual Machine, GVM/GVMCPU or VM/VMCPU depending on context.
*/
/*
* Copyright (C) 2019-2025 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
* in the VirtualBox distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
*/
#ifndef VBOX_INCLUDED_vmm_vmcc_h
#define VBOX_INCLUDED_vmm_vmcc_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <VBox/vmm/vm.h>
#ifdef IN_RING0
# include <VBox/vmm/gvm.h>
#else
# include <VBox/vmm/uvm.h>
#endif
/** @typedef VMCC
* Context specific VM derived structure.
* This is plain VM in ring-3 and GVM (inherits from VM) in ring-0. */
/** @typedef VMCPUCC
* Context specific VMCPU derived structure.
* This is plain VM in ring-3 and GVMCPU (inherits from VMCPU) in ring-0. */
#ifdef IN_RING0
typedef GVM VMCC;
typedef GVMCPU VMCPUCC;
#else
typedef VM VMCC;
typedef VMCPU VMCPUCC;
#endif
/** @def VMCC_GET_CPU_0
* Gets the context specfic pointer to virtual CPU \#0.
* @param a_pVM The context specfic VM structure.
*/
#ifdef IN_RING0
# define VMCC_GET_CPU_0(a_pVM) (&(a_pVM)->aCpus[0])
#else
# define VMCC_GET_CPU_0(a_pVM) ((a_pVM)->CTX_SUFF(apCpus)[0])
#endif
/** @def VMCC_GET_CPU
* Gets the context specfic pointer to a virtual CPU by index (ID).
* @param a_pVM The context specfic VM structure.
* @param a_idCpu The CPU number to get (caller ensures validity).
*/
#ifdef IN_RING0
# define VMCC_GET_CPU(a_pVM, a_idCpu) (&(a_pVM)->aCpus[(a_idCpu)])
#else
# define VMCC_GET_CPU(a_pVM, a_idCpu) ((a_pVM)->CTX_SUFF(apCpus)[(a_idCpu)])
#endif
/** @def VMCC_FOR_EACH_VMCPU
* For enumerating VCpus in ascending order, avoiding unnecessary apCpusR0
* access in ring-0, caching the CPU count and not checking for CPU \#0.
*
* Defines local variables @c idCpu, @c pVCpu and @c cCpus.
*
* @param a_pVM The VM handle.
*
* @note Close loop with VMCC_FOR_EACH_VMCPU_END.
*/
#define VMCC_FOR_EACH_VMCPU(a_pVM) \
do { \
VMCPUID idCpu = 0; \
VMCPUID const cCpus = (a_pVM)->cCpus; \
PVMCPUCC pVCpu = VMCC_GET_CPU_0(a_pVM); \
for (;;) \
{
/** @def VMCC_FOR_EACH_VMCPU_END
* Ends a VMCC_FOR_EACH_VMCPU loop.
* @param a_pVM The VM handle.
*/
#define VMCC_FOR_EACH_VMCPU_END(a_pVM) \
/* advance */ \
if (++idCpu >= cCpus) \
break; \
pVCpu = VMCC_GET_CPU(pVM, idCpu); \
} \
} while (0)
/**
* Execute the given statement for each virtual CPU in an environment with
* @c pVCpu and @c idCpu variables.
*
* @param a_pVM The VM handle.
* @param a_Stmt The statement to execute.
*/
#define VMCC_FOR_EACH_VMCPU_STMT(a_pVM, a_Stmt) VMCC_FOR_EACH_VMCPU(pVM) { a_Stmt; } VMCC_FOR_EACH_VMCPU_END(pVM)
/** @def VMCC_GET_VMR0_FOR_CALL(pVM) */
#if defined(IN_RING3)
# define VMCC_GET_VMR0_FOR_CALL(a_pVM) ((a_pVM)->pVMR0ForCall)
#elif defined(IN_RING3)
# define VMCC_GET_VMR0_FOR_CALL(a_pVM) ((a_pVM)->pVMR0)
#else
# define VMCC_GET_VMR0_FOR_CALL(a_pVM) ((a_pVM)->ring3_only_macro)
#endif
/**
* Used to pick ring-0 or ring-3 VM component data.
*
* @code{.cpp}
* pVM->VMCC_CTX(pdm).s.pfnWorker
* @endcode
*/
#ifdef IN_RING0
# define VMCC_CTX(a_Name) a_Name ## r0
#else
# define VMCC_CTX(a_Name) a_Name
#endif
#endif /* !VBOX_INCLUDED_vmm_vmcc_h */
|
