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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
|
/*********************************************************
* Copyright (C) 2006-2011 VMware, Inc. All rights reserved.
*
* 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 version 2 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 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, write to the Free Software Foundation, Inc.,
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
*********************************************************/
/*
* vmci_kernel_if.h --
*
* This file defines helper functions for VMCI host _and_ guest
* kernel code. It must work for Windows, Mac OS, vmkernel, Linux and
* Solaris kernels, i.e. using defines where necessary.
*/
#ifndef _VMCI_KERNEL_IF_H_
#define _VMCI_KERNEL_IF_H_
#if !defined(linux) && !defined(_WIN32) && !defined(__APPLE__) && \
!defined(VMKERNEL) && !defined(SOLARIS)
# error "Platform not supported."
#endif
#if defined(_WIN32)
# include <ntddk.h>
#endif
#if defined(linux) && !defined(VMKERNEL)
# include "driver-config.h"
# include "compat_cred.h"
# include "compat_module.h"
# include "compat_semaphore.h"
# include "compat_spinlock.h"
# include "compat_version.h"
# include <linux/wait.h>
#endif // linux
#ifdef __APPLE__
# include <IOKit/IOLib.h>
# include <mach/task.h>
# include <mach/semaphore.h>
# include <sys/kauth.h>
#endif
#ifdef VMKERNEL
# include "splock.h"
# include "semaphore_ext.h"
# include "vmkapi.h"
# include "world_dist.h"
#endif
#ifdef SOLARIS
# include <sys/ddi.h>
# include <sys/kmem.h>
# include <sys/mutex.h>
# include <sys/poll.h>
# include <sys/semaphore.h>
# include <sys/sunddi.h>
# include <sys/types.h>
#endif
#include "vm_basic_types.h"
#include "vmci_defs.h"
#if defined(VMKERNEL)
# include "list.h"
#else
# include "dbllnklst.h"
#endif
/* Flags for specifying memory type. */
#define VMCI_MEMORY_NORMAL 0x0
#define VMCI_MEMORY_ATOMIC 0x1
#define VMCI_MEMORY_NONPAGED 0x2
/* Platform specific type definitions. */
#if defined(VMKERNEL)
# define VMCI_EXPORT_SYMBOL(_SYMBOL) VMK_MODULE_EXPORT_SYMBOL(_SYMBOL);
#elif defined(linux)
# define VMCI_EXPORT_SYMBOL(_symbol) EXPORT_SYMBOL(_symbol);
#elif defined(__APPLE__)
# define VMCI_EXPORT_SYMBOL(_symbol) __attribute__((visibility("default")))
#else
# define VMCI_EXPORT_SYMBOL(_symbol)
#endif
#if defined(VMKERNEL)
typedef SP_SpinLock VMCILock;
typedef SP_IRQL VMCILockFlags;
typedef Semaphore VMCIEvent;
typedef Semaphore VMCIMutex;
typedef World_ID VMCIHostVmID;
typedef uint32 VMCIHostUser;
typedef PPN *VMCIQPGuestMem;
#elif defined(linux)
typedef spinlock_t VMCILock;
typedef unsigned long VMCILockFlags;
typedef wait_queue_head_t VMCIEvent;
typedef struct semaphore VMCIMutex;
typedef PPN *VMCIPpnList; /* List of PPNs in produce/consume queue. */
typedef uid_t VMCIHostUser;
typedef VA64 VMCIQPGuestMem;
#elif defined(__APPLE__)
typedef IOLock *VMCILock;
typedef unsigned long VMCILockFlags;
typedef struct {
IOLock *lock;
DblLnkLst_Links waiters;
int buffered;
} VMCIEvent;
typedef IOLock *VMCIMutex;
typedef void *VMCIPpnList; /* Actually a pointer to the C++ Object IOMemoryDescriptor */
typedef uid_t VMCIHostUser;
typedef VA64 *VMCIQPGuestMem;
#elif defined(_WIN32)
typedef KSPIN_LOCK VMCILock;
typedef KIRQL VMCILockFlags;
typedef KEVENT VMCIEvent;
typedef FAST_MUTEX VMCIMutex;
typedef PMDL VMCIPpnList; /* MDL to map the produce/consume queue. */
typedef PSID VMCIHostUser;
typedef VA64 *VMCIQPGuestMem;
#elif defined(SOLARIS)
typedef kmutex_t VMCILock;
typedef unsigned long VMCILockFlags;
typedef ksema_t VMCIEvent;
typedef kmutex_t VMCIMutex;
typedef PPN *VMCIPpnList; /* List of PPNs in produce/consume queue. */
typedef uid_t VMCIHostUser;
typedef VA64 VMCIQPGuestMem;
#endif // VMKERNEL
/* Callback needed for correctly waiting on events. */
typedef int (*VMCIEventReleaseCB)(void *clientData);
/*
* Internal locking dependencies within VMCI:
* * CONTEXTFIRE < CONTEXT, CONTEXTLIST, EVENT, HASHTABLE
* * DOORBELL < HASHTABLE
* * QPHIBERNATE < EVENT
*/
#ifdef VMKERNEL
typedef Lock_Rank VMCILockRank;
typedef SemaRank VMCISemaRank;
#define VMCI_SEMA_RANK_QPHEADER (SEMA_RANK_FS - 1)
#define VMCI_LOCK_RANK_MAX (MIN(SP_RANK_WAIT, \
SP_RANK_HEAPLOCK_DYNAMIC) - 1)
#else
typedef unsigned long VMCILockRank;
typedef unsigned long VMCISemaRank;
#define VMCI_LOCK_RANK_MAX 0x0fff
#define VMCI_SEMA_RANK_QPHEADER 0x0fff
#endif // VMKERNEL
#define VMCI_LOCK_RANK_CONTEXT VMCI_LOCK_RANK_MAX
#define VMCI_LOCK_RANK_CONTEXTLIST VMCI_LOCK_RANK_MAX
#define VMCI_LOCK_RANK_DATAGRAMVMK VMCI_LOCK_RANK_MAX
#define VMCI_LOCK_RANK_EVENT VMCI_LOCK_RANK_MAX
#define VMCI_LOCK_RANK_HASHTABLE VMCI_LOCK_RANK_MAX
#define VMCI_LOCK_RANK_RESOURCE VMCI_LOCK_RANK_MAX
#define VMCI_LOCK_RANK_QPHEADER VMCI_LOCK_RANK_MAX
#define VMCI_LOCK_RANK_DOORBELL (VMCI_LOCK_RANK_HASHTABLE - 1)
#define VMCI_LOCK_RANK_CONTEXTFIRE (MIN(VMCI_LOCK_RANK_CONTEXT, \
MIN(VMCI_LOCK_RANK_CONTEXTLIST, \
MIN(VMCI_LOCK_RANK_EVENT, \
VMCI_LOCK_RANK_HASHTABLE))) - 1)
#define VMCI_LOCK_RANK_QPHIBERNATE (VMCI_LOCK_RANK_EVENT - 1)
#define VMCI_LOCK_RANK_PACKET_QP (VMCI_LOCK_RANK_QPHEADER - 1)
//#define VMCI_LOCK_RANK_PACKET_QP 0xffd /* For vVol */
#define VMCI_SEMA_RANK_QUEUEPAIRLIST (VMCI_SEMA_RANK_QPHEADER - 1)
#define VMCI_SEMA_RANK_GUESTMEM (VMCI_SEMA_RANK_QUEUEPAIRLIST - 1)
/*
* Host specific struct used for signalling.
*/
typedef struct VMCIHost {
#if defined(VMKERNEL)
World_ID vmmWorldID[2]; /*
* First one is the active one and the second
* one is shadow world during FSR.
*/
#elif defined(linux)
wait_queue_head_t waitQueue;
#elif defined(__APPLE__)
struct Socket *socket; /* vmci Socket object on Mac OS. */
#elif defined(_WIN32)
KEVENT *callEvent; /* Ptr to userlevel event used when signalling
* new pending guestcalls in kernel.
*/
#elif defined(SOLARIS)
struct pollhead pollhead; /* Per datagram handle pollhead structure to
* be treated as a black-box. None of its
* fields should be referenced.
*/
#endif
} VMCIHost;
/*
* Guest device port I/O.
*/
#if defined(linux)
typedef unsigned short int VMCIIoPort;
typedef int VMCIIoHandle;
#elif defined(_WIN32)
typedef PUCHAR VMCIIoPort;
typedef int VMCIIoHandle;
#elif defined(SOLARIS)
typedef uint8_t * VMCIIoPort;
typedef ddi_acc_handle_t VMCIIoHandle;
#elif defined(__APPLE__)
typedef unsigned short int VMCIIoPort;
typedef void *VMCIIoHandle;
#endif // __APPLE__
void VMCI_ReadPortBytes(VMCIIoHandle handle, VMCIIoPort port, uint8 *buffer,
size_t bufferLength);
int VMCI_InitLock(VMCILock *lock, char *name, VMCILockRank rank);
void VMCI_CleanupLock(VMCILock *lock);
void VMCI_GrabLock(VMCILock *lock, VMCILockFlags *flags);
void VMCI_ReleaseLock(VMCILock *lock, VMCILockFlags flags);
void VMCI_GrabLock_BH(VMCILock *lock, VMCILockFlags *flags);
void VMCI_ReleaseLock_BH(VMCILock *lock, VMCILockFlags flags);
void VMCIHost_InitContext(VMCIHost *hostContext, uintptr_t eventHnd);
void VMCIHost_ReleaseContext(VMCIHost *hostContext);
void VMCIHost_SignalCall(VMCIHost *hostContext);
void VMCIHost_ClearCall(VMCIHost *hostContext);
Bool VMCIHost_WaitForCallLocked(VMCIHost *hostContext,
VMCILock *lock,
VMCILockFlags *flags,
Bool useBH);
#ifdef VMKERNEL
int VMCIHost_ContextToHostVmID(VMCIHost *hostContext, VMCIHostVmID *hostVmID);
int VMCIHost_ContextHasUuid(VMCIHost *hostContext, const char *uuid);
void VMCIHost_SetActiveHnd(VMCIHost *hostContext, uintptr_t eventHnd);
Bool VMCIHost_RemoveHnd(VMCIHost *hostContext, uintptr_t eventHnd);
Bool VMCIHost_IsActiveHnd(VMCIHost *hostContext, uintptr_t eventHnd);
void VMCIHost_SetInactiveHnd(VMCIHost *hostContext, uintptr_t eventHnd);
uint32 VMCIHost_NumHnds(VMCIHost *hostContext);
uintptr_t VMCIHost_GetActiveHnd(VMCIHost *hostContext);
void VMCIHost_SignalBitmap(VMCIHost *hostContext);
#endif
#if defined(_WIN32)
/*
* On Windows, Driver Verifier will panic() if we leak memory when we are
* unloaded. It dumps the leaked blocks for us along with callsites, which
* it handily tracks, but if we embed ExAllocate() inside a function, then
* the callsite is useless. So make this a macro on this platform only.
*/
# define VMCI_AllocKernelMem(_sz, _f) \
ExAllocatePoolWithTag((((_f) & VMCI_MEMORY_NONPAGED) ? \
NonPagedPool : PagedPool), \
(_sz), 'MMTC')
#else // _WIN32
void *VMCI_AllocKernelMem(size_t size, int flags);
#endif // _WIN32
void VMCI_FreeKernelMem(void *ptr, size_t size);
int VMCI_CopyToUser(VA64 dst, const void *src, size_t len);
Bool VMCIWellKnownID_AllowMap(VMCIId wellKnownID,
VMCIPrivilegeFlags privFlags);
int VMCIHost_CompareUser(VMCIHostUser *user1, VMCIHostUser *user2);
void VMCI_CreateEvent(VMCIEvent *event);
void VMCI_DestroyEvent(VMCIEvent *event);
void VMCI_SignalEvent(VMCIEvent *event);
void VMCI_WaitOnEvent(VMCIEvent *event, VMCIEventReleaseCB releaseCB,
void *clientData);
#if (defined(__APPLE__) || defined(__linux__) || defined(_WIN32)) && !defined(VMKERNEL)
Bool VMCI_WaitOnEventInterruptible(VMCIEvent *event,
VMCIEventReleaseCB releaseCB,
void *clientData);
#endif
#if !defined(VMKERNEL) && (defined(__linux__) || defined(_WIN32) || \
defined(__APPLE__) || defined(SOLARIS))
int VMCI_CopyFromUser(void *dst, VA64 src, size_t len);
#endif
typedef void (VMCIWorkFn)(void *data);
Bool VMCI_CanScheduleDelayedWork(void);
int VMCI_ScheduleDelayedWork(VMCIWorkFn *workFn, void *data);
int VMCIMutex_Init(VMCIMutex *mutex, char *name, VMCILockRank rank);
void VMCIMutex_Destroy(VMCIMutex *mutex);
void VMCIMutex_Acquire(VMCIMutex *mutex);
void VMCIMutex_Release(VMCIMutex *mutex);
#if defined(SOLARIS) || defined(_WIN32) || defined(__APPLE__)
int VMCIKernelIf_Init(void);
void VMCIKernelIf_Exit(void);
#if defined(_WIN32)
void VMCIKernelIf_DrainDelayedWork(void);
#endif // _WIN32
#endif // SOLARIS || _WIN32 || __APPLE__
#if !defined(VMKERNEL) && (defined(__linux__) || defined(_WIN32) || \
defined(SOLARIS) || defined(__APPLE__))
void *VMCI_AllocQueue(uint64 size, uint32 flags);
void VMCI_FreeQueue(void *q, uint64 size);
typedef struct PPNSet {
uint64 numProducePages;
uint64 numConsumePages;
VMCIPpnList producePPNs;
VMCIPpnList consumePPNs;
Bool initialized;
} PPNSet;
int VMCI_AllocPPNSet(void *produceQ, uint64 numProducePages, void *consumeQ,
uint64 numConsumePages, PPNSet *ppnSet);
void VMCI_FreePPNSet(PPNSet *ppnSet);
int VMCI_PopulatePPNList(uint8 *callBuf, const PPNSet *ppnSet);
#endif
struct VMCIQueue;
struct PageStoreAttachInfo;
struct VMCIQueue *VMCIHost_AllocQueue(uint64 queueSize);
void VMCIHost_FreeQueue(struct VMCIQueue *queue, uint64 queueSize);
#if defined(VMKERNEL)
typedef World_Handle *VMCIGuestMemID;
#define INVALID_VMCI_GUEST_MEM_ID NULL
#else
typedef uint32 VMCIGuestMemID;
#define INVALID_VMCI_GUEST_MEM_ID 0
#endif
#if defined(VMKERNEL) || defined(__linux__) || defined(_WIN32) || \
defined(__APPLE__)
struct QueuePairPageStore;
int VMCIHost_RegisterUserMemory(struct QueuePairPageStore *pageStore,
struct VMCIQueue *produceQ,
struct VMCIQueue *consumeQ);
void VMCIHost_UnregisterUserMemory(struct VMCIQueue *produceQ,
struct VMCIQueue *consumeQ);
int VMCIHost_MapQueues(struct VMCIQueue *produceQ,
struct VMCIQueue *consumeQ,
uint32 flags);
int VMCIHost_UnmapQueues(VMCIGuestMemID gid,
struct VMCIQueue *produceQ,
struct VMCIQueue *consumeQ);
void VMCI_InitQueueMutex(struct VMCIQueue *produceQ,
struct VMCIQueue *consumeQ);
void VMCI_CleanupQueueMutex(struct VMCIQueue *produceQ,
struct VMCIQueue *consumeQ);
int VMCI_AcquireQueueMutex(struct VMCIQueue *queue, Bool canBlock);
void VMCI_ReleaseQueueMutex(struct VMCIQueue *queue);
#else // Below are the guest OS'es without host side support.
# define VMCI_InitQueueMutex(_pq, _cq)
# define VMCI_CleanupQueueMutex(_pq, _cq) do { } while (0)
# define VMCI_AcquireQueueMutex(_q, _cb) VMCI_SUCCESS
# define VMCI_ReleaseQueueMutex(_q) do { } while (0)
# define VMCIHost_RegisterUserMemory(_ps, _pq, _cq) VMCI_ERROR_UNAVAILABLE
# define VMCIHost_UnregisterUserMemory(_pq, _cq) do { } while (0)
# define VMCIHost_MapQueues(_pq, _cq, _f) VMCI_SUCCESS
# define VMCIHost_UnmapQueues(_gid, _pq, _cq) VMCI_SUCCESS
#endif
#if defined(VMKERNEL)
void VMCIHost_MarkQueuesAvailable(struct VMCIQueue *produceQ,
struct VMCIQueue *consumeQ);
void VMCIHost_MarkQueuesUnavailable(struct VMCIQueue *produceQ,
struct VMCIQueue *consumeQ);
#else
# define VMCIHost_MarkQueuesAvailable(_q, _p) do { } while (0)
# define VMCIHost_MarkQueuesUnavailable(_q, _p) do { } while(0)
#endif
#if defined(VMKERNEL) || defined(__linux__)
void VMCI_LockQueueHeader(struct VMCIQueue *queue);
void VMCI_UnlockQueueHeader(struct VMCIQueue *queue);
#else
# define VMCI_LockQueueHeader(_q) ASSERT_NOT_IMPLEMENTED(FALSE)
# define VMCI_UnlockQueueHeader(_q) ASSERT_NOT_IMPLEMENTED(FALSE)
#endif
#if (!defined(VMKERNEL) && defined(__linux__)) || defined(_WIN32) || \
defined(__APPLE__) || defined(SOLARIS)
int VMCIHost_GetUserMemory(VA64 produceUVA, VA64 consumeUVA,
struct VMCIQueue *produceQ,
struct VMCIQueue *consumeQ);
void VMCIHost_ReleaseUserMemory(struct VMCIQueue *produceQ,
struct VMCIQueue *consumeQ);
#else
# define VMCIHost_GetUserMemory(_puva, _cuva, _pq, _cq) VMCI_ERROR_UNAVAILABLE
# define VMCIHost_ReleaseUserMemory(_pq, _cq) ASSERT_NOT_IMPLEMENTED(FALSE)
#endif
#if defined(_WIN32)
Bool VMCI_EnqueueToDevNull(struct VMCIQueue *queue);
int VMCI_ConvertToLocalQueue(struct VMCIQueue *queueInfo,
struct VMCIQueue *otherQueueInfo,
uint64 size, Bool keepContent,
void **oldQueue);
void VMCI_RevertToNonLocalQueue(struct VMCIQueue *queueInfo,
void *nonLocalQueue, uint64 size);
void VMCI_FreeQueueBuffer(void *queue, uint64 size);
Bool VMCI_CanCreate(void);
#else // _WIN32
# define VMCI_EnqueueToDevNull(_q) FALSE
# define VMCI_ConvertToLocalQueue(_pq, _cq, _s, _oq, _kc) VMCI_ERROR_UNAVAILABLE
# define VMCI_RevertToNonLocalQueue(_q, _nlq, _s)
# define VMCI_FreeQueueBuffer(_q, _s)
# define VMCI_CanCreate() TRUE
#endif // !_WIN32
Bool VMCI_GuestPersonalityActive(void);
Bool VMCI_HostPersonalityActive(void);
#if defined(VMKERNEL)
typedef List_Links VMCIListItem;
typedef List_Links VMCIList;
# define VMCIList_Init(_l) List_Init(_l)
# define VMCIList_InitEntry(_e) List_InitElement(_e)
# define VMCIList_Empty(_l) List_IsEmpty(_l)
# define VMCIList_Insert(_e, _l) List_Insert(_e, LIST_ATREAR(_l))
# define VMCIList_Remove(_e) List_Remove(_e)
# define VMCIList_Scan(_cur, _l) LIST_FORALL(_l, _cur)
# define VMCIList_ScanSafe(_cur, _next, _l) LIST_FORALL_SAFE(_l, _cur, _next)
# define VMCIList_Entry(_elem, _type, _field) List_Entry(_elem, _type, _field)
# define VMCIList_First(_l) (VMCIList_Empty(_l)?NULL:List_First(_l))
#else
typedef DblLnkLst_Links VMCIListItem;
typedef DblLnkLst_Links VMCIList;
# define VMCIList_Init(_l) DblLnkLst_Init(_l)
# define VMCIList_InitEntry(_e) DblLnkLst_Init(_e)
# define VMCIList_Empty(_l) (!DblLnkLst_IsLinked(_l))
# define VMCIList_Insert(_e, _l) DblLnkLst_LinkLast(_l, _e)
# define VMCIList_Remove(_e) DblLnkLst_Unlink1(_e)
# define VMCIList_Scan(_cur, _l) DblLnkLst_ForEach(_cur, _l)
# define VMCIList_ScanSafe(_cur, _next, _l) DblLnkLst_ForEachSafe(_cur, _next, _l)
# define VMCIList_Entry(_elem, _type, _field) DblLnkLst_Container(_elem, _type, _field)
# define VMCIList_First(_l) (VMCIList_Empty(_l)?NULL:(_l)->next)
#endif
#endif // _VMCI_KERNEL_IF_H_
|
