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
|
/*********************************************************
* Copyright (C) 2000-2012 VMware, Inc. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation version 2.1 and no later version.
*
* 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 Lesser GNU General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
*********************************************************/
/*********************************************************
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
*********************************************************/
/*********************************************************
* The contents of this file are subject to the terms of the Common
* Development and Distribution License (the "License") version 1.0
* and no later version. You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* http://www.opensource.org/licenses/cddl1.php
*
* See the License for the specific language governing permissions
* and limitations under the License.
*
*********************************************************/
/*
* balloon_def.h --
*
* Definitions for server "balloon" mechanism for reclaiming
* physical memory from a VM.
*/
#ifndef _BALLOON_DEF_H
#define _BALLOON_DEF_H
#define INCLUDE_ALLOW_VMX
#define INCLUDE_ALLOW_VMCORE
#define INCLUDE_ALLOW_VMKERNEL
#define INCLUDE_ALLOW_MODULE
#include "includeCheck.h"
#include "vm_basic_types.h"
#include "vm_basic_defs.h"
#include "vm_assert.h"
/*
* constants
*/
/* backdoor port */
#define BALLOON_BDOOR_PORT (0x5670)
#define BALLOON_BDOOR_MAGIC (0x456c6d6f)
/*
* Backdoor commands availability:
*
* +====================+======================+
* | CMD | Capabilities |
* +--------------------+----------------------+
* | START | Always available (*) |
* | TARGET | Always available |
* | LOCK | BASIC_CMDS |
* | UNLOCK | BASIC_CMDS |
* | GUEST_ID | Always available |
* | BATCHED_LOCK | BATCHED_CMDS |
* | BATCHED_UNLOCK | BATCHED_CMDS |
* +====================+======================+
*
* (*) The START command has been slightly modified when more than the
* basic commands are available: It returns
* BALLOON_SUCCESS_WITH_CAPABILITIES with the available capabilities
* stored in %ecx. Previously, a versioned protocol was used, and the
* protocol that should be used was also returned in %ecx. Protocol
* version 2 was the initial version and the only one shipped. Version 3
* was temporary used internally but has caused several issue due to
* protocol mismatch between monitor and guest.
*
*/
/* backdoor command numbers */
#define BALLOON_BDOOR_CMD_START (0)
#define BALLOON_BDOOR_CMD_TARGET (1)
#define BALLOON_BDOOR_CMD_LOCK (2)
#define BALLOON_BDOOR_CMD_UNLOCK (3)
#define BALLOON_BDOOR_CMD_GUEST_ID (4)
/* The command 5 was shortly used between 1881144 and 1901153. */
#define BALLOON_BDOOR_CMD_BATCHED_LOCK (6)
#define BALLOON_BDOOR_CMD_BATCHED_UNLOCK (7)
/* balloon capabilities */
typedef enum {
/*
* Bit 0 is not used and shouldn't be used, due to issue with
* protocol v3, to avoid ambiguity between protocol v3 and
* capabilities, leave this bit as 0. That way, by masking guest
* capabilities with monitor capabilities, bit 0 will always be set
* to 0, and buggy v3 tool will automatically switch to unbatched
* LOCK and UNLOCK.
*/
BALLOON_BASIC_CMDS = (1 << 1),
BALLOON_BATCHED_CMDS = (1 << 2)
} BalloonCapabilities;
/* use config value for max balloon size */
#define BALLOON_MAX_SIZE_USE_CONFIG (0)
/*
* Guest identities
*
* Note : all values should fit in 32 bits
*/
typedef enum {
BALLOON_GUEST_UNKNOWN = 0,
BALLOON_GUEST_LINUX = 1,
BALLOON_GUEST_BSD = 2,
BALLOON_GUEST_WINDOWS_NT4 = 3,
BALLOON_GUEST_WINDOWS_NT5 = 4,
BALLOON_GUEST_SOLARIS = 5,
BALLOON_GUEST_MACOS = 6,
BALLOON_GUEST_FROBOS = 7,
} BalloonGuest;
/* error codes */
#define BALLOON_SUCCESS (0)
#define BALLOON_FAILURE (-1)
#define BALLOON_ERROR_CMD_INVALID (1)
#define BALLOON_ERROR_PPN_INVALID (2)
#define BALLOON_ERROR_PPN_LOCKED (3)
#define BALLOON_ERROR_PPN_UNLOCKED (4)
#define BALLOON_ERROR_PPN_PINNED (5)
#define BALLOON_ERROR_PPN_NOTNEEDED (6)
#define BALLOON_ERROR_RESET (7)
#define BALLOON_ERROR_BUSY (8)
#define BALLOON_SUCCESS_WITH_CAPABILITIES (0x03000000)
/*
* BatchPage.
*/
#define BALLOON_BATCH_MAX_PAGES (PAGE_SIZE / sizeof(PA64))
/*
* We are using the fact that for 4k pages, the 12LSB are set to 0, so
* we can use them and mask those bit when we need the real PA.
*
* +=============+==========+========+
* | | | |
* | Page number | Reserved | Status |
* | | | |
* +=============+==========+========+
* 64 PAGE_SHIFT 6 0
*
* For now, only 4k pages are supported by the monitor, but by using
* reserved bit we can in the future add some flags that will indicate
* whether the page is a 2M page or a 1G page.
*
* The reserved field should be set to 0.
*
*/
#define BALLOON_BATCH_STATUS_MASK MASK64(5)
#define BALLOON_BATCH_PAGE_MASK (~MASK64(PAGE_SHIFT))
typedef struct BalloonBatchPage {
PA64 pages[BALLOON_BATCH_MAX_PAGES];
} BalloonBatchPage;
/*
*-----------------------------------------------------------------------------
*
* Balloon_BatchGetPA --
*
* Get the page stored in the batch page at idx.
*
* Results:
* See above.
*
* Side effects:
* None.
*
*-----------------------------------------------------------------------------
*/
static INLINE PA64
Balloon_BatchGetPA(BalloonBatchPage *batchPage, // IN
uint16 idx) // IN
{
ASSERT(idx < BALLOON_BATCH_MAX_PAGES);
return batchPage->pages[idx] & BALLOON_BATCH_PAGE_MASK;
}
/*
*-----------------------------------------------------------------------------
*
* Balloon_BatchGetStatus --
*
* Get the error code associated with a page.
*
* Results:
* See above.
*
* Side effects:
* None.
*
*-----------------------------------------------------------------------------
*/
static INLINE uint8
Balloon_BatchGetStatus(BalloonBatchPage *batchPage, // IN
uint16 idx) // IN
{
ASSERT(idx < BALLOON_BATCH_MAX_PAGES);
return (uint8)(batchPage->pages[idx] & BALLOON_BATCH_STATUS_MASK);
}
/*
*-----------------------------------------------------------------------------
*
* Balloon_BatchSetPA --
*
* Store the page in the batch page at idx.
*
* Results:
* None.
*
* Side effects:
* None.
*
*-----------------------------------------------------------------------------
*/
static INLINE void
Balloon_BatchSetPA(BalloonBatchPage *batchPage, // IN
uint16 idx, // IN
PA64 pa) // IN
{
ASSERT(idx < BALLOON_BATCH_MAX_PAGES);
ASSERT((pa & ~BALLOON_BATCH_PAGE_MASK) == 0);
batchPage->pages[idx] = pa;
}
/*
*-----------------------------------------------------------------------------
*
* Balloon_BatchSetStatus --
*
* Set the error code associated with a page.
*
* Results:
* None.
*
* Side effects:
* None.
*
*-----------------------------------------------------------------------------
*/
static INLINE void
Balloon_BatchSetStatus(BalloonBatchPage *batchPage, // IN
uint16 idx, // IN
int error) // IN
{
PA64 pa = Balloon_BatchGetPA(batchPage, idx);
ASSERT(idx < BALLOON_BATCH_MAX_PAGES);
ASSERT(error <= BALLOON_ERROR_BUSY && error >= BALLOON_FAILURE);
batchPage->pages[idx] = pa | (PPN64)error;
}
MY_ASSERTS(BALLOON_BATCH_SIZE,
ASSERT_ON_COMPILE(sizeof(BalloonBatchPage) == PAGE_SIZE);
)
#endif /* _BALLOON_DEF_H */
|
