Tryag File Manager
Home
-
Turbo Force
Current Path :
/
usr
/
lib
/
vmware-tools
/
modules
/
source
/
Upload File :
New :
File
Dir
//usr/lib/vmware-tools/modules/source/vmci.tar
vmci-only/ 0000755 0000000 0000000 00000000000 13432726375 011505 5 ustar root root vmci-only/Makefile 0000644 0000000 0000000 00000007403 13432725347 013147 0 ustar root root #!/usr/bin/make -f ########################################################## # Copyright (C) 1998-2016 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 # ########################################################## #### #### VMware kernel module Makefile to be distributed externally #### #### #### SRCROOT _must_ be a relative path. #### SRCROOT = . # # open-vm-tools doesn't replicate shared source files for different modules; # instead, files are kept in shared locations. So define a few useful macros # to be able to handle both cases cleanly. # INCLUDE := ifdef OVT_SOURCE_DIR AUTOCONF_DIR := $(OVT_SOURCE_DIR)/modules/linux/shared/autoconf VMLIB_PATH = $(OVT_SOURCE_DIR)/lib/$(1) INCLUDE += -I$(OVT_SOURCE_DIR)/modules/linux/shared INCLUDE += -I$(OVT_SOURCE_DIR)/lib/include else AUTOCONF_DIR := $(SRCROOT)/shared/autoconf INCLUDE += -I$(SRCROOT)/shared endif VM_UNAME = $(shell uname -r) # Header directory for the running kernel ifdef LINUXINCLUDE HEADER_DIR = $(LINUXINCLUDE) else HEADER_DIR = /lib/modules/$(VM_UNAME)/build/include endif BUILD_DIR = $(HEADER_DIR)/.. DRIVER := vmci PRODUCT := drivers-for-linux-guest # Grep program GREP = /bin/grep vm_check_gcc = $(shell if $(CC) $(1) -S -o /dev/null -xc /dev/null \ > /dev/null 2>&1; then echo "$(1)"; else echo "$(2)"; fi) vm_check_file = $(shell if test -f $(1); then echo "yes"; else echo "no"; fi) ifndef VM_KBUILD VM_KBUILD := no ifeq ($(call vm_check_file,$(BUILD_DIR)/Makefile), yes) VM_KBUILD := yes endif export VM_KBUILD endif ifndef VM_KBUILD_SHOWN ifeq ($(VM_KBUILD), no) VM_DUMMY := $(shell echo >&2 "Using standalone build system.") else VM_DUMMY := $(shell echo >&2 "Using kernel build system.") endif VM_KBUILD_SHOWN := yes export VM_KBUILD_SHOWN endif ifneq ($(VM_KBUILD), no) # If there is no version defined, we are in toplevel pass, not yet in kernel makefiles... ifeq ($(VERSION),) DRIVER_KO := $(DRIVER).ko .PHONY: $(DRIVER_KO) auto-build: $(DRIVER_KO) cp -f $< $(SRCROOT)/../$(DRIVER).o # $(DRIVER_KO) is a phony target, so compare file times explicitly $(DRIVER): $(DRIVER_KO) if [ $< -nt $@ ] || [ ! -e $@ ] ; then cp -f $< $@; fi # # Define a setup target that gets built before the actual driver. # This target may not be used at all, but if it is then it will be defined # in Makefile.kernel # prebuild:: ; postbuild:: ; $(DRIVER_KO): prebuild $(MAKE) -C $(BUILD_DIR) SUBDIRS=$$PWD SRCROOT=$$PWD/$(SRCROOT) \ MODULEBUILDDIR=$(MODULEBUILDDIR) modules $(MAKE) -C $$PWD SRCROOT=$$PWD/$(SRCROOT) \ MODULEBUILDDIR=$(MODULEBUILDDIR) postbuild endif vm_check_build = $(shell if $(CC) $(KBUILD_CPPFLAGS) $(KBUILD_CFLAGS) \ $(CPPFLAGS) $(CFLAGS) $(CFLAGS_KERNEL) $(LINUXINCLUDE) \ $(EXTRA_CFLAGS) -Iinclude2/asm/mach-default \ -DKBUILD_BASENAME=\"$(DRIVER)\" \ -Werror -S -o /dev/null -xc $(1) \ > /dev/null 2>&1; then echo "$(2)"; else echo "$(3)"; fi) CC_WARNINGS := -Wall -Wstrict-prototypes CC_OPTS := $(GLOBAL_DEFS) $(CC_WARNINGS) -DVMW_USING_KBUILD ifdef VMX86_DEVEL CC_OPTS += -DVMX86_DEVEL endif ifdef VMX86_DEBUG CC_OPTS += -DVMX86_DEBUG endif include $(SRCROOT)/Makefile.kernel else include $(SRCROOT)/Makefile.normal endif #.SILENT: vmci-only/shared/ 0000755 0000000 0000000 00000000000 13432726375 012753 5 ustar root root vmci-only/shared/compat_statfs.h 0000444 0000000 0000000 00000002306 13432725347 015770 0 ustar root root /********************************************************* * Copyright (C) 2006 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 * *********************************************************/ #ifndef __COMPAT_STATFS_H__ # define __COMPAT_STATFS_H__ /* vfs.h simply include statfs.h, but it knows what directory statfs.h is in. */ #include <linux/vfs.h> /* 2.5.74 renamed struct statfs to kstatfs. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 5, 74) #define compat_kstatfs kstatfs #else #define compat_kstatfs statfs #endif #endif /* __COMPAT_STATFS_H__ */ vmci-only/shared/vmciKernelAPI.h 0000444 0000000 0000000 00000002451 13432725350 015545 0 ustar root root /********************************************************* * Copyright (C) 2010,2017 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 * *********************************************************/ /* * vmciKernelAPI.h -- * * Kernel API (current) exported from the VMCI host and guest drivers. */ #ifndef __VMCI_KERNELAPI_H__ #define __VMCI_KERNELAPI_H__ #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMK_MODULE #define INCLUDE_ALLOW_VMKERNEL #include "includeCheck.h" /* With this file you always get the latest version. */ #include "vmciKernelAPI1.h" #include "vmciKernelAPI2.h" #include "vmciKernelAPI3.h" #endif /* !__VMCI_KERNELAPI_H__ */ vmci-only/shared/community_source.h 0000444 0000000 0000000 00000003712 13432725350 016521 0 ustar root root /********************************************************* * Copyright (C) 2009-2016 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 * *********************************************************/ /* * community_source.h -- * * Macros for excluding source code from community. */ #ifndef _COMMUNITY_SOURCE_H_ #define _COMMUNITY_SOURCE_H_ #define INCLUDE_ALLOW_USERLEVEL #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMKERNEL #define INCLUDE_ALLOW_VMKDRIVERS #define INCLUDE_ALLOW_VMK_MODULE #define INCLUDE_ALLOW_DISTRIBUTE #define INCLUDE_ALLOW_VMCORE #include "includeCheck.h" /* * Convenience macro for COMMUNITY_SOURCE */ #undef EXCLUDE_COMMUNITY_SOURCE #ifdef COMMUNITY_SOURCE #define EXCLUDE_COMMUNITY_SOURCE(x) #else #define EXCLUDE_COMMUNITY_SOURCE(x) x #endif #undef COMMUNITY_SOURCE_AMD_SECRET #if !defined(COMMUNITY_SOURCE) || defined(AMD_SOURCE) /* * It's ok to include AMD_SECRET source code for non-Community Source, * or for drops directed at AMD. */ #define COMMUNITY_SOURCE_AMD_SECRET #endif #undef COMMUNITY_SOURCE_INTEL_SECRET #if !defined(COMMUNITY_SOURCE) || defined(INTEL_SOURCE) /* * It's ok to include INTEL_SECRET source code for non-Community Source, * or for drops directed at Intel. */ #define COMMUNITY_SOURCE_INTEL_SECRET #endif #endif vmci-only/shared/vmci_iocontrols.h 0000444 0000000 0000000 00000062156 13432725350 016335 0 ustar root root /********************************************************* * Copyright (C) 2007-2014,2018 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_iocontrols.h * * The VMCI driver io controls. */ #ifndef _VMCI_IOCONTROLS_H_ #define _VMCI_IOCONTROLS_H_ #define INCLUDE_ALLOW_USERLEVEL #define INCLUDE_ALLOW_VMCORE #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMKERNEL #include "includeCheck.h" #include "vm_assert.h" #include "vmci_defs.h" #if defined(_WIN32) && defined(WINNT_DDK) /* We need to expose the API through an IOCTL on Windows. Use latest API. */ #include "vmciKernelAPI.h" #endif // _WIN32 && WINNT_DDK #if defined __cplusplus extern "C" { #endif /* *----------------------------------------------------------------------------- * * VMCIVA64ToPtr -- * * Convert a VA64 to a pointer. * * Results: * Virtual address. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void * VMCIVA64ToPtr(VA64 va64) // IN { #ifdef VM_64BIT ASSERT_ON_COMPILE(sizeof (void *) == 8); #else ASSERT_ON_COMPILE(sizeof (void *) == 4); // Check that nothing of value will be lost. ASSERT(!(va64 >> 32)); #endif return (void *)(uintptr_t)va64; } /* *----------------------------------------------------------------------------- * * VMCIPtrToVA64 -- * * Convert a pointer to a VA64. * * Results: * Virtual address. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE VA64 VMCIPtrToVA64(void const *ptr) // IN { ASSERT_ON_COMPILE(sizeof ptr <= sizeof (VA64)); return (VA64)(uintptr_t)ptr; } /* * Driver version. * * Increment major version when you make an incompatible change. * Compatibility goes both ways (old driver with new executable * as well as new driver with old executable). */ #define VMCI_VERSION_SHIFT_WIDTH 16 /* Never change this. */ #define VMCI_MAKE_VERSION(_major, _minor) ((_major) << \ VMCI_VERSION_SHIFT_WIDTH | \ (uint16) (_minor)) #define VMCI_VERSION_MAJOR(v) ((uint32) (v) >> VMCI_VERSION_SHIFT_WIDTH) #define VMCI_VERSION_MINOR(v) ((uint16) (v)) /* * VMCI_VERSION is always the current version. Subsequently listed * versions are ways of detecting previous versions of the connecting * application (i.e., VMX). * * VMCI_VERSION_NOVMVM: This version removed support for VM to VM * communication. * * VMCI_VERSION_NOTIFY: This version introduced doorbell notification * support. * * VMCI_VERSION_HOSTQP: This version introduced host end point support * for hosted products. * * VMCI_VERSION_PREHOSTQP: This is the version prior to the adoption of * support for host end-points. * * VMCI_VERSION_PREVERS2: This fictional version number is intended to * represent the version of a VMX which doesn't call into the driver * with ioctl VERSION2 and thus doesn't establish its version with the * driver. */ #define VMCI_VERSION VMCI_VERSION_NOVMVM #define VMCI_VERSION_NOVMVM VMCI_MAKE_VERSION(11, 0) #define VMCI_VERSION_NOTIFY VMCI_MAKE_VERSION(10, 0) #define VMCI_VERSION_HOSTQP VMCI_MAKE_VERSION(9, 0) #define VMCI_VERSION_PREHOSTQP VMCI_MAKE_VERSION(8, 0) #define VMCI_VERSION_PREVERS2 VMCI_MAKE_VERSION(1, 0) /* * VMCISockets driver version. The version is platform-dependent and is * embedded in vsock_version.h for each platform. It can be obtained via * VMCISock_Version() (which uses IOCTL_VMCI_SOCKETS_VERSION). The * following is simply for constructing an unsigned integer value from the * comma-separated version in the header. This must match the macros defined * in vmci_sockets.h. An example of using this is: * uint16 parts[4] = { VSOCK_DRIVER_VERSION_COMMAS }; * uint32 version = VMCI_SOCKETS_MAKE_VERSION(parts); */ #define VMCI_SOCKETS_MAKE_VERSION(_p) \ ((((_p)[0] & 0xFF) << 24) | (((_p)[1] & 0xFF) << 16) | ((_p)[2])) #if defined(__linux__) || defined(VMKERNEL) /* * Linux defines _IO* macros, but the core kernel code ignore the encoded * ioctl value. It is up to individual drivers to decode the value (for * example to look at the size of a structure to determine which version * of a specific command should be used) or not (which is what we * currently do, so right now the ioctl value for a given command is the * command itself). * * Hence, we just define the IOCTL_VMCI_foo values directly, with no * intermediate IOCTLCMD_ representation. */ # define IOCTLCMD(_cmd) IOCTL_VMCI_ ## _cmd #elif defined (__APPLE__) #include <sys/ioccom.h> #define IOCTLCMD(_cmd) IOCTL_VMCI_ ## _cmd #define IOCTLCMD_I(_cmd, _type) \ IOCTL_VMCI_MACOS_ ## _cmd = _IOW('V', IOCTL_VMCI_ ## _cmd, _type) #define IOCTLCMD_O(_cmd, _type) \ IOCTL_VMCI_MACOS_ ## _cmd = _IOR('V', IOCTL_VMCI_ ## _cmd, _type) #define IOCTLCMD_IO(_cmd, _type) \ IOCTL_VMCI_MACOS_ ## _cmd = _IOWR('V', IOCTL_VMCI_ ## _cmd, _type) #else // if defined(__linux__) /* * On platforms other than Linux, IOCTLCMD_foo values are just numbers, and * we build the IOCTL_VMCI_foo values around these using platform-specific * format for encoding arguments and sizes. */ # define IOCTLCMD(_cmd) IOCTLCMD_VMCI_ ## _cmd #endif enum IOCTLCmd_VMCI { /* * We need to bracket the range of values used for ioctls, because x86_64 * Linux forces us to explicitly register ioctl handlers by value for * handling 32 bit ioctl syscalls. Hence FIRST and LAST. Pick something * for FIRST that doesn't collide with vmmon (2001+). */ #if defined(__linux__) IOCTLCMD(FIRST) = 1951, #else /* Start at 0. */ IOCTLCMD(FIRST), #endif IOCTLCMD(VERSION) = IOCTLCMD(FIRST), /* BEGIN VMCI */ IOCTLCMD(INIT_CONTEXT), /* * The following two were used for process and datagram process creation. * They are not used anymore and reserved for future use. * They will fail if issued. */ IOCTLCMD(RESERVED1), IOCTLCMD(RESERVED2), /* * The following used to be for shared memory. It is now unused and and is * reserved for future use. It will fail if issued. */ IOCTLCMD(RESERVED3), /* * The follwoing three were also used to be for shared memory. An * old WS6 user-mode client might try to use them with the new * driver, but since we ensure that only contexts created by VMX'en * of the appropriate version (VMCI_VERSION_NOTIFY or * VMCI_VERSION_NEWQP) or higher use these ioctl, everything is * fine. */ IOCTLCMD(QUEUEPAIR_SETVA), IOCTLCMD(NOTIFY_RESOURCE), IOCTLCMD(NOTIFICATIONS_RECEIVE), IOCTLCMD(VERSION2), IOCTLCMD(QUEUEPAIR_ALLOC), IOCTLCMD(QUEUEPAIR_SETPAGEFILE), IOCTLCMD(QUEUEPAIR_DETACH), IOCTLCMD(DATAGRAM_SEND), IOCTLCMD(DATAGRAM_RECEIVE), IOCTLCMD(DATAGRAM_REQUEST_MAP), IOCTLCMD(DATAGRAM_REMOVE_MAP), IOCTLCMD(CTX_ADD_NOTIFICATION), IOCTLCMD(CTX_REMOVE_NOTIFICATION), IOCTLCMD(CTX_GET_CPT_STATE), IOCTLCMD(CTX_SET_CPT_STATE), IOCTLCMD(GET_CONTEXT_ID), /* END VMCI */ /* * BEGIN VMCI SOCKETS * * We mark the end of the vmci commands and the start of the vmci sockets * commands since they are used in separate modules on Linux. * */ IOCTLCMD(LAST), IOCTLCMD(SOCKETS_FIRST) = IOCTLCMD(LAST), /* * This used to be for accept() on Windows and Mac OS, which is now * redundant (since we now use real handles). It is used instead for * getting the version. This value is now public, so it cannot change. */ IOCTLCMD(SOCKETS_VERSION) = IOCTLCMD(SOCKETS_FIRST), IOCTLCMD(SOCKETS_BIND), /* * This used to be for close() on Windows and Mac OS, but is no longer * used for the same reason as accept() above. It is used instead for * sending private symbols to the Mac OS driver. */ IOCTLCMD(SOCKETS_SET_SYMBOLS), IOCTLCMD(SOCKETS_CONNECT), /* * The next two values are public (vmci_sockets.h) and cannot be changed. * That means the number of values above these cannot be changed either * unless the base index (specified below) is updated accordingly. */ IOCTLCMD(SOCKETS_GET_AF_VALUE), IOCTLCMD(SOCKETS_GET_LOCAL_CID), IOCTLCMD(SOCKETS_GET_SOCK_NAME), IOCTLCMD(SOCKETS_GET_SOCK_OPT), IOCTLCMD(SOCKETS_GET_VM_BY_NAME), IOCTLCMD(SOCKETS_IOCTL), IOCTLCMD(SOCKETS_LISTEN), IOCTLCMD(SOCKETS_RECV), IOCTLCMD(SOCKETS_RECV_FROM), IOCTLCMD(SOCKETS_SELECT), IOCTLCMD(SOCKETS_SEND), IOCTLCMD(SOCKETS_SEND_TO), IOCTLCMD(SOCKETS_SET_SOCK_OPT), IOCTLCMD(SOCKETS_SHUTDOWN), IOCTLCMD(SOCKETS_SOCKET), IOCTLCMD(SOCKETS_UUID_2_CID), /* 1991 on Linux. */ /* END VMCI SOCKETS */ /* * We reserve a range of 3 ioctls for VMCI Sockets to grow. We cannot * reserve many ioctls here since we are close to overlapping with vmmon * ioctls. Define a meta-ioctl if running out of this binary space. */ // Must be last. IOCTLCMD(SOCKETS_LAST) = IOCTLCMD(SOCKETS_UUID_2_CID) + 3, /* 1994 on Linux. */ /* * The VSockets ioctls occupy the block above. We define a new range of * VMCI ioctls to maintain binary compatibility between the user land and * the kernel driver. Careful, vmmon ioctls start from 2001, so this means * we can add only 4 new VMCI ioctls. Define a meta-ioctl if running out of * this binary space. */ IOCTLCMD(FIRST2), IOCTLCMD(SET_NOTIFY) = IOCTLCMD(FIRST2), /* 1995 on Linux. */ IOCTLCMD(LAST2), }; #if defined (__APPLE__) /* * The size of this must match the size of VSockIoctlPrivSyms in * modules/vsock/common/vsockIoctl.h. */ #pragma pack(push, 1) struct IOCTLCmd_VMCIMacOS_PrivSyms { char data[344]; }; #pragma pack(pop) enum IOCTLCmd_VMCIMacOS { IOCTLCMD_I(SOCKETS_SET_SYMBOLS, struct IOCTLCmd_VMCIMacOS_PrivSyms), IOCTLCMD_O(SOCKETS_VERSION, unsigned int), IOCTLCMD_O(SOCKETS_GET_AF_VALUE, int), IOCTLCMD_O(SOCKETS_GET_LOCAL_CID, unsigned int), }; #endif // __APPLE__ #if defined _WIN32 /* * Windows VMCI ioctl definitions. */ /* PUBLIC: For VMCISockets user-mode clients that use CreateFile(). */ #define VMCI_INTERFACE_VSOCK_PUBLIC_NAME TEXT("\\\\.\\VMCI") /* PUBLIC: For VMCISockets user-mode clients that use NtCreateFile(). */ #define VMCI_INTERFACE_VSOCK_PUBLIC_NAME_NT L"\\??\\VMCI" /* PUBLIC: For the VMX, which uses CreateFile(). */ #define VMCI_INTERFACE_VMX_PUBLIC_NAME TEXT("\\\\.\\VMCIDev\\VMX") /* PRIVATE NAMES */ #define VMCI_DEVICE_VMCI_LINK_PATH L"\\DosDevices\\VMCIDev" #define VMCI_DEVICE_VSOCK_LINK_PATH L"\\DosDevices\\vmci" #define VMCI_DEVICE_HOST_NAME_PATH L"\\Device\\VMCIHostDev" #define VMCI_DEVICE_GUEST_NAME_PATH L"\\Device\\VMCIGuestDev" /* PRIVATE NAMES */ /* These values cannot be changed since some of the ioctl values are public. */ #define FILE_DEVICE_VMCI 0x8103 #define VMCI_IOCTL_BASE_INDEX 0x801 #define VMCIIOCTL_BUFFERED(name) \ CTL_CODE(FILE_DEVICE_VMCI, \ VMCI_IOCTL_BASE_INDEX + IOCTLCMD_VMCI_ ## name, \ METHOD_BUFFERED, \ FILE_ANY_ACCESS) #define VMCIIOCTL_NEITHER(name) \ CTL_CODE(FILE_DEVICE_VMCI, \ VMCI_IOCTL_BASE_INDEX + IOCTLCMD_VMCI_ ## name, \ METHOD_NEITHER, \ FILE_ANY_ACCESS) enum IOCTLCmd_VMCIWin32 { IOCTLCMD(DEVICE_GET) = IOCTLCMD(LAST2) + 1, IOCTLCMD(SOCKETS_SERVICE_GET), IOCTLCMD(SOCKETS_STOP), }; #define IOCTL_VMCI_VERSION VMCIIOCTL_BUFFERED(VERSION) /* BEGIN VMCI */ #define IOCTL_VMCI_INIT_CONTEXT \ VMCIIOCTL_BUFFERED(INIT_CONTEXT) #define IOCTL_VMCI_HYPERCALL \ VMCIIOCTL_BUFFERED(HYPERCALL) #define IOCTL_VMCI_CREATE_DATAGRAM_HANDLE \ VMCIIOCTL_BUFFERED(CREATE_DATAGRAM_HANDLE) #define IOCTL_VMCI_DESTROY_DATAGRAM_HANDLE \ VMCIIOCTL_BUFFERED(DESTROY_DATAGRAM_HANDLE) #define IOCTL_VMCI_NOTIFY_RESOURCE \ VMCIIOCTL_BUFFERED(NOTIFY_RESOURCE) #define IOCTL_VMCI_NOTIFICATIONS_RECEIVE \ VMCIIOCTL_BUFFERED(NOTIFICATIONS_RECEIVE) #define IOCTL_VMCI_VERSION2 \ VMCIIOCTL_BUFFERED(VERSION2) #define IOCTL_VMCI_QUEUEPAIR_ALLOC \ VMCIIOCTL_BUFFERED(QUEUEPAIR_ALLOC) #define IOCTL_VMCI_QUEUEPAIR_SETVA \ VMCIIOCTL_BUFFERED(QUEUEPAIR_SETVA) #define IOCTL_VMCI_QUEUEPAIR_SETPAGEFILE \ VMCIIOCTL_BUFFERED(QUEUEPAIR_SETPAGEFILE) #define IOCTL_VMCI_QUEUEPAIR_DETACH \ VMCIIOCTL_BUFFERED(QUEUEPAIR_DETACH) #define IOCTL_VMCI_DATAGRAM_SEND \ VMCIIOCTL_BUFFERED(DATAGRAM_SEND) #define IOCTL_VMCI_DATAGRAM_RECEIVE \ VMCIIOCTL_NEITHER(DATAGRAM_RECEIVE) #define IOCTL_VMCI_DATAGRAM_REQUEST_MAP \ VMCIIOCTL_BUFFERED(DATAGRAM_REQUEST_MAP) #define IOCTL_VMCI_DATAGRAM_REMOVE_MAP \ VMCIIOCTL_BUFFERED(DATAGRAM_REMOVE_MAP) #define IOCTL_VMCI_CTX_ADD_NOTIFICATION \ VMCIIOCTL_BUFFERED(CTX_ADD_NOTIFICATION) #define IOCTL_VMCI_CTX_REMOVE_NOTIFICATION \ VMCIIOCTL_BUFFERED(CTX_REMOVE_NOTIFICATION) #define IOCTL_VMCI_CTX_GET_CPT_STATE \ VMCIIOCTL_BUFFERED(CTX_GET_CPT_STATE) #define IOCTL_VMCI_CTX_SET_CPT_STATE \ VMCIIOCTL_BUFFERED(CTX_SET_CPT_STATE) #define IOCTL_VMCI_GET_CONTEXT_ID \ VMCIIOCTL_BUFFERED(GET_CONTEXT_ID) #define IOCTL_VMCI_DEVICE_GET \ VMCIIOCTL_BUFFERED(DEVICE_GET) /* END VMCI */ /* BEGIN VMCI SOCKETS */ #define IOCTL_VMCI_SOCKETS_VERSION \ VMCIIOCTL_BUFFERED(SOCKETS_VERSION) #define IOCTL_VMCI_SOCKETS_BIND \ VMCIIOCTL_BUFFERED(SOCKETS_BIND) #define IOCTL_VMCI_SOCKETS_CONNECT \ VMCIIOCTL_BUFFERED(SOCKETS_CONNECT) #define IOCTL_VMCI_SOCKETS_GET_AF_VALUE \ VMCIIOCTL_BUFFERED(SOCKETS_GET_AF_VALUE) #define IOCTL_VMCI_SOCKETS_GET_LOCAL_CID \ VMCIIOCTL_BUFFERED(SOCKETS_GET_LOCAL_CID) #define IOCTL_VMCI_SOCKETS_GET_SOCK_NAME \ VMCIIOCTL_BUFFERED(SOCKETS_GET_SOCK_NAME) #define IOCTL_VMCI_SOCKETS_GET_SOCK_OPT \ VMCIIOCTL_BUFFERED(SOCKETS_GET_SOCK_OPT) #define IOCTL_VMCI_SOCKETS_GET_VM_BY_NAME \ VMCIIOCTL_BUFFERED(SOCKETS_GET_VM_BY_NAME) #define IOCTL_VMCI_SOCKETS_IOCTL \ VMCIIOCTL_BUFFERED(SOCKETS_IOCTL) #define IOCTL_VMCI_SOCKETS_LISTEN \ VMCIIOCTL_BUFFERED(SOCKETS_LISTEN) #define IOCTL_VMCI_SOCKETS_RECV_FROM \ VMCIIOCTL_BUFFERED(SOCKETS_RECV_FROM) #define IOCTL_VMCI_SOCKETS_SELECT \ VMCIIOCTL_BUFFERED(SOCKETS_SELECT) #define IOCTL_VMCI_SOCKETS_SEND_TO \ VMCIIOCTL_BUFFERED(SOCKETS_SEND_TO) #define IOCTL_VMCI_SOCKETS_SET_SOCK_OPT \ VMCIIOCTL_BUFFERED(SOCKETS_SET_SOCK_OPT) #define IOCTL_VMCI_SOCKETS_SHUTDOWN \ VMCIIOCTL_BUFFERED(SOCKETS_SHUTDOWN) #define IOCTL_VMCI_SOCKETS_SERVICE_GET \ VMCIIOCTL_BUFFERED(SOCKETS_SERVICE_GET) #define IOCTL_VMCI_SOCKETS_STOP \ VMCIIOCTL_NEITHER(SOCKETS_STOP) /* END VMCI SOCKETS */ #endif // _WIN32 /* * VMCI driver initialization. This block can also be used to * pass initial group membership etc. */ typedef struct VMCIInitBlock { VMCIId cid; VMCIPrivilegeFlags flags; #ifdef _WIN32 uint64 event; /* Handle for signalling vmci calls on windows. */ #endif // _WIN32 } VMCIInitBlock; typedef struct VMCISharedMemInfo { VMCIHandle handle; uint32 size; uint32 result; VA64 va; /* Currently only used in the guest. */ char pageFileName[VMCI_PATH_MAX]; } VMCISharedMemInfo; typedef struct VMCIQueuePairAllocInfo_VMToVM { VMCIHandle handle; VMCIId peer; uint32 flags; uint64 produceSize; uint64 consumeSize; #if !defined(VMX86_SERVER) && !defined(VMKERNEL) VA64 producePageFile; /* User VA. */ VA64 consumePageFile; /* User VA. */ uint64 producePageFileSize; /* Size of the file name array. */ uint64 consumePageFileSize; /* Size of the file name array. */ #else PPN64 * PPNs; uint64 numPPNs; #endif int32 result; uint32 _pad; } VMCIQueuePairAllocInfo_VMToVM; typedef struct VMCIQueuePairAllocInfo { VMCIHandle handle; VMCIId peer; uint32 flags; uint64 produceSize; uint64 consumeSize; #if !defined(VMX86_SERVER) && !defined(VMKERNEL) VA64 ppnVA; /* Start VA of queue pair PPNs. */ #else PPN64 * PPNs; #endif uint64 numPPNs; int32 result; uint32 version; } VMCIQueuePairAllocInfo; typedef struct VMCIQueuePairSetVAInfo { VMCIHandle handle; VA64 va; /* Start VA of queue pair PPNs. */ uint64 numPPNs; uint32 version; int32 result; } VMCIQueuePairSetVAInfo; /* * For backwards compatibility, here is a version of the * VMCIQueuePairPageFileInfo before host support end-points was added. * Note that the current version of that structure requires VMX to * pass down the VA of the mapped file. Before host support was added * there was nothing of the sort. So, when the driver sees the ioctl * with a parameter that is the sizeof * VMCIQueuePairPageFileInfo_NoHostQP then it can infer that the version * of VMX running can't attach to host end points because it doesn't * provide the VA of the mapped files. * * The Linux driver doesn't get an indication of the size of the * structure passed down from user space. So, to fix a long standing * but unfiled bug, the _pad field has been renamed to version. * Existing versions of VMX always initialize the PageFileInfo * structure so that _pad, er, version is set to 0. * * A version value of 1 indicates that the size of the structure has * been increased to include two UVA's: produceUVA and consumeUVA. * These UVA's are of the mmap()'d queue contents backing files. * * In addition, if when VMX is sending down the * VMCIQueuePairPageFileInfo structure it gets an error then it will * try again with the _NoHostQP version of the file to see if an older * VMCI kernel module is running. */ typedef struct VMCIQueuePairPageFileInfo_NoHostQP { VMCIHandle handle; VA64 producePageFile; /* User VA. */ VA64 consumePageFile; /* User VA. */ uint64 producePageFileSize; /* Size of the file name array. */ uint64 consumePageFileSize; /* Size of the file name array. */ int32 result; uint32 version; /* Was _pad. Must be 0. */ } VMCIQueuePairPageFileInfo_NoHostQP; typedef struct VMCIQueuePairPageFileInfo { VMCIHandle handle; #if !defined(VMX86_SERVER) && !defined(VMKERNEL) VA64 producePageFile; /* User VA. */ VA64 consumePageFile; /* User VA. */ uint64 producePageFileSize; /* Size of the file name array. */ uint64 consumePageFileSize; /* Size of the file name array. */ #endif int32 result; uint32 version; /* Was _pad. */ VA64 produceVA; /* User VA of the mapped file. */ VA64 consumeVA; /* User VA of the mapped file. */ } VMCIQueuePairPageFileInfo; typedef struct VMCIQueuePairDetachInfo { VMCIHandle handle; int32 result; uint32 _pad; } VMCIQueuePairDetachInfo; typedef struct VMCIDatagramSendRecvInfo { VA64 addr; uint32 len; int32 result; } VMCIDatagramSendRecvInfo; /* Used to add/remove well-known datagram mappings. */ typedef struct VMCIDatagramMapInfo { VMCIId wellKnownID; int result; } VMCIDatagramMapInfo; /* Used to add/remove remote context notifications. */ typedef struct VMCINotifyAddRemoveInfo { VMCIId remoteCID; int result; } VMCINotifyAddRemoveInfo; /* Used to set/get current context's checkpoint state. */ typedef struct VMCICptBufInfo { VA64 cptBuf; uint32 cptType; uint32 bufSize; int32 result; uint32 _pad; } VMCICptBufInfo; /* Used to pass notify flag's address to the host driver. */ typedef struct VMCISetNotifyInfo { VA64 notifyUVA; int32 result; uint32 _pad; } VMCISetNotifyInfo; #define VMCI_NOTIFY_RESOURCE_QUEUE_PAIR 0 #define VMCI_NOTIFY_RESOURCE_DOOR_BELL 1 #define VMCI_NOTIFY_RESOURCE_ACTION_NOTIFY 0 #define VMCI_NOTIFY_RESOURCE_ACTION_CREATE 1 #define VMCI_NOTIFY_RESOURCE_ACTION_DESTROY 2 /* * Used to create and destroy doorbells, and generate a notification * for a doorbell or queue pair. */ typedef struct VMCINotifyResourceInfo { VMCIHandle handle; uint16 resource; uint16 action; int32 result; } VMCINotifyResourceInfo; /* * Used to recieve pending notifications for doorbells and queue * pairs. */ typedef struct VMCINotificationReceiveInfo { VA64 dbHandleBufUVA; uint64 dbHandleBufSize; VA64 qpHandleBufUVA; uint64 qpHandleBufSize; int32 result; uint32 _pad; } VMCINotificationReceiveInfo; #if defined(_WIN32) && defined(WINNT_DDK) /* * Used on Windows to expose the API calls that are no longer exported. This * is kernel-mode only, and both sides will have the same bitness, so we can * use pointers directly. */ /* Version 1. */ typedef struct VMCIDeviceGetInfoVer1 { VMCI_DeviceReleaseFct *deviceRelease; VMCIDatagram_CreateHndFct *dgramCreateHnd; VMCIDatagram_CreateHndPrivFct *dgramCreateHndPriv; VMCIDatagram_DestroyHndFct *dgramDestroyHnd; VMCIDatagram_SendFct *dgramSend; VMCI_GetContextIDFct *getContextId; VMCI_VersionFct *version; VMCIEvent_SubscribeFct *eventSubscribe; VMCIEvent_UnsubscribeFct *eventUnsubscribe; VMCIQPair_AllocFct *qpairAlloc; VMCIQPair_DetachFct *qpairDetach; VMCIQPair_GetProduceIndexesFct *qpairGetProduceIndexes; VMCIQPair_GetConsumeIndexesFct *qpairGetConsumeIndexes; VMCIQPair_ProduceFreeSpaceFct *qpairProduceFreeSpace; VMCIQPair_ProduceBufReadyFct *qpairProduceBufReady; VMCIQPair_ConsumeFreeSpaceFct *qpairConsumeFreeSpace; VMCIQPair_ConsumeBufReadyFct *qpairConsumeBufReady; VMCIQPair_EnqueueFct *qpairEnqueue; VMCIQPair_DequeueFct *qpairDequeue; VMCIQPair_PeekFct *qpairPeek; VMCIQPair_EnqueueVFct *qpairEnqueueV; VMCIQPair_DequeueVFct *qpairDequeueV; VMCIQPair_PeekVFct *qpairPeekV; VMCI_ContextID2HostVmIDFct *contextID2HostVmID; VMCI_IsContextOwnerFct *isContextOwner; VMCIContext_GetPrivFlagsFct *contextGetPrivFlags; } VMCIDeviceGetInfoVer1; /* Version 2. */ typedef struct VMCIDeviceGetInfoVer2 { VMCIDoorbell_CreateFct *doorbellCreate; VMCIDoorbell_DestroyFct *doorbellDestroy; VMCIDoorbell_NotifyFct *doorbellNotify; } VMCIDeviceGetInfoVer2; typedef struct VMCIDeviceGetInfoHdr { /* Requested API version on input, supported version on output. */ uint32 apiVersion; VMCI_DeviceShutdownFn *deviceShutdownCB; void *userData; void *deviceRegistration; } VMCIDeviceGetInfoHdr; /* Combination of all versions. */ typedef struct VMCIDeviceGetInfo { VMCIDeviceGetInfoHdr hdr; VMCIDeviceGetInfoVer1 ver1; VMCIDeviceGetInfoVer2 ver2; } VMCIDeviceGetInfo; #endif // _WIN32 && WINNT_DDK #ifdef __APPLE__ /* * Mac OS ioctl definitions. * * Mac OS defines _IO* macros, and the core kernel code uses the size encoded * in the ioctl value to copy the memory back and forth (depending on the * direction encoded in the ioctl value) between the user and kernel address * spaces. * See iocontrolsMacOS.h for details on how this is done. We use sockets only * for vmci. */ #include <sys/ioccom.h> enum VMCrossTalkSockOpt { VMCI_SO_VERSION = 0, VMCI_SO_CONTEXT = IOCTL_VMCI_INIT_CONTEXT, VMCI_SO_NOTIFY_RESOURCE = IOCTL_VMCI_NOTIFY_RESOURCE, VMCI_SO_NOTIFICATIONS_RECEIVE = IOCTL_VMCI_NOTIFICATIONS_RECEIVE, VMCI_SO_VERSION2 = IOCTL_VMCI_VERSION2, VMCI_SO_QUEUEPAIR_ALLOC = IOCTL_VMCI_QUEUEPAIR_ALLOC, VMCI_SO_QUEUEPAIR_SETVA = IOCTL_VMCI_QUEUEPAIR_SETVA, VMCI_SO_QUEUEPAIR_SETPAGEFILE = IOCTL_VMCI_QUEUEPAIR_SETPAGEFILE, VMCI_SO_QUEUEPAIR_DETACH = IOCTL_VMCI_QUEUEPAIR_DETACH, VMCI_SO_DATAGRAM_SEND = IOCTL_VMCI_DATAGRAM_SEND, VMCI_SO_DATAGRAM_RECEIVE = IOCTL_VMCI_DATAGRAM_RECEIVE, VMCI_SO_DATAGRAM_REQUEST_MAP = IOCTL_VMCI_DATAGRAM_REQUEST_MAP, VMCI_SO_DATAGRAM_REMOVE_MAP = IOCTL_VMCI_DATAGRAM_REMOVE_MAP, VMCI_SO_CTX_ADD_NOTIFICATION = IOCTL_VMCI_CTX_ADD_NOTIFICATION, VMCI_SO_CTX_REMOVE_NOTIFICATION = IOCTL_VMCI_CTX_REMOVE_NOTIFICATION, VMCI_SO_CTX_GET_CPT_STATE = IOCTL_VMCI_CTX_GET_CPT_STATE, VMCI_SO_CTX_SET_CPT_STATE = IOCTL_VMCI_CTX_SET_CPT_STATE, VMCI_SO_GET_CONTEXT_ID = IOCTL_VMCI_GET_CONTEXT_ID, VMCI_SO_USERFD, }; #define VMCI_MACOS_HOST_DEVICE "com.vmware.kext.vmci" #endif /* Clean up helper macros */ #undef IOCTLCMD #if defined __cplusplus } // extern "C" #endif #endif // ifndef _VMCI_IOCONTROLS_H_ vmci-only/shared/vm_assert.h 0000444 0000000 0000000 00000024303 13432725350 015117 0 ustar root root /********************************************************* * Copyright (C) 1998-2017 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 * *********************************************************/ /* * vm_assert.h -- * * The basic assertion facility for all VMware code. * * For proper use, see bora/doc/assert and * http://vmweb.vmware.com/~mts/WebSite/guide/programming/asserts.html. */ #ifndef _VM_ASSERT_H_ #define _VM_ASSERT_H_ #define INCLUDE_ALLOW_USERLEVEL #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMKERNEL #define INCLUDE_ALLOW_VMKDRIVERS #define INCLUDE_ALLOW_VMK_MODULE #define INCLUDE_ALLOW_DISTRIBUTE #define INCLUDE_ALLOW_VMCORE #include "includeCheck.h" // XXX not necessary except some places include vm_assert.h improperly #include "vm_basic_types.h" #ifdef __cplusplus extern "C" { #endif /* * Some bits of vmcore are used in VMKernel code and cannot have * the VMKERNEL define due to other header dependencies. */ #if defined(VMKERNEL) && !defined(VMKPANIC) #define VMKPANIC 1 #endif /* * Internal macros, functions, and strings * * The monitor wants to save space at call sites, so it has specialized * functions for each situation. User level wants to save on implementation * so it uses generic functions. */ #if !defined VMM || defined MONITOR_APP // { #if defined (VMKPANIC) #include "vmk_assert.h" #else /* !VMKPANIC */ #define _ASSERT_PANIC(name) \ Panic(_##name##Fmt "\n", __FILE__, __LINE__) #define _ASSERT_PANIC_BUG(bug, name) \ Panic(_##name##Fmt " bugNr=%d\n", __FILE__, __LINE__, bug) #define _ASSERT_PANIC_NORETURN(name) \ Panic(_##name##Fmt "\n", __FILE__, __LINE__) #define _ASSERT_PANIC_BUG_NORETURN(bug, name) \ Panic(_##name##Fmt " bugNr=%d\n", __FILE__, __LINE__, bug) #endif /* VMKPANIC */ #endif // } // These strings don't have newline so that a bug can be tacked on. #define _AssertPanicFmt "PANIC %s:%d" #define _AssertAssertFmt "ASSERT %s:%d" #define _AssertVerifyFmt "VERIFY %s:%d" #define _AssertNotImplementedFmt "NOT_IMPLEMENTED %s:%d" #define _AssertNotReachedFmt "NOT_REACHED %s:%d" #define _AssertMemAllocFmt "MEM_ALLOC %s:%d" #define _AssertNotTestedFmt "NOT_TESTED %s:%d" /* * Panic and log functions */ void Log(const char *fmt, ...) PRINTF_DECL(1, 2); void Warning(const char *fmt, ...) PRINTF_DECL(1, 2); #if defined VMKPANIC void Panic_SaveRegs(void); NORETURN void Panic_NoSave(const char *fmt, ...) PRINTF_DECL(1, 2); #define Panic(fmt...) do { \ Panic_SaveRegs(); \ Panic_NoSave(fmt); \ } while(0) #else NORETURN void Panic(const char *fmt, ...) PRINTF_DECL(1, 2); #endif void LogThrottled(uint32 *count, const char *fmt, ...) PRINTF_DECL(2, 3); void WarningThrottled(uint32 *count, const char *fmt, ...) PRINTF_DECL(2, 3); #ifndef ASSERT_IFNOT /* * PR 271512: When compiling with gcc, catch assignments inside an ASSERT. * * 'UNLIKELY' is defined with __builtin_expect, which does not warn when * passed an assignment (gcc bug 36050). To get around this, we put 'cond' * in an 'if' statement and make sure it never gets executed by putting * that inside of 'if (0)'. We use gcc's statement expression syntax to * make ASSERT an expression because some code uses it that way. * * Since statement expression syntax is a gcc extension and since it's * not clear if this is a problem with other compilers, the ASSERT * definition was not changed for them. Using a bare 'cond' with the * ternary operator may provide a solution. */ #ifdef __GNUC__ #define ASSERT_IFNOT(cond, panic) \ ({if (UNLIKELY(!(cond))) { panic; if (0) { if (cond) {;}}} (void)0;}) #else #define ASSERT_IFNOT(cond, panic) \ (UNLIKELY(!(cond)) ? (panic) : (void)0) #endif #endif /* * Assert, panic, and log macros * * Some of these are redefined below undef !VMX86_DEBUG. * ASSERT() is special cased because of interaction with Windows DDK. */ #if defined VMX86_DEBUG #undef ASSERT #define ASSERT(cond) ASSERT_IFNOT(cond, _ASSERT_PANIC(AssertAssert)) #define ASSERT_BUG(bug, cond) \ ASSERT_IFNOT(cond, _ASSERT_PANIC_BUG(bug, AssertAssert)) #endif #undef VERIFY #define VERIFY(cond) \ ASSERT_IFNOT(cond, _ASSERT_PANIC_NORETURN(AssertVerify)) #define VERIFY_BUG(bug, cond) \ ASSERT_IFNOT(cond, _ASSERT_PANIC_BUG_NORETURN(bug, AssertVerify)) #define PANIC() _ASSERT_PANIC(AssertPanic) #define PANIC_BUG(bug) _ASSERT_PANIC_BUG(bug, AssertPanic) #define ASSERT_NOT_IMPLEMENTED(cond) \ ASSERT_IFNOT(cond, NOT_IMPLEMENTED()) #if defined VMKPANIC || defined VMM #define NOT_IMPLEMENTED() _ASSERT_PANIC_NORETURN(AssertNotImplemented) #else #define NOT_IMPLEMENTED() _ASSERT_PANIC(AssertNotImplemented) #endif #if defined VMM #define NOT_IMPLEMENTED_BUG(bug) \ _ASSERT_PANIC_BUG_NORETURN(bug, AssertNotImplemented) #else #define NOT_IMPLEMENTED_BUG(bug) _ASSERT_PANIC_BUG(bug, AssertNotImplemented) #endif #if defined VMKPANIC || defined VMM #define NOT_REACHED() _ASSERT_PANIC_NORETURN(AssertNotReached) #else #define NOT_REACHED() _ASSERT_PANIC(AssertNotReached) #endif #define ASSERT_MEM_ALLOC(cond) \ ASSERT_IFNOT(cond, _ASSERT_PANIC(AssertMemAlloc)) #ifdef VMX86_DEVEL #define NOT_TESTED() Warning(_AssertNotTestedFmt "\n", __FILE__, __LINE__) #else #define NOT_TESTED() Log(_AssertNotTestedFmt "\n", __FILE__, __LINE__) #endif #define ASSERT_NO_INTERRUPTS() ASSERT(!INTERRUPTS_ENABLED()) #define ASSERT_HAS_INTERRUPTS() ASSERT(INTERRUPTS_ENABLED()) #define ASSERT_NOT_TESTED(cond) (UNLIKELY(!(cond)) ? NOT_TESTED() : (void)0) #define NOT_TESTED_ONCE() DO_ONCE(NOT_TESTED()) #define NOT_TESTED_1024() \ do { \ static uint16 count = 0; \ if (UNLIKELY(count == 0)) { NOT_TESTED(); } \ count = (count + 1) & 1023; \ } while (0) #define LOG_ONCE(_s) DO_ONCE(Log _s) /* * Redefine macros that are only in debug versions */ #if !defined VMX86_DEBUG // { #undef ASSERT #define ASSERT(cond) ((void)0) #define ASSERT_BUG(bug, cond) ((void)0) /* * Expand NOT_REACHED() as appropriate for each situation. * * Mainly, we want the compiler to infer the same control-flow * information as it would from Panic(). Otherwise, different * compilation options will lead to different control-flow-derived * errors, causing some make targets to fail while others succeed. * * VC++ has the __assume() built-in function which we don't trust * (see bug 43485); gcc has no such construct; we just panic in * userlevel code. The monitor doesn't want to pay the size penalty * (measured at 212 bytes for the release vmm for a minimal infinite * loop; panic would cost even more) so it does without and lives * with the inconsistency. */ #if defined VMKPANIC || defined VMM #undef NOT_REACHED #if defined __GNUC__ && (__GNUC__ > 4 || __GNUC__ == 4 && __GNUC_MINOR__ >= 5) #define NOT_REACHED() (__builtin_unreachable()) #else #define NOT_REACHED() ((void)0) #endif #else // keep debug definition #endif #undef LOG_UNEXPECTED #define LOG_UNEXPECTED(bug) ((void)0) #undef ASSERT_NOT_TESTED #define ASSERT_NOT_TESTED(cond) ((void)0) #undef NOT_TESTED #define NOT_TESTED() ((void)0) #undef NOT_TESTED_ONCE #define NOT_TESTED_ONCE() ((void)0) #undef NOT_TESTED_1024 #define NOT_TESTED_1024() ((void)0) #endif // !VMX86_DEBUG } /* * Compile-time assertions. * * ASSERT_ON_COMPILE does not use the common * switch (0) { case 0: case (e): ; } trick because some compilers (e.g. MSVC) * generate code for it. * * The implementation uses both enum and typedef because the typedef alone is * insufficient; gcc allows arrays to be declared with non-constant expressions * (even in typedefs, where it makes no sense). * * NOTE: if GCC ever changes so that it ignores unused types altogether, this * assert might not fire! We explicitly mark it as unused because GCC 4.8+ * uses -Wunused-local-typedefs as part of -Wall, which means the typedef will * generate a warning. */ #if defined(_Static_assert) || defined(__cplusplus) || \ !defined(__GNUC__) || __GNUC__ < 4 || (__GNUC__ == 4 && __GNUC_MINOR__ < 6) #define ASSERT_ON_COMPILE(e) \ do { \ enum { AssertOnCompileMisused = ((e) ? 1 : -1) }; \ UNUSED_TYPE(typedef char AssertOnCompileFailed[AssertOnCompileMisused]); \ } while (0) #else #define ASSERT_ON_COMPILE(e) \ do { \ _Static_assert(e, #e); \ } while (0) #endif /* * To put an ASSERT_ON_COMPILE() outside a function, wrap it * in MY_ASSERTS(). The first parameter must be unique in * each .c file where it appears. For example, * * MY_ASSERTS(FS3_INT, * ASSERT_ON_COMPILE(sizeof(FS3_DiskLock) == 128); * ASSERT_ON_COMPILE(sizeof(FS3_DiskLockReserved) == DISK_BLOCK_SIZE); * ASSERT_ON_COMPILE(sizeof(FS3_DiskBlock) == DISK_BLOCK_SIZE); * ASSERT_ON_COMPILE(sizeof(Hardware_DMIUUID) == 16); * ) * * Caution: ASSERT() within MY_ASSERTS() is silently ignored. * The same goes for anything else not evaluated at compile time. */ #define MY_ASSERTS(name, assertions) \ static INLINE void name(void) { \ assertions \ } #ifdef __cplusplus } /* extern "C" */ #endif #endif /* ifndef _VM_ASSERT_H_ */ vmci-only/shared/compat_sock.h 0000444 0000000 0000000 00000006002 13432725347 015420 0 ustar root root /********************************************************* * Copyright (C) 2003 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 * *********************************************************/ #ifndef __COMPAT_SOCK_H__ # define __COMPAT_SOCK_H__ #include <linux/stddef.h> /* for NULL */ #include <net/sock.h> #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 35) static inline wait_queue_head_t *sk_sleep(struct sock *sk) { return sk->sk_sleep; } #endif /* * Prior to 2.6.24, there was no sock network namespace member. In 2.6.26, it * was hidden behind accessor functions so that its behavior could vary * depending on the value of CONFIG_NET_NS. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 26) # define compat_sock_net(sk) sock_net(sk) #elif LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 24) # define compat_sock_net(sk) sk->sk_net #endif #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 16) #ifndef CONFIG_FILTER # define sk_filter(sk, skb, needlock) 0 #endif /* Taken from 2.6.16's sock.h and modified for macro. */ # define compat_sk_receive_skb(sk, skb, nested) \ ({ \ int rc = NET_RX_SUCCESS; \ \ if (sk_filter(sk, skb, 0)) { \ kfree_skb(skb); \ } else { \ skb->dev = NULL; \ bh_lock_sock(sk); \ if (!sock_owned_by_user(sk)) { \ rc = (sk)->sk_backlog_rcv(sk, skb); \ } else { \ sk_add_backlog(sk, skb); \ } \ bh_unlock_sock(sk); \ } \ \ sock_put(sk); \ rc; \ }) #elif LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 20) # define compat_sk_receive_skb(sk, skb, nested) sk_receive_skb(sk, skb) #else # define compat_sk_receive_skb(sk, skb, nested) sk_receive_skb(sk, skb, nested) #endif #endif /* __COMPAT_SOCK_H__ */ vmci-only/shared/compat_highmem.h 0000444 0000000 0000000 00000002423 13432725347 016102 0 ustar root root /********************************************************* * Copyright (C) 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 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 * *********************************************************/ #ifndef __COMPAT_HIGHMEM_H__ # define __COMPAT_HIGHMEM_H__ #include <linux/highmem.h> #if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 5, 0) # define compat_kmap_atomic(_page) kmap_atomic(_page) # define compat_kunmap_atomic(_page) kunmap_atomic(_page) #else # define compat_kmap_atomic(_page) kmap_atomic((_page), KM_USER0) # define compat_kunmap_atomic(_page) kunmap_atomic((_page), KM_USER0) #endif #endif /* __COMPAT_HIGHMEM_H__ */ vmci-only/shared/compat_namei.h 0000444 0000000 0000000 00000003416 13432725347 015560 0 ustar root root /********************************************************* * Copyright (C) 2006 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 * *********************************************************/ #ifndef __COMPAT_NAMEI_H__ # define __COMPAT_NAMEI_H__ #include <linux/namei.h> /* * In 2.6.25-rc2, dentry and mount objects were removed from the nameidata * struct. They were both replaced with a struct path. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 25) #define compat_vmw_nd_to_dentry(nd) (nd).path.dentry #else #define compat_vmw_nd_to_dentry(nd) (nd).dentry #endif /* In 2.6.25-rc2, path_release(&nd) was replaced with path_put(&nd.path). */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 25) #define compat_path_release(nd) path_put(&(nd)->path) #else #define compat_path_release(nd) path_release(nd) #endif /* path_lookup was removed in 2.6.39 merge window VFS merge */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 38) #define compat_path_lookup(name, flags, nd) kern_path(name, flags, &((nd)->path)) #else #define compat_path_lookup(name, flags, nd) path_lookup(name, flags, nd) #endif #endif /* __COMPAT_NAMEI_H__ */ vmci-only/shared/compat_kernel.h 0000444 0000000 0000000 00000002735 13432725347 015752 0 ustar root root /********************************************************* * Copyright (C) 2004 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 * *********************************************************/ #ifndef __COMPAT_KERNEL_H__ # define __COMPAT_KERNEL_H__ #include <asm/unistd.h> #include <linux/kernel.h> /* * container_of was introduced in 2.5.28 but it's easier to check like this. */ #ifndef container_of #define container_of(ptr, type, member) ({ \ const typeof( ((type *)0)->member ) *__mptr = (ptr); \ (type *)( (char *)__mptr - offsetof(type,member) );}) #endif /* * vsnprintf became available in 2.4.10. For older kernels, just fall back on * vsprintf. */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 10) #define vsnprintf(str, size, fmt, args) vsprintf(str, fmt, args) #endif #endif /* __COMPAT_KERNEL_H__ */ vmci-only/shared/circList.h 0000444 0000000 0000000 00000025262 13432725346 014702 0 ustar root root /********************************************************* * Copyright (C) 1998-2017 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 * *********************************************************/ /* * circList.h -- * * macros, prototypes and struct definitions for double-linked * circular lists. */ #ifndef _CIRCLIST_H_ #define _CIRCLIST_H_ #define INCLUDE_ALLOW_USERLEVEL #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMCORE #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMKERNEL #include "includeCheck.h" #include "vmware.h" #if defined(__cplusplus) extern "C" { #endif typedef struct ListItem { struct ListItem *prev; struct ListItem *next; } ListItem; /* *---------------------------------------------------------------------- * * CircList_IsEmpty -- * * A NULL list is an empty list. * * Result: * TRUE if list is empty, FALSE otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ static INLINE Bool CircList_IsEmpty(const ListItem *item) // IN { return item == NULL; } /* *---------------------------------------------------------------------- * * CircList_InitItem -- * * Initialize item as a single-element circular list. * * Result: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ static INLINE void CircList_InitItem(ListItem *item) // OUT { item->prev = item->next = item; } /* *---------------------------------------------------------------------- * * CircList_First -- * * Return first item in the list. * * Result: * First item. * * Side effects: * None. * *---------------------------------------------------------------------- */ static INLINE ListItem * CircList_First(ListItem *item) // IN { return item; } /* *---------------------------------------------------------------------- * * CircList_Last -- * * Return last item in the list. * * Result: * Last item. * * Side effects: * None. * *---------------------------------------------------------------------- */ static INLINE ListItem * CircList_Last(ListItem *item) { return item->prev; } /* * CIRC_LIST_CONTAINER - get the struct for this entry (like list_entry) * @ptr: the &struct ListItem pointer. * @type: the type of the struct this is embedded in. * @member: the name of the list struct within the struct. */ #define CIRC_LIST_CONTAINER(ptr, type, member) \ VMW_CONTAINER_OF(ptr, type, member) /* * Historical name, left here to reduce churn. * TODO: remove, all LIST_CONTAINER uses should be * VMW_CONTAINER_OF and stop depending on circList.h * to provide the definition. */ #define LIST_CONTAINER(ptr, type, member) VMW_CONTAINER_OF(ptr, type, member) /* * LIST_SCAN_FROM scans the list from "from" up until "until". * The loop variable p should not be destroyed in the process. * "from" is an element in the list where to start scanning. * "until" is the element where search should stop. * member is the field to use for the search - either "next" or "prev". */ #define CIRC_LIST_SCAN_FROM(p, from, until, member) \ for (p = (from); (p) != NULL; \ (p) = (((p)->member == (until)) ? NULL : (p)->member)) /* scan the entire list (non-destructively) */ #define CIRC_LIST_SCAN(p, l) \ CIRC_LIST_SCAN_FROM(p, CircList_First(l), CircList_First(l), next) /* scan the entire list where loop element may be destroyed */ #define CIRC_LIST_SCAN_SAFE(p, pn, l) \ if (!CircList_IsEmpty(l)) \ for (p = (l), (pn) = CircList_Next(p, l); (p) != NULL; \ (p) = (pn), (pn) = CircList_Next(p, l)) /* scan the entire list backwards where loop element may be destroyed */ #define CIRC_LIST_SCAN_BACK_SAFE(p, pn, l) \ if (!CircList_IsEmpty(l)) \ for (p = CircList_Last(l), (pn) = CircList_Prev(p, l); (p) != NULL; \ (p) = (pn), (pn) = CircList_Prev(p, l)) /* *---------------------------------------------------------------------- * * CircList_Next -- * * Returns the next member of a doubly linked list, or NULL if last. * Assumes: p is member of the list headed by head. * * Result: * If head or p is NULL, return NULL. Otherwise, * next list member (or null if last). * * Side effects: * None. * *---------------------------------------------------------------------- */ static INLINE ListItem * CircList_Next(ListItem *p, // IN ListItem *head) // IN { if (head == NULL || p == NULL) { return NULL; } /* both p and head are non-null */ p = p->next; return p == head ? NULL : p; } /* *---------------------------------------------------------------------- * * CircList_Prev -- * * Returns the prev member of a doubly linked list, or NULL if first. * Assumes: p is member of the list headed by head. * * Result: * If head or prev is NULL, return NULL. Otherwise, * prev list member (or null if first). * * Side effects: * None. * *---------------------------------------------------------------------- */ static INLINE ListItem * CircList_Prev(ListItem *p, // IN ListItem *head) // IN { if (head == NULL || p == NULL) { return NULL; } /* both p and head are non-null */ return p == head ? NULL : p->prev; } /* *---------------------------------------------------------------------- * * CircList_DeleteItem -- * * Deletes a member of a doubly linked list, possibly modifies the * list header itself. * Assumes neither p nor headp is null and p is a member of *headp. * * Result: * None * * Side effects: * Modifies *headp. * *---------------------------------------------------------------------- */ static INLINE void CircList_DeleteItem(ListItem *p, // IN ListItem **headp) // IN/OUT { ListItem *next; ASSERT(p != NULL); ASSERT(headp != NULL); next = p->next; if (p == next) { *headp = NULL; } else { next->prev = p->prev; p->prev->next = next; if (*headp == p) { *headp = next; } } } /* *---------------------------------------------------------------------- * * CircList_Queue -- * * Adds a new member to the back of a doubly linked list (queue) * Assumes neither p nor headp is null and p is not a member of *headp. * * Result: * None * * Side effects: * Modifies *headp. * *---------------------------------------------------------------------- */ static INLINE void CircList_Queue(ListItem *p, // IN ListItem **headp) // IN/OUT { ListItem *head; head = *headp; if (CircList_IsEmpty(head)) { CircList_InitItem(p); *headp = p; } else { p->prev = head->prev; p->next = head; p->prev->next = p; head->prev = p; } } /* *---------------------------------------------------------------------- * * CircList_Push -- * * Adds a new member to the front of a doubly linked list (stack) * Assumes neither p nor headp is null and p is not a member of *headp. * * Result: * None * * Side effects: * Modifies *headp. * *---------------------------------------------------------------------- */ static INLINE void CircList_Push(ListItem *p, // IN ListItem **headp) // IN/OUT { CircList_Queue(p, headp); *headp = p; } /* *---------------------------------------------------------------------- * * CircList_Splice -- * * Make a single list {l1 l2} from {l1} and {l2} and return it. * It is okay for one or both lists to be NULL. * No checking is done. It is assumed that l1 and l2 are two * distinct lists. * * Result: * A list { l1 l2 }. * * Side effects: * Modifies l1 and l2 list pointers. * *---------------------------------------------------------------------- */ static INLINE ListItem * CircList_Splice(ListItem *l1, // IN ListItem *l2) // IN { ListItem *l1Last, *l2Last; if (CircList_IsEmpty(l1)) { return l2; } if (CircList_IsEmpty(l2)) { return l1; } l1Last = l1->prev; /* last elem of l1 */ l2Last = l2->prev; /* last elem of l2 */ /* * l1 -> ... -> l1Last l2 -> ... l2Last */ l1Last->next = l2; l2->prev = l1Last; l1->prev = l2Last; l2Last->next = l1; return l1; } #if 0 /* Presently unused, enable if a use is found */ /* *---------------------------------------------------------------------- * * CircList_Split -- * * Make a list l = {l1 l2} into two separate lists {l1} and {l2}, where: * l = { ... x -> p -> ... } split into: * l1 = { ... -> x } * l2 = { p -> ... } * Assumes neither p nor l is null and p is a member of l. * If p is the first element of l, then l1 will be NULL. * * Result: * None. * * Side effects: * Sets *l1p and *l2p to the resulting two lists. * Modifies l's pointers. * *---------------------------------------------------------------------- */ static INLINE void CircList_Split(ListItem *p, // IN ListItem *l, // IN ListItem **l1p, // OUT ListItem **l2p) // OUT { ListItem *last; if (p == CircList_First(l)) { /* first element */ *l1p = NULL; *l2p = l; return; } last = l->prev; *l1p = l; p->prev->next = l; l->prev = p->prev; *l2p = p; p->prev = last; last->next = p; } #endif /* *---------------------------------------------------------------------- * * CircList_Size -- * * Return the number of items in the list. * * Result: * The number of items in the list. * * Side effects: * None. * *---------------------------------------------------------------------- */ static INLINE int CircList_Size(ListItem *head) // IN { ListItem *li; int ret = 0; CIRC_LIST_SCAN(li, head) { ret++; } return ret; } #if defined(__cplusplus) } // extern "C" #endif #endif /* _CIRCLIST_H_ */ vmci-only/shared/vmware.h 0000444 0000000 0000000 00000003507 13432725350 014420 0 ustar root root /********************************************************* * Copyright (C) 2003-2016 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 * *********************************************************/ /* * vmware.h -- * * Standard include file for VMware source code. */ #ifndef _VMWARE_H_ #define _VMWARE_H_ #define INCLUDE_ALLOW_USERLEVEL #define INCLUDE_ALLOW_VMCORE #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMKERNEL #define INCLUDE_ALLOW_VMK_MODULE #define INCLUDE_ALLOW_DISTRIBUTE #include "includeCheck.h" #include "vm_basic_types.h" #include "vm_basic_defs.h" #include "vm_assert.h" /* * Global error codes. Currently used internally, but may be exported * to customers one day, like VM_E_XXX in vmcontrol_constants.h */ typedef enum VMwareStatus { VMWARE_STATUS_SUCCESS, /* success */ VMWARE_STATUS_ERROR, /* generic error */ VMWARE_STATUS_NOMEM, /* generic memory allocation error */ VMWARE_STATUS_INSUFFICIENT_RESOURCES, /* internal or system resource limit exceeded */ VMWARE_STATUS_INVALID_ARGS /* invalid arguments */ } VMwareStatus; #define VMWARE_SUCCESS(s) ((s) == VMWARE_STATUS_SUCCESS) #endif // ifndef _VMWARE_H_ vmci-only/shared/compat_netdevice.h 0000444 0000000 0000000 00000024324 13432725347 016436 0 ustar root root /********************************************************* * Copyright (C) 2002 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 * *********************************************************/ #ifndef __COMPAT_NETDEVICE_H__ # define __COMPAT_NETDEVICE_H__ #include <linux/skbuff.h> #include <linux/rtnetlink.h> #include <linux/netdevice.h> #include <linux/etherdevice.h> #include <linux/pci.h> /* * The enet_statistics structure moved from linux/if_ether.h to * linux/netdevice.h and is renamed net_device_stats in 2.1.25 --hpreg */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 1, 25) # include <linux/if_ether.h> # define net_device_stats enet_statistics #endif /* The netif_rx_ni() API appeared in 2.4.8 --hpreg */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 8) # define netif_rx_ni netif_rx #endif /* The device struct was renamed net_device in 2.3.14 --hpreg */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 3, 14) # define net_device device #endif /* * SET_MODULE_OWNER appeared sometime during 2.3.x. It was setting * dev->owner = THIS_MODULE until 2.5.70, where netdevice refcounting * was completely changed. SET_MODULE_OWNER was nop for whole * 2.6.x series, and finally disappeared in 2.6.24. * * MOD_xxx_USE_COUNT wrappers are here, as they must be mutually * exclusive with SET_MODULE_OWNER call. */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 0) # define COMPAT_SET_MODULE_OWNER(dev) do {} while (0) # define COMPAT_NETDEV_MOD_INC_USE_COUNT MOD_INC_USE_COUNT # define COMPAT_NETDEV_MOD_DEC_USE_COUNT MOD_DEC_USE_COUNT #else # if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0) # define COMPAT_SET_MODULE_OWNER(dev) SET_MODULE_OWNER(dev) # else # define COMPAT_SET_MODULE_OWNER(dev) do {} while (0) # endif # define COMPAT_NETDEV_MOD_INC_USE_COUNT do {} while (0) # define COMPAT_NETDEV_MOD_DEC_USE_COUNT do {} while (0) #endif /* * SET_NETDEV_DEV appeared sometime during 2.5.x, and later was * crossported to various 2.4.x kernels (as dummy macro). */ #ifdef SET_NETDEV_DEV # define COMPAT_SET_NETDEV_DEV(dev, pdev) SET_NETDEV_DEV(dev, pdev) #else # define COMPAT_SET_NETDEV_DEV(dev, pdev) do {} while (0) #endif /* * Build alloc_etherdev API on the top of init_etherdev. For 2.0.x kernels * we must provide dummy init method, otherwise register_netdev does * nothing. */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 3) #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 2, 0) int vmware_dummy_init(struct net_device *dev) { return 0; } #endif static inline struct net_device* compat_alloc_etherdev(int priv_size) { struct net_device* dev; int size = sizeof *dev + priv_size; /* * The name is dynamically allocated before 2.4.0, but * is an embedded array in later kernels. */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 0) size += sizeof("ethXXXXXXX"); #endif dev = kmalloc(size, GFP_KERNEL); if (dev) { memset(dev, 0, size); if (priv_size) { dev->priv = dev + 1; } #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 0) dev->name = (char *)(dev + 1) + priv_size; #endif #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 2, 0) dev->init = vmware_dummy_init; #endif if (init_etherdev(dev, 0) != dev) { kfree(dev); dev = NULL; } } return dev; } #else #define compat_alloc_etherdev(sz) alloc_etherdev(sz) #endif /* * alloc_netdev and free_netdev are there since 2.4.23. Their use is mandatory * since 2.6.24. */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 23) static inline struct net_device * compat_alloc_netdev(int priv_size, const char *mask, void (*setup)(struct net_device *)) { struct net_device *dev; int netdev_size = sizeof *dev; int alloc_size; # if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 0) netdev_size += IFNAMSIZ; # endif alloc_size = netdev_size + priv_size; dev = kmalloc(alloc_size, GFP_KERNEL); if (dev) { memset(dev, 0, alloc_size); dev->priv = (char*)dev + netdev_size; setup(dev); # if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 0) dev->name = (char*)(dev + 1); # endif strcpy(dev->name, mask); } return dev; } # define compat_free_netdev(dev) kfree(dev) #else # define compat_alloc_netdev(size, mask, setup) alloc_netdev(size, mask, setup) # define compat_free_netdev(dev) free_netdev(dev) #endif /* netdev_priv() appeared in 2.6.3 */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 3) # define compat_netdev_priv(netdev) (netdev)->priv #else # define compat_netdev_priv(netdev) netdev_priv(netdev) #endif /* * In 3.1 merge window feature maros were removed from mainline, * so let's add back ones we care about. */ #if !defined(HAVE_NET_DEVICE_OPS) && \ LINUX_VERSION_CODE >= KERNEL_VERSION(3, 0, 0) # define HAVE_NET_DEVICE_OPS 1 #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 9) # define COMPAT_NETDEV_TX_OK NETDEV_TX_OK # define COMPAT_NETDEV_TX_BUSY NETDEV_TX_BUSY #else # define COMPAT_NETDEV_TX_OK 0 # define COMPAT_NETDEV_TX_BUSY 1 #endif /* unregister_netdevice_notifier was not safe prior to 2.6.17 */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 17) && \ !defined(ATOMIC_NOTIFIER_INIT) /* pre 2.6.17 and not patched */ static inline int compat_unregister_netdevice_notifier(struct notifier_block *nb) { int err; rtnl_lock(); err = unregister_netdevice_notifier(nb); rtnl_unlock(); return err; } #else /* post 2.6.17 or patched */ #define compat_unregister_netdevice_notifier(_nb) \ unregister_netdevice_notifier(_nb); #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 24) || defined(__VMKLNX__) # define compat_netif_napi_add(dev, napi, poll, quota) \ netif_napi_add(dev, napi, poll, quota) # if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 30) || \ defined VMW_NETIF_SINGLE_NAPI_PARM # define compat_napi_complete(dev, napi) napi_complete(napi) # define compat_napi_schedule(dev, napi) napi_schedule(napi) # else # define compat_napi_complete(dev, napi) netif_rx_complete(dev, napi) # define compat_napi_schedule(dev, napi) netif_rx_schedule(dev, napi) # endif # define compat_napi_enable(dev, napi) napi_enable(napi) # define compat_napi_disable(dev, napi) napi_disable(napi) #else # define compat_napi_complete(dev, napi) netif_rx_complete(dev) # define compat_napi_schedule(dev, napi) netif_rx_schedule(dev) # define compat_napi_enable(dev, napi) netif_poll_enable(dev) # define compat_napi_disable(dev, napi) netif_poll_disable(dev) /* RedHat ported GRO to 2.6.18 bringing new napi_struct with it */ # if defined NETIF_F_GRO # define compat_netif_napi_add(netdev, napi, pollcb, quota) \ do { \ (netdev)->poll = (pollcb); \ (netdev)->weight = (quota);\ (napi)->dev = (netdev); \ } while (0) # else struct napi_struct { int dummy; }; # define compat_netif_napi_add(dev, napi, pollcb, quota) \ do { \ (dev)->poll = (pollcb); \ (dev)->weight = (quota);\ } while (0) # endif #endif #ifdef NETIF_F_TSO6 # define COMPAT_NETIF_F_TSO (NETIF_F_TSO6 | NETIF_F_TSO) #else # define COMPAT_NETIF_F_TSO (NETIF_F_TSO) #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 18) # define compat_netif_tx_lock(dev) netif_tx_lock(dev) # define compat_netif_tx_unlock(dev) netif_tx_unlock(dev) #elif LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 16) # define compat_netif_tx_lock(dev) spin_lock(&dev->xmit_lock) # define compat_netif_tx_unlock(dev) spin_unlock(&dev->xmit_lock) #else /* Vendor backporting (SLES 10) has muddled the tx_lock situation. Pick whichever * of the above works for you. */ # define compat_netif_tx_lock(dev) do {} while (0) # define compat_netif_tx_unlock(dev) do {} while (0) #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 37) # define COMPAT_VLAN_GROUP_ARRAY_LEN VLAN_N_VID # define compat_flush_scheduled_work(work) cancel_work_sync(work) #else # define COMPAT_VLAN_GROUP_ARRAY_LEN VLAN_GROUP_ARRAY_LEN # define compat_flush_scheduled_work(work) flush_scheduled_work() #endif /* * For kernel versions older than 2.6.29, where pci_msi_enabled is not * available, check if * 1. CONFIG_PCI_MSI is present * 2. kernel version is newer than 2.6.25 (because multiqueue is not * supporter) in kernels older than that) * 3. msi can be enabled. If it fails it means that MSI is not available. * When all the above are true, return non-zero so that multiple queues will be * allowed in the driver. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 29) # define compat_multiqueue_allowed(dev) pci_msi_enabled() #else # if defined CONFIG_PCI_MSI && LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 25) static inline int compat_multiqueue_allowed(struct pci_dev *dev) { int ret; if (!pci_enable_msi(dev)) ret = 1; else ret = 0; pci_disable_msi(dev); return ret; } # else # define compat_multiqueue_allowed(dev) (0) # endif #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 37) # define compat_vlan_get_protocol(skb) vlan_get_protocol(skb) #else # define compat_vlan_get_protocol(skb) (skb->protocol) #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 3, 0) typedef netdev_features_t compat_netdev_features_t; #else typedef u32 compat_netdev_features_t; #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(4, 7, 0) || defined(VMW_NETIF_TRANS_UPDATE) #define compat_netif_trans_update(d) netif_trans_update(d) #else #define compat_netif_trans_update(d) do { (d)->trans_start = jiffies; } while (0) #endif #endif /* __COMPAT_NETDEVICE_H__ */ vmci-only/shared/compat_dcache.h 0000444 0000000 0000000 00000004003 13432725347 015667 0 ustar root root /********************************************************* * Copyright (C) 2013 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 * *********************************************************/ #ifndef __COMPAT_DCACHE_H__ # define __COMPAT_DCACHE_H__ #include <linux/dcache.h> /* * per-dentry locking was born in 2.5.62. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 5, 62) #define compat_lock_dentry(dentry) spin_lock(&dentry->d_lock) #define compat_unlock_dentry(dentry) spin_unlock(&dentry->d_lock) #else #define compat_lock_dentry(dentry) do {} while (0) #define compat_unlock_dentry(dentry) do {} while (0) #endif /* * d_alloc_name was born in 2.6.10. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 10) #define compat_d_alloc_name(parent, s) d_alloc_name(parent, s) #else #define compat_d_alloc_name(parent, s) \ ({ \ struct qstr q; \ q.name = s; \ q.len = strlen(s); \ q.hash = full_name_hash(q.name, q.len); \ d_alloc(parent, &q); \ }) #endif #endif /* __COMPAT_DCACHE_H__ */ vmci-only/shared/compat_pci_mapping.h 0000444 0000000 0000000 00000004741 13432725347 016757 0 ustar root root /********************************************************* * Copyright (C) 2008 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 * *********************************************************/ #ifndef __COMPAT_PCI_MAPPING_H__ #define __COMPAT_PCI_MAPPING_H__ #include <asm/types.h> #include <asm/io.h> #include <linux/pci.h> #if LINUX_VERSION_CODE < KERNEL_VERSION(2,3,41) typedef u32 dma_addr_t; static __inline__ int get_order(unsigned long size) { int order; size = (size - 1) >> (PAGE_SHIFT - 1); order = -1; do { size >>= 1; order++; } while (size); return order; } static inline void * compat_pci_alloc_consistent(struct pci_dev *hwdev, size_t size, dma_addr_t *dma_handle) { void *ptr = (void *)__get_free_pages(GFP_ATOMIC, get_order(size)); if (ptr) { memset(ptr, 0, size); *dma_handle = virt_to_phys(ptr); } return ptr; } static inline void compat_pci_free_consistent(struct pci_dev *hwdev, size_t size, void *vaddr, dma_addr_t dma_handle) { free_pages((unsigned long)vaddr, get_order(size)); } static inline dma_addr_t compat_pci_map_single(struct pci_dev *hwdev, void *ptr, size_t size, int direction) { return virt_to_phys(ptr); } static inline void compat_pci_unmap_single(struct pci_dev *hwdev, dma_addr_t dma_addr, size_t size, int direction) { } #else #define compat_pci_alloc_consistent(hwdev, size, dma_handle) \ pci_alloc_consistent(hwdev, size, dma_handle) #define compat_pci_free_consistent(hwdev, size, vaddr, dma_handle) \ pci_free_consistent(hwdev, size, vaddr, dma_handle) #define compat_pci_map_single(hwdev, ptr, size, direction) \ pci_map_single(hwdev, ptr, size, direction) #define compat_pci_unmap_single(hwdev, dma_addr, size, direction) \ pci_unmap_single(hwdev, dma_addr, size, direction) #endif #endif vmci-only/shared/vm_basic_asm_x86.h 0000444 0000000 0000000 00000042724 13432725350 016253 0 ustar root root /********************************************************* * Copyright (C) 1998-2017 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 * *********************************************************/ /* * vm_basic_asm_x86.h * * Basic IA32 asm macros */ #ifndef _VM_BASIC_ASM_X86_H_ #define _VM_BASIC_ASM_X86_H_ #define INCLUDE_ALLOW_USERLEVEL #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMK_MODULE #define INCLUDE_ALLOW_VMKERNEL #define INCLUDE_ALLOW_DISTRIBUTE #define INCLUDE_ALLOW_VMCORE #include "includeCheck.h" #if defined __cplusplus extern "C" { #endif #ifdef VM_X86_64 /* * The gcc inline asm uses the "A" constraint which differs in 32 & 64 * bit mode. 32 bit means eax and edx, 64 means rax or rdx. */ #error "x86-64 not supported" #endif /* * XTEST * Return TRUE if processor is in transaction region. * */ #if defined(__GNUC__) && (defined(VMM) || defined(VMKERNEL) || defined(FROBOS)) static INLINE Bool xtest(void) { uint8 al; __asm__ __volatile__(".byte 0x0f, 0x01, 0xd6 # xtest \n" "setnz %%al\n" : "=a"(al) : : "cc"); return al; } #endif /* __GNUC__ */ /* * FXSAVE/FXRSTOR * save/restore SIMD/MMX fpu state * * The pointer passed in must be 16-byte aligned. * * Intel and AMD processors behave differently w.r.t. fxsave/fxrstor. Intel * processors unconditionally save the exception pointer state (instruction * ptr., data ptr., and error instruction opcode). FXSAVE_ES1 and FXRSTOR_ES1 * work correctly for Intel processors. * * AMD processors only save the exception pointer state if ES=1. This leads to a * security hole whereby one process/VM can inspect the state of another process * VM. The AMD recommended workaround involves clobbering the exception pointer * state unconditionally, and this is implemented in FXRSTOR_AMD_ES0. Note that * FXSAVE_ES1 will only save the exception pointer state for AMD processors if * ES=1. * * The workaround (FXRSTOR_AMD_ES0) only costs 1 cycle more than just doing an * fxrstor, on both AMD Opteron and Intel Core CPUs. */ #if defined(__GNUC__) static INLINE void FXSAVE_ES1(void *save) { __asm__ __volatile__ ("fxsave %0\n" : "=m" (*(uint8 *)save) : : "memory"); } static INLINE void FXRSTOR_ES1(const void *load) { __asm__ __volatile__ ("fxrstor %0\n" : : "m" (*(const uint8 *)load) : "memory"); } static INLINE void FXRSTOR_AMD_ES0(const void *load) { uint64 dummy = 0; __asm__ __volatile__ ("fnstsw %%ax \n" // Grab x87 ES bit "bt $7,%%ax \n" // Test ES bit "jnc 1f \n" // Jump if ES=0 "fnclex \n" // ES=1. Clear it so fild doesn't trap "1: \n" "ffree %%st(7) \n" // Clear tag bit - avoid poss. stack overflow "fildl %0 \n" // Dummy Load from "safe address" changes all // x87 exception pointers. "fxrstor %1 \n" : : "m" (dummy), "m" (*(const uint8 *)load) : "ax", "memory"); } #endif /* __GNUC__ */ /* * XSAVE/XRSTOR * save/restore GSSE/SIMD/MMX fpu state * * The pointer passed in must be 64-byte aligned. * See above comment for more information. */ #if defined(__GNUC__) && (defined(VMM) || defined(VMKERNEL) || defined(FROBOS)) static INLINE void XSAVE_ES1(void *save, uint64 mask) { #if __GNUC__ < 4 || __GNUC__ == 4 && __GNUC_MINOR__ == 1 __asm__ __volatile__ ( ".byte 0x0f, 0xae, 0x21 \n" : : "c" ((uint8 *)save), "a" ((uint32)mask), "d" ((uint32)(mask >> 32)) : "memory"); #else __asm__ __volatile__ ( "xsave %0 \n" : "=m" (*(uint8 *)save) : "a" ((uint32)mask), "d" ((uint32)(mask >> 32)) : "memory"); #endif } static INLINE void XSAVEOPT_ES1(void *save, uint64 mask) { __asm__ __volatile__ ( ".byte 0x0f, 0xae, 0x31 \n" : : "c" ((uint8 *)save), "a" ((uint32)mask), "d" ((uint32)(mask >> 32)) : "memory"); } static INLINE void XRSTOR_ES1(const void *load, uint64 mask) { #if __GNUC__ < 4 || __GNUC__ == 4 && __GNUC_MINOR__ == 1 __asm__ __volatile__ ( ".byte 0x0f, 0xae, 0x29 \n" : : "c" ((const uint8 *)load), "a" ((uint32)mask), "d" ((uint32)(mask >> 32)) : "memory"); #else __asm__ __volatile__ ( "xrstor %0 \n" : : "m" (*(const uint8 *)load), "a" ((uint32)mask), "d" ((uint32)(mask >> 32)) : "memory"); #endif } static INLINE void XRSTOR_AMD_ES0(const void *load, uint64 mask) { uint64 dummy = 0; __asm__ __volatile__ ("fnstsw %%ax \n" // Grab x87 ES bit "bt $7,%%ax \n" // Test ES bit "jnc 1f \n" // Jump if ES=0 "fnclex \n" // ES=1. Clear it so fild doesn't trap "1: \n" "ffree %%st(7) \n" // Clear tag bit - avoid poss. stack overflow "fildl %0 \n" // Dummy Load from "safe address" changes all // x87 exception pointers. "mov %%ebx, %%eax \n" #if __GNUC__ < 4 || __GNUC__ == 4 && __GNUC_MINOR__ == 1 ".byte 0x0f, 0xae, 0x29 \n" : : "m" (dummy), "c" ((const uint8 *)load), "b" ((uint32)mask), "d" ((uint32)(mask >> 32)) #else "xrstor %1 \n" : : "m" (dummy), "m" (*(const uint8 *)load), "b" ((uint32)mask), "d" ((uint32)(mask >> 32)) #endif : "eax", "memory"); } #endif /* __GNUC__ */ /* *----------------------------------------------------------------------------- * * Div643232 -- * * Unsigned integer division: * The dividend is 64-bit wide * The divisor is 32-bit wide * The quotient is 32-bit wide * * Use this function if you are certain that: * o Either the quotient will fit in 32 bits, * o Or your code is ready to handle a #DE exception indicating overflow. * If that is not the case, then use Div643264(). * * Results: * Quotient and remainder * * Side effects: * None * *----------------------------------------------------------------------------- */ #if defined(__GNUC__) static INLINE void Div643232(uint64 dividend, // IN uint32 divisor, // IN uint32 *quotient, // OUT uint32 *remainder) // OUT { __asm__( "divl %4" : "=a" (*quotient), "=d" (*remainder) : "0" ((uint32)dividend), "1" ((uint32)(dividend >> 32)), "rm" (divisor) : "cc" ); } #elif defined _MSC_VER static INLINE void Div643232(uint64 dividend, // IN uint32 divisor, // IN uint32 *quotient, // OUT uint32 *remainder) // OUT { __asm { mov eax, DWORD PTR [dividend] mov edx, DWORD PTR [dividend+4] div DWORD PTR [divisor] mov edi, DWORD PTR [quotient] mov [edi], eax mov edi, DWORD PTR [remainder] mov [edi], edx } } #else #error No compiler defined for Div643232 #endif #if defined(__GNUC__) /* *----------------------------------------------------------------------------- * * Div643264 -- * * Unsigned integer division: * The dividend is 64-bit wide * The divisor is 32-bit wide * The quotient is 64-bit wide * * Results: * Quotient and remainder * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Div643264(uint64 dividend, // IN uint32 divisor, // IN uint64 *quotient, // OUT uint32 *remainder) // OUT { uint32 hQuotient; uint32 lQuotient; __asm__( "divl %5" "\n\t" "movl %%eax, %0" "\n\t" "movl %4, %%eax" "\n\t" "divl %5" : "=&rm" (hQuotient), "=a" (lQuotient), "=d" (*remainder) : "1" ((uint32)(dividend >> 32)), "g" ((uint32)dividend), "rm" (divisor), "2" (0) : "cc" ); *quotient = (uint64)hQuotient << 32 | lQuotient; } #endif /* *----------------------------------------------------------------------------- * * Mul64x3264 -- * * Unsigned integer by fixed point multiplication, with rounding: * result = floor(multiplicand * multiplier * 2**(-shift) + 0.5) * * Unsigned 64-bit integer multiplicand. * Unsigned 32-bit fixed point multiplier, represented as * (multiplier, shift), where shift < 64. * * Result: * Unsigned 64-bit integer product. * *----------------------------------------------------------------------------- */ #if defined(__GNUC__) && \ (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4)) && \ !defined(MUL64_NO_ASM) static INLINE uint64 Mul64x3264(uint64 multiplicand, uint32 multiplier, uint32 shift) { uint64 result; uint32 tmp1, tmp2; // ASSERT(shift >= 0 && shift < 64); __asm__("mov %%eax, %2\n\t" // Save lo(multiplicand) "mov %%edx, %%eax\n\t" // Get hi(multiplicand) "mull %4\n\t" // p2 = hi(multiplicand) * multiplier "xchg %%eax, %2\n\t" // Save lo(p2), get lo(multiplicand) "mov %%edx, %1\n\t" // Save hi(p2) "mull %4\n\t" // p1 = lo(multiplicand) * multiplier "addl %2, %%edx\n\t" // hi(p1) += lo(p2) "adcl $0, %1\n\t" // hi(p2) += carry from previous step "cmpl $32, %%ecx\n\t" // shift < 32? "jl 2f\n\t" // Go if so "shll $1, %%eax\n\t" // Save lo(p1) bit 31 in CF in case shift=32 "mov %%edx, %%eax\n\t" // result = hi(p2):hi(p1) >> (shift & 31) "mov %1, %%edx\n\t" "shrdl %%edx, %%eax\n\t" "mov $0, %2\n\t" "adcl $0, %2\n\t" // Get highest order bit shifted out, from CF "shrl %%cl, %%edx\n\t" "jmp 3f\n" "2:\n\t" "xor %2, %2\n\t" "shrdl %%edx, %%eax\n\t" // result = hi(p2):hi(p1):lo(p1) >> shift "adcl $0, %2\n\t" // Get highest order bit shifted out, from CF "shrdl %1, %%edx\n" "3:\n\t" "addl %2, %%eax\n\t" // result += highest order bit shifted out "adcl $0, %%edx" : "=A" (result), "=&r" (tmp1), "=&r" (tmp2) : "0" (multiplicand), "rm" (multiplier), "c" (shift) : "cc"); return result; } #elif defined _MSC_VER #pragma warning(disable: 4035) static INLINE uint64 Mul64x3264(uint64 multiplicand, uint32 multiplier, uint32 shift) { // ASSERT(shift >= 0 && shift < 64); __asm { mov eax, DWORD PTR [multiplicand+4] // Get hi(multiplicand) mul DWORD PTR [multiplier] // p2 = hi(multiplicand) * multiplier mov ecx, eax // Save lo(p2) mov ebx, edx // Save hi(p2) mov eax, DWORD PTR [multiplicand] // Get lo(multiplicand) mul DWORD PTR [multiplier+0] // p1 = lo(multiplicand) * multiplier add edx, ecx // hi(p1) += lo(p2) adc ebx, 0 // hi(p2) += carry from previous step mov ecx, DWORD PTR [shift] // Get shift cmp ecx, 32 // shift < 32? jl SHORT l2 // Go if so shl eax, 1 // Save lo(p1) bit 31 in CF in case shift=32 mov eax, edx // result = hi(p2):hi(p1) >> (shift & 31) mov edx, ebx shrd eax, edx, cl mov esi, 0 adc esi, 0 // Get highest order bit shifted out, from CF shr edx, cl jmp SHORT l3 l2: xor esi, esi shrd eax, edx, cl // result = hi(p2):hi(p1):lo(p1) >> shift adc esi, 0 // Get highest order bit shifted out, from CF shrd edx, ebx, cl l3: add eax, esi // result += highest order bit shifted out adc edx, 0 } // return with result in edx:eax } #pragma warning(default: 4035) #else #define MUL64_NO_ASM 1 #include "mul64.h" #endif /* *----------------------------------------------------------------------------- * * Muls64x32s64 -- * * Signed integer by fixed point multiplication, with rounding: * result = floor(multiplicand * multiplier * 2**(-shift) + 0.5) * * Signed 64-bit integer multiplicand. * Unsigned 32-bit fixed point multiplier, represented as * (multiplier, shift), where shift < 64. * * Result: * Signed 64-bit integer product. * *----------------------------------------------------------------------------- */ #if defined(__GNUC__) && \ (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4)) && \ !defined(MUL64_NO_ASM) static INLINE int64 Muls64x32s64(int64 multiplicand, uint32 multiplier, uint32 shift) { int64 result; uint32 tmp1, tmp2; // ASSERT(shift >= 0 && shift < 64); __asm__("mov %%eax, %2\n\t" // Save lo(multiplicand) "mov %%edx, %%eax\n\t" // Get hi(multiplicand) "test %%eax, %%eax\n\t" // Check sign of multiplicand "jl 0f\n\t" // Go if negative "mull %4\n\t" // p2 = hi(multiplicand) * multiplier "jmp 1f\n" "0:\n\t" "mull %4\n\t" // p2 = hi(multiplicand) * multiplier "sub %4, %%edx\n" // hi(p2) += -1 * multiplier "1:\n\t" "xchg %%eax, %2\n\t" // Save lo(p2), get lo(multiplicand) "mov %%edx, %1\n\t" // Save hi(p2) "mull %4\n\t" // p1 = lo(multiplicand) * multiplier "addl %2, %%edx\n\t" // hi(p1) += lo(p2) "adcl $0, %1\n\t" // hi(p2) += carry from previous step "cmpl $32, %%ecx\n\t" // shift < 32? "jl 2f\n\t" // Go if so "shll $1, %%eax\n\t" // Save lo(p1) bit 31 in CF in case shift=32 "mov %%edx, %%eax\n\t" // result = hi(p2):hi(p1) >> (shift & 31) "mov %1, %%edx\n\t" "shrdl %%edx, %%eax\n\t" "mov $0, %2\n\t" "adcl $0, %2\n\t" // Get highest order bit shifted out from CF "sarl %%cl, %%edx\n\t" "jmp 3f\n" "2:\n\t" "xor %2, %2\n\t" "shrdl %%edx, %%eax\n\t" // result = hi(p2):hi(p1):lo(p1) >> shift "adcl $0, %2\n\t" // Get highest order bit shifted out from CF "shrdl %1, %%edx\n" "3:\n\t" "addl %2, %%eax\n\t" // result += highest order bit shifted out "adcl $0, %%edx" : "=A" (result), "=&r" (tmp1), "=&rm" (tmp2) : "0" (multiplicand), "rm" (multiplier), "c" (shift) : "cc"); return result; } #elif defined(_MSC_VER) #pragma warning(disable: 4035) static INLINE int64 Muls64x32s64(int64 multiplicand, uint32 multiplier, uint32 shift) { //ASSERT(shift >= 0 && shift < 64); __asm { mov eax, DWORD PTR [multiplicand+4] // Get hi(multiplicand) test eax, eax // Check sign of multiplicand jl SHORT l0 // Go if negative mul DWORD PTR [multiplier] // p2 = hi(multiplicand) * multiplier jmp SHORT l1 l0: mul DWORD PTR [multiplier] // p2 = hi(multiplicand) * multiplier sub edx, DWORD PTR [multiplier] // hi(p2) += -1 * multiplier l1: mov ecx, eax // Save lo(p2) mov ebx, edx // Save hi(p2) mov eax, DWORD PTR [multiplicand] // Get lo(multiplicand) mul DWORD PTR [multiplier] // p1 = lo(multiplicand) * multiplier add edx, ecx // hi(p1) += lo(p2) adc ebx, 0 // hi(p2) += carry from previous step mov ecx, DWORD PTR [shift] // Get shift cmp ecx, 32 // shift < 32? jl SHORT l2 // Go if so shl eax, 1 // Save lo(p1) bit 31 in CF in case shift=32 mov eax, edx // result = hi(p2):hi(p1) >> (shift & 31) mov edx, ebx shrd eax, edx, cl mov esi, 0 adc esi, 0 // Get highest order bit shifted out, from CF sar edx, cl jmp SHORT l3 l2: xor esi, esi shrd eax, edx, cl // result = hi(p2):hi(p1):lo(p1) << shift adc esi, 0 // Get highest order bit shifted out, from CF shrd edx, ebx, cl l3: add eax, esi // result += highest order bit shifted out adc edx, 0 } // return with result in edx:eax } #pragma warning(default: 4035) #endif #if defined __cplusplus } // extern "C" #endif #endif // _VM_BASIC_ASM_X86_H_ vmci-only/shared/compat_module.h 0000444 0000000 0000000 00000005127 13432725347 015755 0 ustar root root /********************************************************* * Copyright (C) 2007 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 * *********************************************************/ /* * compat_module.h -- */ #ifndef __COMPAT_MODULE_H__ # define __COMPAT_MODULE_H__ #include <linux/module.h> /* * Modules wishing to use the GPL license are required to include a * MODULE_LICENSE definition in their module source as of 2.4.10. */ #ifndef MODULE_LICENSE #define MODULE_LICENSE(license) #endif /* * To make use of our own home-brewed MODULE_INFO, we need macros to * concatenate two expressions to "__mod_", and and to convert an * expression into a string. I'm sure we've got these in our codebase, * but I'd rather not introduce such a dependency in a compat header. */ #ifndef __module_cat #define __module_cat_1(a, b) __mod_ ## a ## b #define __module_cat(a, b) __module_cat_1(a, b) #endif #ifndef __stringify #define __stringify_1(x) #x #define __stringify(x) __stringify_1(x) #endif /* * MODULE_INFO was born in 2.5.69. */ #ifndef MODULE_INFO #define MODULE_INFO(tag, info) \ static const char __module_cat(tag, __LINE__)[] \ __attribute__((section(".modinfo"), unused)) = __stringify(tag) "=" info #endif /* * MODULE_VERSION was born in 2.6.4. The earlier form appends a long "\0xxx" * string to the module's version, but that was removed in 2.6.10, so we'll * ignore it in our wrapper. */ #ifndef MODULE_VERSION #define MODULE_VERSION(_version) MODULE_INFO(version, _version) #endif /* * Linux kernel < 2.6.31 takes 'int' for 'bool' module parameters. * Linux kernel >= 3.3.0 takes 'bool' for 'bool' module parameters. * Kernels between the two take either. So flip switch at 3.0.0. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 0, 0) typedef bool compat_mod_param_bool; #else typedef int compat_mod_param_bool; #endif #endif /* __COMPAT_MODULE_H__ */ vmci-only/shared/vm_basic_asm_x86_64.h 0000444 0000000 0000000 00000042355 13432725350 016564 0 ustar root root /********************************************************* * Copyright (C) 1998-2017 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 * *********************************************************/ /* * vm_basic_asm_x86_64.h * * Basic x86_64 asm macros. */ #ifndef _VM_BASIC_ASM_X86_64_H_ #define _VM_BASIC_ASM_X86_64_H_ #define INCLUDE_ALLOW_USERLEVEL #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMK_MODULE #define INCLUDE_ALLOW_VMKERNEL #define INCLUDE_ALLOW_DISTRIBUTE #define INCLUDE_ALLOW_VMCORE #include "includeCheck.h" #ifndef VM_X86_64 #error "This file is x86-64 only!" #endif #if defined(_MSC_VER) && !defined(BORA_NO_WIN32_INTRINS) #ifdef __cplusplus extern "C" { #endif uint64 _umul128(uint64 multiplier, uint64 multiplicand, uint64 *highProduct); int64 _mul128(int64 multiplier, int64 multiplicand, int64 *highProduct); uint64 __shiftright128(uint64 lowPart, uint64 highPart, uint8 shift); #ifdef __cplusplus } #endif #pragma intrinsic(_umul128, _mul128, __shiftright128) #endif // _MSC_VER #if defined(__GNUC__) /* * GET_CURRENT_PC * * Returns the current program counter (i.e. instruction pointer i.e. rip * register on x86_64). In the example below: * * foo.c * L123: Foo(GET_CURRENT_PC()) * * the return value from GET_CURRENT_PC will point a debugger to L123. */ #define GET_CURRENT_PC() ({ \ void *__rip; \ asm("lea 0(%%rip), %0;\n\t" \ : "=r" (__rip)); \ __rip; \ }) /* * GET_CURRENT_LOCATION * * Updates the arguments with the values of the %rip, %rbp, and %rsp * registers at the current code location where the macro is invoked, * and the return address. */ #define GET_CURRENT_LOCATION(rip, rbp, rsp, retAddr) do { \ asm("lea 0(%%rip), %0\n" \ "mov %%rbp, %1\n" \ "mov %%rsp, %2\n" \ : "=r" (rip), "=r" (rbp), "=r" (rsp)); \ retAddr = (uint64) GetReturnAddress(); \ } while (0) #endif /* * FXSAVE/FXRSTOR * save/restore SIMD/MMX fpu state * * The pointer passed in must be 16-byte aligned. * * Intel and AMD processors behave differently w.r.t. fxsave/fxrstor. Intel * processors unconditionally save the exception pointer state (instruction * ptr., data ptr., and error instruction opcode). FXSAVE_ES1 and FXRSTOR_ES1 * work correctly for Intel processors. * * AMD processors only save the exception pointer state if ES=1. This leads to a * security hole whereby one process/VM can inspect the state of another process * VM. The AMD recommended workaround involves clobbering the exception pointer * state unconditionally, and this is implemented in FXRSTOR_AMD_ES0. Note that * FXSAVE_ES1 will only save the exception pointer state for AMD processors if * ES=1. * * The workaround (FXRSTOR_AMD_ES0) only costs 1 cycle more than just doing an * fxrstor, on both AMD Opteron and Intel Core CPUs. */ #if defined(__GNUC__) static INLINE void FXSAVE_ES1(void *save) { __asm__ __volatile__ ("fxsaveq %0 \n" : "=m" (*(uint8 *)save) : : "memory"); } static INLINE void FXSAVE_COMPAT_ES1(void *save) { __asm__ __volatile__ ("fxsave %0 \n" : "=m" (*(uint8 *)save) : : "memory"); } static INLINE void FXRSTOR_ES1(const void *load) { __asm__ __volatile__ ("fxrstorq %0 \n" : : "m" (*(const uint8 *)load) : "memory"); } static INLINE void FXRSTOR_COMPAT_ES1(const void *load) { __asm__ __volatile__ ("fxrstor %0 \n" : : "m" (*(const uint8 *)load) : "memory"); } static INLINE void FXRSTOR_AMD_ES0(const void *load) { uint64 dummy = 0; __asm__ __volatile__ ("fnstsw %%ax \n" // Grab x87 ES bit "bt $7,%%ax \n" // Test ES bit "jnc 1f \n" // Jump if ES=0 "fnclex \n" // ES=1. Clear it so fild doesn't trap "1: \n" "ffree %%st(7) \n" // Clear tag bit - avoid poss. stack overflow "fildl %0 \n" // Dummy Load from "safe address" changes all // x87 exception pointers. "fxrstorq %1 \n" : : "m" (dummy), "m" (*(const uint8 *)load) : "ax", "memory"); } #endif /* __GNUC__ */ /* * XSAVE/XRSTOR * save/restore GSSE/SIMD/MMX fpu state * * The pointer passed in must be 64-byte aligned. * See above comment for more information. */ #if defined(__GNUC__) && (defined(VMM) || defined(VMKERNEL) || defined(FROBOS)) static INLINE void XSAVE_ES1(void *save, uint64 mask) { #if __GNUC__ < 4 || __GNUC__ == 4 && __GNUC_MINOR__ == 1 __asm__ __volatile__ ( ".byte 0x48, 0x0f, 0xae, 0x21 \n" : : "c" ((uint8 *)save), "a" ((uint32)mask), "d" ((uint32)(mask >> 32)) : "memory"); #else __asm__ __volatile__ ( "xsaveq %0 \n" : "=m" (*(uint8 *)save) : "a" ((uint32)mask), "d" ((uint32)(mask >> 32)) : "memory"); #endif } static INLINE void XSAVE_COMPAT_ES1(void *save, uint64 mask) { #if __GNUC__ < 4 || __GNUC__ == 4 && __GNUC_MINOR__ == 1 __asm__ __volatile__ ( ".byte 0x0f, 0xae, 0x21 \n" : : "c" ((uint8 *)save), "a" ((uint32)mask), "d" ((uint32)(mask >> 32)) : "memory"); #else __asm__ __volatile__ ( "xsave %0 \n" : "=m" (*(uint8 *)save) : "a" ((uint32)mask), "d" ((uint32)(mask >> 32)) : "memory"); #endif } static INLINE void XSAVEOPT_ES1(void *save, uint64 mask) { __asm__ __volatile__ ( ".byte 0x48, 0x0f, 0xae, 0x31 \n" : : "c" ((uint8 *)save), "a" ((uint32)mask), "d" ((uint32)(mask >> 32)) : "memory"); } static INLINE void XRSTOR_ES1(const void *load, uint64 mask) { #if __GNUC__ < 4 || __GNUC__ == 4 && __GNUC_MINOR__ == 1 __asm__ __volatile__ ( ".byte 0x48, 0x0f, 0xae, 0x29 \n" : : "c" ((const uint8 *)load), "a" ((uint32)mask), "d" ((uint32)(mask >> 32)) : "memory"); #else __asm__ __volatile__ ( "xrstorq %0 \n" : : "m" (*(const uint8 *)load), "a" ((uint32)mask), "d" ((uint32)(mask >> 32)) : "memory"); #endif } static INLINE void XRSTOR_COMPAT_ES1(const void *load, uint64 mask) { #if __GNUC__ < 4 || __GNUC__ == 4 && __GNUC_MINOR__ == 1 __asm__ __volatile__ ( ".byte 0x0f, 0xae, 0x29 \n" : : "c" ((const uint8 *)load), "a" ((uint32)mask), "d" ((uint32)(mask >> 32)) : "memory"); #else __asm__ __volatile__ ( "xrstor %0 \n" : : "m" (*(const uint8 *)load), "a" ((uint32)mask), "d" ((uint32)(mask >> 32)) : "memory"); #endif } static INLINE void XRSTOR_AMD_ES0(const void *load, uint64 mask) { uint64 dummy = 0; __asm__ __volatile__ ("fnstsw %%ax \n" // Grab x87 ES bit "bt $7,%%ax \n" // Test ES bit "jnc 1f \n" // Jump if ES=0 "fnclex \n" // ES=1. Clear it so fild doesn't trap "1: \n" "ffree %%st(7) \n" // Clear tag bit - avoid poss. stack overflow "fildl %0 \n" // Dummy Load from "safe address" changes all // x87 exception pointers. "mov %%ebx, %%eax \n" #if __GNUC__ < 4 || __GNUC__ == 4 && __GNUC_MINOR__ == 1 ".byte 0x48, 0x0f, 0xae, 0x29 \n" : : "m" (dummy), "c" ((const uint8 *)load), "b" ((uint32)mask), "d" ((uint32)(mask >> 32)) #else "xrstorq %1 \n" : : "m" (dummy), "m" (*(const uint8 *)load), "b" ((uint32)mask), "d" ((uint32)(mask >> 32)) #endif : "eax", "memory"); } #endif /* __GNUC__ */ /* * XTEST * Return TRUE if processor is in transaction region. * */ #if defined(__GNUC__) && (defined(VMM) || defined(VMKERNEL) || defined(FROBOS)) static INLINE Bool xtest(void) { uint8 al; __asm__ __volatile__(".byte 0x0f, 0x01, 0xd6 # xtest \n" "setnz %%al\n" : "=a"(al) : : "cc"); return al; } #endif /* __GNUC__ */ /* *----------------------------------------------------------------------------- * * Mul64x6464 -- * * Unsigned integer by fixed point multiplication, with rounding: * result = floor(multiplicand * multiplier * 2**(-shift) + 0.5) * * Unsigned 64-bit integer multiplicand. * Unsigned 64-bit fixed point multiplier, represented as * (multiplier, shift), where shift < 64. * * Result: * Unsigned 64-bit integer product. * *----------------------------------------------------------------------------- */ #if defined(__GNUC__) && !defined(MUL64_NO_ASM) static INLINE uint64 Mul64x6464(uint64 multiplicand, uint64 multiplier, uint32 shift) { /* * Implementation: * Multiply 64x64 bits to yield a full 128-bit product. * Clear the carry bit (needed for the shift == 0 case). * Shift result in RDX:RAX right by "shift". * Add the carry bit. (If shift > 0, this is the highest order bit * that was discarded by the shift; else it is 0.) * Return the low-order 64 bits of the above. * */ uint64 result, dummy; __asm__("mulq %3 \n\t" "clc \n\t" "shrdq %b4, %1, %0 \n\t" "adc $0, %0 \n\t" : "=a" (result), "=d" (dummy) : "0" (multiplier), "rm" (multiplicand), "c" (shift) : "cc"); return result; } #elif defined(_MSC_VER) && !defined(MUL64_NO_ASM) static INLINE uint64 Mul64x6464(uint64 multiplicand, uint64 multiplier, uint32 shift) { /* * Unfortunately, MSVC intrinsics don't give us access to the carry * flag after a 128-bit shift, so the implementation is more * awkward: * Multiply 64x64 bits to yield a full 128-bit product. * Shift result right by "shift". * If shift != 0, extract and add in highest order bit that was * discarded by the shift. * Return the low-order 64 bits of the above. */ uint64 tmplo, tmphi; tmplo = _umul128(multiplicand, multiplier, &tmphi); if (shift == 0) { return tmplo; } else { return __shiftright128(tmplo, tmphi, (uint8) shift) + ((tmplo >> (shift - 1)) & 1); } } #else #define MUL64_NO_ASM 1 #include "mul64.h" #endif /* *----------------------------------------------------------------------------- * * Muls64x64s64 -- * * Signed integer by fixed point multiplication, with rounding: * result = floor(multiplicand * multiplier * 2**(-shift) + 0.5) * * Signed 64-bit integer multiplicand. * Unsigned 64-bit fixed point multiplier, represented as * (multiplier, shift), where shift < 64. * * Result: * Signed 64-bit integer product. * *----------------------------------------------------------------------------- */ #if defined(__GNUC__) && !defined(MUL64_NO_ASM) static inline int64 Muls64x64s64(int64 multiplicand, int64 multiplier, uint32 shift) { int64 result, dummy; /* Implementation: * Multiply 64x64 bits to yield a full 128-bit product. * Clear the carry bit (needed for the shift == 0 case). * Shift result in RDX:RAX right by "shift". * Add the carry bit. (If shift > 0, this is the highest order bit * that was discarded by the shift; else it is 0.) * Return the low-order 64 bits of the above. * * Note: using the unsigned shrd instruction is correct because * shift < 64 and we return only the low 64 bits of the shifted * result. */ __asm__("imulq %3 \n\t" "clc \n\t" "shrdq %b4, %1, %0 \n\t" "adc $0, %0 \n\t" : "=a" (result), "=d" (dummy) : "0" (multiplier), "rm" (multiplicand), "c" (shift) : "cc"); return result; } #elif defined(_MSC_VER) && !defined(MUL64_NO_ASM) static INLINE int64 Muls64x64s64(int64 multiplicand, int64 multiplier, uint32 shift) { /* * Unfortunately, MSVC intrinsics don't give us access to the carry * flag after a 128-bit shift, so the implementation is more * awkward: * Multiply 64x64 bits to yield a full 128-bit product. * Shift result right by "shift". * If shift != 0, extract and add in highest order bit that was * discarded by the shift. * Return the low-order 64 bits of the above. * * Note: using an unsigned shift is correct because shift < 64 and * we return only the low 64 bits of the shifted result. */ int64 tmplo, tmphi; tmplo = _mul128(multiplicand, multiplier, &tmphi); if (shift == 0) { return tmplo; } else { return __shiftright128(tmplo, tmphi, (uint8) shift) + ((tmplo >> (shift - 1)) & 1); } } #endif #ifndef MUL64_NO_ASM /* *----------------------------------------------------------------------------- * * Mul64x3264 -- * * Unsigned integer by fixed point multiplication, with rounding: * result = floor(multiplicand * multiplier * 2**(-shift) + 0.5) * * Unsigned 64-bit integer multiplicand. * Unsigned 32-bit fixed point multiplier, represented as * (multiplier, shift), where shift < 64. * * Result: * Unsigned 64-bit integer product. * *----------------------------------------------------------------------------- */ static INLINE uint64 Mul64x3264(uint64 multiplicand, uint32 multiplier, uint32 shift) { return Mul64x6464(multiplicand, multiplier, shift); } /* *----------------------------------------------------------------------------- * * Muls64x32s64 -- * * Signed integer by fixed point multiplication, with rounding: * result = floor(multiplicand * multiplier * 2**(-shift) + 0.5) * * Signed 64-bit integer multiplicand. * Unsigned 32-bit fixed point multiplier, represented as * (multiplier, shift), where shift < 64. * * Result: * Signed 64-bit integer product. * *----------------------------------------------------------------------------- */ static INLINE int64 Muls64x32s64(int64 multiplicand, uint32 multiplier, uint32 shift) { return Muls64x64s64(multiplicand, multiplier, shift); } #endif #if defined(__GNUC__) static INLINE void * uint64set(void *dst, uint64 val, uint64 count) { int dummy0; int dummy1; __asm__ __volatile__("\t" "cld" "\n\t" "rep ; stosq" "\n" : "=c" (dummy0), "=D" (dummy1) : "0" (count), "1" (dst), "a" (val) : "memory", "cc"); return dst; } #endif /* *----------------------------------------------------------------------------- * * Div643232 -- * * Unsigned integer division: * The dividend is 64-bit wide * The divisor is 32-bit wide * The quotient is 32-bit wide * * Use this function if you are certain that the quotient will fit in 32 bits, * If that is not the case, a #DE exception was generated in 32-bit version, * but not in this 64-bit version. So please be careful. * * Results: * Quotient and remainder * * Side effects: * None * *----------------------------------------------------------------------------- */ #if defined(__GNUC__) || defined(_MSC_VER) static INLINE void Div643232(uint64 dividend, // IN uint32 divisor, // IN uint32 *quotient, // OUT uint32 *remainder) // OUT { *quotient = (uint32)(dividend / divisor); *remainder = (uint32)(dividend % divisor); } #endif /* *----------------------------------------------------------------------------- * * Div643264 -- * * Unsigned integer division: * The dividend is 64-bit wide * The divisor is 32-bit wide * The quotient is 64-bit wide * * Results: * Quotient and remainder * * Side effects: * None * *----------------------------------------------------------------------------- */ #if defined(__GNUC__) static INLINE void Div643264(uint64 dividend, // IN uint32 divisor, // IN uint64 *quotient, // OUT uint32 *remainder) // OUT { *quotient = dividend / divisor; *remainder = dividend % divisor; } #endif #endif // _VM_BASIC_ASM_X86_64_H_ vmci-only/shared/vmci_handle_array.h 0000444 0000000 0000000 00000021646 13432725350 016572 0 ustar root root /********************************************************* * Copyright (C) 2006 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_handle_array.h -- * * Simple dynamic array. */ #ifndef _VMCI_HANDLE_ARRAY_H_ #define _VMCI_HANDLE_ARRAY_H_ #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMCORE #define INCLUDE_ALLOW_VMKERNEL #include "includeCheck.h" #include "vmci_kernel_if.h" #include "vmware.h" #include "vmci_defs.h" #include "vm_assert.h" #ifdef VMKERNEL #include "vm_libc.h" #endif // VMKERNEL #if defined __cplusplus extern "C" { #endif #define VMCI_HANDLE_ARRAY_DEFAULT_SIZE 4 typedef struct VMCIHandleArray { uint32 capacity; uint32 size; VMCIHandle entries[1]; } VMCIHandleArray; /* *----------------------------------------------------------------------------------- * * VMCIHandleArray_Create -- * * Results: * Array if successful, NULL if not. * * Side effects: * None. * *----------------------------------------------------------------------------------- */ static INLINE VMCIHandleArray * VMCIHandleArray_Create(uint32 capacity) { VMCIHandleArray *array; if (capacity == 0) { capacity = VMCI_HANDLE_ARRAY_DEFAULT_SIZE; } array = (VMCIHandleArray *)VMCI_AllocKernelMem(sizeof array->capacity + sizeof array->size + capacity * sizeof(VMCIHandle), VMCI_MEMORY_NONPAGED | VMCI_MEMORY_ATOMIC); if (array == NULL) { return NULL; } array->capacity = capacity; array->size = 0; return array; } /* *----------------------------------------------------------------------------------- * * VMCIHandleArray_Destroy -- * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------------- */ static INLINE void VMCIHandleArray_Destroy(VMCIHandleArray *array) { VMCI_FreeKernelMem(array, sizeof array->capacity + sizeof array->size + array->capacity * sizeof(VMCIHandle)); } /* *----------------------------------------------------------------------------------- * * VMCIHandleArray_AppendEntry -- * * Results: * None. * * Side effects: * Array may be reallocated. * *----------------------------------------------------------------------------------- */ static INLINE void VMCIHandleArray_AppendEntry(VMCIHandleArray **arrayPtr, VMCIHandle handle) { VMCIHandleArray *array; ASSERT(arrayPtr && *arrayPtr); array = *arrayPtr; if (UNLIKELY(array->size >= array->capacity)) { /* reallocate. */ uint32 arraySize = sizeof array->capacity + sizeof array->size + array->capacity * sizeof(VMCIHandle); VMCIHandleArray *newArray = (VMCIHandleArray *) VMCI_AllocKernelMem(arraySize + array->capacity * sizeof(VMCIHandle), VMCI_MEMORY_NONPAGED | VMCI_MEMORY_ATOMIC); if (newArray == NULL) { return; } memcpy(newArray, array, arraySize); newArray->capacity *= 2; VMCI_FreeKernelMem(array, arraySize); *arrayPtr = newArray; array = newArray; } array->entries[array->size] = handle; array->size++; } /* *----------------------------------------------------------------------------------- * * VMCIHandleArray_RemoveEntry -- * * Results: * Handle that was removed, VMCI_INVALID_HANDLE if entry not found. * * Side effects: * None. * *----------------------------------------------------------------------------------- */ static INLINE VMCIHandle VMCIHandleArray_RemoveEntry(VMCIHandleArray *array, VMCIHandle entryHandle) { uint32 i; VMCIHandle handle = VMCI_INVALID_HANDLE; ASSERT(array); for (i = 0; i < array->size; i++) { if (VMCI_HANDLE_EQUAL(array->entries[i], entryHandle)) { handle = array->entries[i]; array->entries[i] = array->entries[array->size-1]; array->entries[array->size-1] = VMCI_INVALID_HANDLE; array->size--; break; } } return handle; } /* *----------------------------------------------------------------------------------- * * VMCIHandleArray_RemoveTail -- * * Results: * Handle that was removed, VMCI_INVALID_HANDLE if array was empty. * * Side effects: * None. * *----------------------------------------------------------------------------------- */ static INLINE VMCIHandle VMCIHandleArray_RemoveTail(VMCIHandleArray *array) { VMCIHandle handle; if (array->size == 0) { return VMCI_INVALID_HANDLE; } handle = array->entries[array->size-1]; array->entries[array->size-1] = VMCI_INVALID_HANDLE; array->size--; return handle; } /* *----------------------------------------------------------------------------------- * * VMCIHandleArray_GetEntry -- * * Results: * Handle at given index, VMCI_INVALID_HANDLE if invalid index. * * Side effects: * None. * *----------------------------------------------------------------------------------- */ static INLINE VMCIHandle VMCIHandleArray_GetEntry(const VMCIHandleArray *array, uint32 index) { ASSERT(array); if (UNLIKELY(index >= array->size)) { return VMCI_INVALID_HANDLE; } return array->entries[index]; } /* *----------------------------------------------------------------------------------- * * VMCIHandleArray_GetSize -- * * Results: * Number of entries in array. * * Side effects: * None. * *----------------------------------------------------------------------------------- */ static INLINE uint32 VMCIHandleArray_GetSize(const VMCIHandleArray *array) { ASSERT(array); return array->size; } /* *----------------------------------------------------------------------------------- * * VMCIHandleArray_HasEntry -- * * Results: * TRUE is entry exists in array, FALSE if not. * * Side effects: * None. * *----------------------------------------------------------------------------------- */ static INLINE Bool VMCIHandleArray_HasEntry(const VMCIHandleArray *array, VMCIHandle entryHandle) { uint32 i; ASSERT(array); for (i = 0; i < array->size; i++) { if (VMCI_HANDLE_EQUAL(array->entries[i], entryHandle)) { return TRUE; } } return FALSE; } /* *----------------------------------------------------------------------------------- * * VMCIHandleArray_GetCopy -- * * Results: * Returns pointer to copy of array on success or NULL, if memory allocation * fails. * * Side effects: * Allocates nonpaged memory. * *----------------------------------------------------------------------------------- */ static INLINE VMCIHandleArray * VMCIHandleArray_GetCopy(const VMCIHandleArray *array) { VMCIHandleArray *arrayCopy; ASSERT(array); arrayCopy = (VMCIHandleArray *)VMCI_AllocKernelMem(sizeof array->capacity + sizeof array->size + array->size * sizeof(VMCIHandle), VMCI_MEMORY_NONPAGED | VMCI_MEMORY_ATOMIC); if (arrayCopy != NULL) { memcpy(&arrayCopy->size, &array->size, sizeof array->size + array->size * sizeof(VMCIHandle)); arrayCopy->capacity = array->size; } return arrayCopy; } /* *----------------------------------------------------------------------------------- * * VMCIHandleArray_GetHandles -- * * Results: * NULL if the array is empty. Otherwise, a pointer to the array * of VMCI handles in the handle array. * * Side effects: * None. * *----------------------------------------------------------------------------------- */ static INLINE VMCIHandle * VMCIHandleArray_GetHandles(VMCIHandleArray *array) // IN { ASSERT(array); if (array->size) { return array->entries; } else { return NULL; } } #if defined __cplusplus } // extern "C" #endif #endif // _VMCI_HANDLE_ARRAY_H_ vmci-only/shared/compat_timer.h 0000444 0000000 0000000 00000006551 13432725347 015612 0 ustar root root /********************************************************* * Copyright (C) 2002 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 * *********************************************************/ #ifndef __COMPAT_TIMER_H__ # define __COMPAT_TIMER_H__ /* * The del_timer_sync() API appeared in 2.3.43 * It became reliable in 2.4.0-test3 * * --hpreg */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 4, 0) # define compat_del_timer_sync(timer) del_timer_sync(timer) #else # if LINUX_VERSION_CODE < KERNEL_VERSION(2, 3, 43) /* 2.3.43 removed asm/softirq.h's reference to bh_base. */ # include <linux/interrupt.h> # endif # include <asm/softirq.h> static inline int compat_del_timer_sync(struct timer_list *timer) // IN { int wasPending; start_bh_atomic(); wasPending = del_timer(timer); end_bh_atomic(); return wasPending; } #endif /* * The msleep_interruptible() API appeared in 2.6.9. * It is based on the msleep() API, which appeared in 2.4.29. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 9) # include <linux/delay.h> # define compat_msleep_interruptible(msecs) msleep_interruptible(msecs) # define compat_msleep(msecs) msleep(msecs) #else # include <linux/sched.h> /* * msecs_to_jiffies appeared in 2.6.7. For earlier kernels, * fall back to slow-case code (we don't use this operation * enough to need the performance). */ # if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 7) # define msecs_to_jiffies(msecs) (((msecs) * HZ + 999) / 1000) # endif /* * set_current_state appeared in 2.2.18. */ # if LINUX_VERSION_CODE < KERNEL_VERSION(2, 2, 18) # define set_current_state(a) do { current->state = (a); } while(0) # endif static inline void compat_msleep_interruptible(unsigned long msecs) // IN { set_current_state(TASK_INTERRUPTIBLE); schedule_timeout(msecs_to_jiffies(msecs) + 1); } static inline void compat_msleep(unsigned long msecs) // IN { set_current_state(TASK_UNINTERRUPTIBLE); schedule_timeout(msecs_to_jiffies(msecs) + 1); } #endif /* * There is init_timer_deferrable() since 2.6.22. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 22) # define compat_init_timer_deferrable(timer) init_timer_deferrable(timer) #else # define compat_init_timer_deferrable(timer) init_timer(timer) #endif #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,15) static inline void compat_setup_timer(struct timer_list * timer, void (*function)(unsigned long), unsigned long data) { timer->function = function; timer->data = data; init_timer(timer); } #else # define compat_setup_timer(timer, function, data) \ setup_timer(timer, function, data) #endif #endif /* __COMPAT_TIMER_H__ */ vmci-only/shared/vmciKernelAPI1.h 0000444 0000000 0000000 00000020110 13432725350 015616 0 ustar root root /********************************************************* * Copyright (C) 2010,2018 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 * *********************************************************/ /* * vmciKernelAPI1.h -- * * Kernel API (v1) exported from the VMCI host and guest drivers. */ #ifndef __VMCI_KERNELAPI_1_H__ #define __VMCI_KERNELAPI_1_H__ #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMK_MODULE #define INCLUDE_ALLOW_VMKERNEL #include "includeCheck.h" #include "vmci_defs.h" #include "vmci_call_defs.h" #if defined __cplusplus extern "C" { #endif /* VMCI module namespace on vmkernel. */ #define MOD_VMCI_NAMESPACE "com.vmware.vmci" /* Define version 1. */ #undef VMCI_KERNEL_API_VERSION #define VMCI_KERNEL_API_VERSION_1 1 #define VMCI_KERNEL_API_VERSION VMCI_KERNEL_API_VERSION_1 /* Macros to operate on the driver version number. */ #define VMCI_MAJOR_VERSION(v) (((v) >> 16) & 0xffff) #define VMCI_MINOR_VERSION(v) ((v) & 0xffff) #if defined(_WIN32) /* Path to callback object in object manager, for Windows only. */ #define VMCI_CALLBACK_OBJECT_PATH L"\\Callback\\VMCIDetachCB" #endif // _WIN32 /* VMCI Device Usage API. */ #if defined(__linux__) && !defined(VMKERNEL) #define vmci_device_get(_a, _b, _c, _d) 1 #define vmci_device_release(_x) #else // !linux typedef void (VMCI_DeviceShutdownFn)(void *deviceRegistration, void *userData); Bool vmci_device_get(uint32 *apiVersion, VMCI_DeviceShutdownFn *deviceShutdownCB, void *userData, void **deviceRegistration); void vmci_device_release(void *deviceRegistration); #endif // !linux #if defined(_WIN32) /* Called when the client is unloading, for Windows only. */ void vmci_exit(void); #endif // _WIN32 /* VMCI Datagram API. */ int vmci_datagram_create_handle(uint32 resourceId, uint32 flags, VMCIDatagramRecvCB recvCB, void *clientData, VMCIHandle *outHandle); int vmci_datagram_create_handle_priv(uint32 resourceID, uint32 flags, VMCIPrivilegeFlags privFlags, VMCIDatagramRecvCB recvCB, void *clientData, VMCIHandle *outHandle); int vmci_datagram_destroy_handle(VMCIHandle handle); int vmci_datagram_send(VMCIDatagram *msg); /* VMCI Utility API. */ VMCIId vmci_get_context_id(void); #if defined(__linux__) && !defined(VMKERNEL) /* Returned value is a bool, 0 for false, 1 for true. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 5, 0) int vmci_is_context_owner(VMCIId contextID, kuid_t uid); #else int vmci_is_context_owner(VMCIId contextID, uid_t uid); #endif #else // !linux || VMKERNEL /* Returned value is a VMCI error code. */ int vmci_is_context_owner(VMCIId contextID, void *hostUser); #endif // !linux || VMKERNEL uint32 vmci_version(void); int vmci_cid_2_host_vm_id(VMCIId contextID, void *hostVmID, size_t hostVmIDLen); /* VMCI Event API. */ typedef void (*VMCI_EventCB)(VMCIId subID, VMCI_EventData *ed, void *clientData); int vmci_event_subscribe(VMCI_Event event, #if !defined(__linux__) && !defined(__FreeBSD__) || defined(VMKERNEL) uint32 flags, #endif // !linux && !FreeBSD || VMKERNEL VMCI_EventCB callback, void *callbackData, VMCIId *subID); int vmci_event_unsubscribe(VMCIId subID); /* VMCI Context API */ VMCIPrivilegeFlags vmci_context_get_priv_flags(VMCIId contextID); /* VMCI Queue Pair API. */ typedef struct VMCIQPair VMCIQPair; int vmci_qpair_alloc(VMCIQPair **qpair, VMCIHandle *handle, uint64 produceQSize, uint64 consumeQSize, VMCIId peer, uint32 flags, VMCIPrivilegeFlags privFlags); int vmci_qpair_detach(VMCIQPair **qpair); int vmci_qpair_get_produce_indexes(const VMCIQPair *qpair, uint64 *producerTail, uint64 *consumerHead); int vmci_qpair_get_consume_indexes(const VMCIQPair *qpair, uint64 *consumerTail, uint64 *producerHead); int64 vmci_qpair_produce_free_space(const VMCIQPair *qpair); int64 vmci_qpair_produce_buf_ready(const VMCIQPair *qpair); int64 vmci_qpair_consume_free_space(const VMCIQPair *qpair); int64 vmci_qpair_consume_buf_ready(const VMCIQPair *qpair); ssize_t vmci_qpair_enqueue(VMCIQPair *qpair, const void *buf, size_t bufSize, int mode); ssize_t vmci_qpair_dequeue(VMCIQPair *qpair, void *buf, size_t bufSize, int mode); ssize_t vmci_qpair_peek(VMCIQPair *qpair, void *buf, size_t bufSize, int mode); #if (defined(__APPLE__) && !defined (VMX86_TOOLS)) || \ (defined(__linux__) && defined(__KERNEL__)) || \ (defined(_WIN32) && defined(WINNT_DDK)) /* * Environments that support struct iovec */ ssize_t vmci_qpair_enquev(VMCIQPair *qpair, void *iov, size_t iovSize, int mode); ssize_t vmci_qpair_dequev(VMCIQPair *qpair, void *iov, size_t iovSize, int mode); ssize_t vmci_qpair_peekv(VMCIQPair *qpair, void *iov, size_t iovSize, int mode); #endif /* Systems that support struct iovec */ /* Typedefs for all of the above, used by the IOCTLs and the kernel library. */ typedef void (VMCI_DeviceReleaseFct)(void *); typedef int (VMCIDatagram_CreateHndFct)(VMCIId, uint32, VMCIDatagramRecvCB, void *, VMCIHandle *); typedef int (VMCIDatagram_CreateHndPrivFct)(VMCIId, uint32, VMCIPrivilegeFlags, VMCIDatagramRecvCB, void *, VMCIHandle *); typedef int (VMCIDatagram_DestroyHndFct)(VMCIHandle); typedef int (VMCIDatagram_SendFct)(VMCIDatagram *); typedef VMCIId (VMCI_GetContextIDFct)(void); typedef uint32 (VMCI_VersionFct)(void); typedef int (VMCI_ContextID2HostVmIDFct)(VMCIId, void *, size_t); typedef int (VMCI_IsContextOwnerFct)(VMCIId, void *); typedef int (VMCIEvent_SubscribeFct)(VMCI_Event, uint32, VMCI_EventCB, void *, VMCIId *); typedef int (VMCIEvent_UnsubscribeFct)(VMCIId); typedef VMCIPrivilegeFlags (VMCIContext_GetPrivFlagsFct)(VMCIId); typedef int (VMCIQPair_AllocFct)(VMCIQPair **, VMCIHandle *, uint64, uint64, VMCIId, uint32, VMCIPrivilegeFlags); typedef int (VMCIQPair_DetachFct)(VMCIQPair **); typedef int (VMCIQPair_GetProduceIndexesFct)(const VMCIQPair *, uint64 *, uint64 *); typedef int (VMCIQPair_GetConsumeIndexesFct)(const VMCIQPair *, uint64 *, uint64 *); typedef int64 (VMCIQPair_ProduceFreeSpaceFct)(const VMCIQPair *); typedef int64 (VMCIQPair_ProduceBufReadyFct)(const VMCIQPair *); typedef int64 (VMCIQPair_ConsumeFreeSpaceFct)(const VMCIQPair *); typedef int64 (VMCIQPair_ConsumeBufReadyFct)(const VMCIQPair *); typedef ssize_t (VMCIQPair_EnqueueFct)(VMCIQPair *, const void *, size_t, int); typedef ssize_t (VMCIQPair_DequeueFct)(VMCIQPair *, void *, size_t, int); typedef ssize_t (VMCIQPair_PeekFct)(VMCIQPair *, void *, size_t, int); typedef ssize_t (VMCIQPair_EnqueueVFct)(VMCIQPair *qpair, void *, size_t, int); typedef ssize_t (VMCIQPair_DequeueVFct)(VMCIQPair *qpair, void *, size_t, int); typedef ssize_t (VMCIQPair_PeekVFct)(VMCIQPair *qpair, void *, size_t, int); #if defined __cplusplus } // extern "C" #endif #endif /* !__VMCI_KERNELAPI_1_H__ */ vmci-only/shared/vmci_infrastructure.h 0000444 0000000 0000000 00000010362 13432725350 017212 0 ustar root root /********************************************************* * Copyright (C) 2006,2014 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_infrastructure.h -- * * This file implements the VMCI infrastructure. */ #ifndef _VMCI_INFRASTRUCTURE_H_ #define _VMCI_INFRASTRUCTURE_H_ #define INCLUDE_ALLOW_USERLEVEL #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMCORE #define INCLUDE_ALLOW_VMKERNEL #define INCLUDE_ALLOW_DISTRIBUTE #include "includeCheck.h" #include "vmware.h" #include "vmci_defs.h" #if defined __cplusplus extern "C" { #endif typedef enum { VMCIOBJ_VMX_VM = 10, VMCIOBJ_CONTEXT, VMCIOBJ_SOCKET, VMCIOBJ_NOT_SET, } VMCIObjType; /* For storing VMCI structures in file handles. */ typedef struct VMCIObj { void *ptr; VMCIObjType type; } VMCIObj; /* Guestcalls currently support a maximum of 8 uint64 arguments. */ #define VMCI_GUESTCALL_MAX_ARGS_SIZE 64 /* * Structure used for checkpointing the doorbell mappings. It is * written to the checkpoint as is, so changing this structure will * break checkpoint compatibility. */ typedef struct VMCIDoorbellCptState { VMCIHandle handle; uint64 bitmapIdx; } VMCIDoorbellCptState; /* Used to determine what checkpoint state to get and set. */ #define VMCI_NOTIFICATION_CPT_STATE 0x1 #define VMCI_WELLKNOWN_CPT_STATE 0x2 #define VMCI_DG_OUT_STATE 0x3 #define VMCI_DG_IN_STATE 0x4 #define VMCI_DG_IN_SIZE_STATE 0x5 #define VMCI_DOORBELL_CPT_STATE 0x6 #define VMCI_DG_HYPERVISOR_SAVE_STATE_SIZE 0x7 #define VMCI_DG_HYPERVISOR_SAVE_STATE 0x8 /* Used to control the VMCI device in the vmkernel */ #define VMCI_DEV_RESET 0x01 #define VMCI_DEV_QP_RESET 0x02 // DEPRECATED #define VMCI_DEV_QUIESCE 0x03 #define VMCI_DEV_UNQUIESCE 0x04 #define VMCI_DEV_QP_BREAK_SHARING 0x05 // DEPRECATED #define VMCI_DEV_RESTORE_SYNC 0x06 #define VMCI_DEV_BMASTER_OFF 0x07 #define VMCI_DEV_BMASTER_ON 0x08 /* *------------------------------------------------------------------------- * * VMCI_Hash -- * * Hash function used by the Simple Datagram API. Based on the djb2 * hash function by Dan Bernstein. * * Result: * Returns guest call size. * * Side effects: * None. * *------------------------------------------------------------------------- */ static INLINE int VMCI_Hash(VMCIHandle handle, // IN unsigned size) // IN { unsigned i; int hash = 5381; const uint64 handleValue = QWORD(handle.resource, handle.context); for (i = 0; i < sizeof handle; i++) { hash = ((hash << 5) + hash) + (uint8)(handleValue >> (i * 8)); } return hash & (size - 1); } /* *------------------------------------------------------------------------- * * VMCI_HashId -- * * Hash function used by the Simple Datagram API. Hashes only a VMCI id * (not the full VMCI handle) Based on the djb2 * hash function by Dan Bernstein. * * Result: * Returns guest call size. * * Side effects: * None. * *------------------------------------------------------------------------- */ static INLINE int VMCI_HashId(VMCIId id, // IN unsigned size) // IN { unsigned i; int hash = 5381; for (i = 0; i < sizeof id; i++) { hash = ((hash << 5) + hash) + (uint8)(id >> (i * 8)); } return hash & (size - 1); } #if defined __cplusplus } // extern "C" #endif #endif // _VMCI_INFRASTRUCTURE_H_ vmci-only/shared/autoconf/ 0000755 0000000 0000000 00000000000 13432726375 014571 5 ustar root root vmci-only/shared/autoconf/file_operations_fsync.c 0000444 0000000 0000000 00000002746 13432725347 021326 0 ustar root root /********************************************************* * Copyright (C) 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 * *********************************************************/ /* * Linux v3.1 added 2 params to fsync for fine-grained locking control. * But SLES11 SP2 has backported the change to its 3.0 kernel, * so we can't rely solely on kernel version to determine number of * arguments. */ #include "compat_version.h" #include "compat_autoconf.h" #if LINUX_VERSION_CODE < KERNEL_VERSION(3, 0, 0) # error This compile test intentionally fails. #else #include <linux/fs.h> #include <linux/types.h> /* loff_t */ static int TestFsync(struct file *file, loff_t start, loff_t end, int datasync) { return 0; } struct file_operations testFO = { .fsync = TestFsync, }; #endif vmci-only/shared/autoconf/getsb1.c 0000444 0000000 0000000 00000003076 13432725347 016124 0 ustar root root /********************************************************* * Copyright (C) 2006 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 * *********************************************************/ #include "compat_version.h" #include "compat_autoconf.h" #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 19) #include <linux/fs.h> /* * Around 2.6.18, a pointer to a vfsmount was added to get_sb. Red Hat * backported this behavior into a 2.6.17 kernel. * * This test will fail on a kernel with such a patch. */ static struct super_block * LinuxDriverGetSb(struct file_system_type *fs_type, int flags, const char *dev_name, void *rawData) { return 0; } struct file_system_type fs_type = { .get_sb = LinuxDriverGetSb }; #else #error "This test intentionally fails on 2.6.19 or newer kernels." #endif vmci-only/shared/autoconf/file_operations_flush.c 0000444 0000000 0000000 00000002664 13432725347 021324 0 ustar root root /********************************************************* * Copyright (C) 2013-2014 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 * *********************************************************/ /* * Linux v2.6.18 added an owner parameter to flush. * But SLES10 has backported the change to its 2.6.16.60 kernel, * so we can't rely solely on kernel version to determine number of * arguments. * * This test will fail on a kernel with such a patch. */ #include "compat_version.h" #include "compat_autoconf.h" #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 18) #error This compile test intentionally fails on 2.6.18 and newer kernels. #else #include <linux/fs.h> static int TestFlush(struct file *file); { return 0; } struct file_operations testFO = { .flush = TestFlush, }; #endif vmci-only/shared/autoconf/netif_num_params.c 0000444 0000000 0000000 00000003352 13432725347 020263 0 ustar root root /********************************************************* * Copyright (C) 2009 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 * *********************************************************/ /* * Detect whether netif_rx_complete (and netif_rx_schedule) take a single * napi_struct argument. The foundation was laid whith introducing Generic * Receive Offload infrastructure but dropping unneeded net_device argument * did not happen till few commits later so we can't simply test for presence * of NETIF_F_GRO. * * Test succeeds if netif_rx_complete takes dev & napi arguments, or if it * takes dev argument only (kernels before 2.6.24). Test fails if netif_rx_complete * takes only single napi argument. */ #include "compat_version.h" #include "compat_autoconf.h" #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 30) # error This compile test intentionally fails. #elif LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 29) #include <linux/netdevice.h> #ifdef NETIF_F_GRO void test_netif_rx_complete(struct net_device *dev, struct napi_struct *napi) { netif_rx_complete(dev, napi); } #endif #endif vmci-only/shared/autoconf/cachector.c 0000444 0000000 0000000 00000003270 13432725347 016666 0 ustar root root /********************************************************* * Copyright (C) 2006 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 * *********************************************************/ #include "compat_version.h" #include "compat_autoconf.h" /* * Between 2.6.23 and 2.6.24-rc1 ctor prototype was changed from * ctor(ptr, cache, flags) to ctor(cache, ptr). Unfortunately there * is no typedef for ctor, so we have to redefine kmem_cache_create * to find out ctor prototype. This assumes that kmem_cache_create * takes 5 arguments and not 6 - that change occured between * 2.6.22 and 2.6.23-rc1. If prototype matches, then this is old * kernel. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 24) #error "This test intentionally fails on 2.6.24 and newer kernels." #elif LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 23) #include <linux/slab.h> struct kmem_cache *kmem_cache_create(const char *, size_t, size_t, unsigned long, void (*)(void *, struct kmem_cache *, unsigned long)); #endif vmci-only/shared/autoconf/geninclude.c 0000444 0000000 0000000 00000002321 13432725347 017044 0 ustar root root /********************************************************* * Copyright (C) 2003 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 * *********************************************************/ #include "compat_version.h" #include "compat_autoconf.h" #ifdef CONFIG_X86_VOYAGER APATH/mach-voyager #endif #ifdef CONFIG_X86_VISWS APATH/mach-visws #endif #ifdef CONFIG_X86_NUMAQ APATH/mach-numaq #endif #ifdef CONFIG_X86_BIGSMP APATH/mach-bigsmp #endif #ifdef CONFIG_X86_SUMMIT APATH/mach-summit #endif #ifdef CONFIG_X86_GENERICARCH APATH/mach-generic #endif APATH/mach-default vmci-only/shared/autoconf/cachector1.c 0000444 0000000 0000000 00000003075 13432725347 016752 0 ustar root root /********************************************************* * Copyright (C) 2008 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 * *********************************************************/ #include "compat_version.h" #include "compat_autoconf.h" /* * Between 2.6.27-rc1 and 2.6.27-rc2 ctor prototype was changed from * ctor(cache, ptr) to ctor(ptr). Unfortunately there * is no typedef for ctor, so we have to redefine kmem_cache_create * to find out ctor prototype. If prototype matches, then this is old * kernel. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 28) #error "This test intentionally fails on 2.6.28 and newer kernels." #elif LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 26) #include <linux/slab.h> struct kmem_cache *kmem_cache_create(const char *, size_t, size_t, unsigned long, void (*)(struct kmem_cache *, void *)); #endif vmci-only/shared/autoconf/wait_on_bit.c 0000444 0000000 0000000 00000003306 13432725347 017231 0 ustar root root /********************************************************* * Copyright (C) 2016 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 * *********************************************************/ #include "compat_version.h" #include "compat_autoconf.h" #if LINUX_VERSION_CODE < KERNEL_VERSION(3, 17, 0) && \ LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 13) #include <linux/fs.h> #include <linux/wait.h> #include <linux/sched.h> unsigned long test_bits; /* * After 3.17.0, wait_on_bit changed its interface to remove the action * callback argument and this was backported to some Linux kernel versions * such as 3.10 for the RHEL 7.3 version. * * This test will fail on a kernel with such a patch. */ int test(void) { return wait_on_bit(&test_bits, 0, NULL, TASK_UNINTERRUPTIBLE); } #elif LINUX_VERSION_CODE >= KERNEL_VERSION(3, 17, 0) #error "This test intentionally fails on 3.17.0 and newer kernels." #else /* * It must be older than 2.6.13 in which case we don't use the function. */ #endif vmci-only/shared/autoconf/cachecreate.c 0000444 0000000 0000000 00000003210 13432725347 017154 0 ustar root root /********************************************************* * Copyright (C) 2006 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 * *********************************************************/ #include "compat_version.h" #include "compat_autoconf.h" /* * All kernels before 2.6.22 take 6 arguments. All kernels since * 2.6.23-rc1 take 5 arguments. Only kernels between 2.6.22 and * 2.6.23-rc1 are questionable - we could ignore them if we wanted, * nobody cares about them even now. But unfortunately RedHat is * re-releasing 2.6.X-rc kernels under 2.6.(X-1) name, so they * are releasing 2.6.23-rc1 as 2.6.22-5055-something, so we have * to do autodetection for them. */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 22) /* Success... */ #elif LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 23) #error "This test intentionally fails on 2.6.23 and newer kernels." #else #include <linux/slab.h> struct kmem_cache *kmemtest(void) { return kmem_cache_create("test", 12, 0, 0, NULL, NULL); } #endif vmci-only/shared/autoconf/skblin.c 0000444 0000000 0000000 00000002572 13432725347 016221 0 ustar root root /********************************************************* * Copyright (C) 2006 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 * *********************************************************/ /* * Detect whether skb_linearize takes one or two arguments. */ #include "compat_version.h" #include "compat_autoconf.h" #if LINUX_VERSION_CODE <= KERNEL_VERSION(2, 6, 17) /* * Since 2.6.18 all kernels have single-argument skb_linearize. For * older kernels use autodetection. Not using autodetection on newer * kernels saves us from compile failure on some post 2.6.18 kernels * which do not have selfcontained skbuff.h. */ #include <linux/skbuff.h> int test_skb_linearize(struct sk_buff *skb) { return skb_linearize(skb); } #endif vmci-only/shared/autoconf/dalias.c 0000444 0000000 0000000 00000003217 13432725347 016171 0 ustar root root /********************************************************* * Copyright (C) 2015-2016 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 * *********************************************************/ #include "compat_version.h" #include "compat_autoconf.h" #if LINUX_VERSION_CODE < KERNEL_VERSION(3, 19, 0) #if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 6, 0) #include <linux/dcache.h> #include <linux/list.h> /* * After 3.19.0, the dentry d_alias field was moved. Fedora * backported this behavior into earlier kernel versions. * The type of the d_alias field changed from 3.6 onwards * which was a list head to being a list node. The check * for earlier than 3.6 is done separately. * * This test will fail on a kernel with such a patch. */ void test(void) { struct dentry aliasDentry; INIT_HLIST_NODE(&aliasDentry.d_alias); } #else /* Intentionally passes for earlier than 3.6.0 kernels as a separate test is done. */ #endif #else #error "This test intentionally fails on 3.19.0 or newer kernels." #endif vmci-only/shared/autoconf/truncate_pagecache.c 0000444 0000000 0000000 00000003315 13432725347 020540 0 ustar root root /********************************************************* * Copyright (C) 2015-2016 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 * *********************************************************/ #include "compat_version.h" #include "compat_autoconf.h" #if LINUX_VERSION_CODE < KERNEL_VERSION(3, 12, 0) && \ LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 32) #include <linux/fs.h> #include <linux/mm.h> #include <linux/types.h> /* loff_t */ /* * After 3.12.0, truncate_pagecache changed its interface to just use * the new file size only. Red Hat backported this behavior into a 3.10.0 * kernel. * * This test will fail on a kernel with such a patch. */ void test(void) { struct inode inode; loff_t oldSize = 0; loff_t newSize = 4096; truncate_pagecache(&inode, oldSize, newSize); } #elif LINUX_VERSION_CODE >= KERNEL_VERSION(3, 12, 0) #error "This test intentionally fails on 3.12.0 and newer kernels." #else /* * It must be older than 2.6.32 in which case we assume success. * So not 3.12 compatible. There is no function for these versions. */ #endif vmci-only/shared/autoconf/netcreate_num_params.c 0000444 0000000 0000000 00000003160 13432725347 021125 0 ustar root root /********************************************************* * Copyright (C) 2010 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 * *********************************************************/ /* * During 2.6.33 merge window net_proto_ops->create() method was changed - * a new 'kern' field, signalling whether socket is being created by kernel * or userspace application, was added to it. Unfortunately, some * distributions, such as RHEL 6, have backported the change to earlier * kernels, so we can't rely solely on kernel version to determine number of * arguments. */ #include "compat_version.h" #include "compat_autoconf.h" #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 32) # error This compile test intentionally fails. #else #include <linux/net.h> static int TestCreate(struct net *net, struct socket *sock, int protocol, int kern) { return 0; } struct net_proto_family testFamily = { .create = TestCreate, }; #endif vmci-only/shared/autoconf/filldir1.c 0000444 0000000 0000000 00000003260 13432725347 016440 0 ustar root root /********************************************************* * Copyright (C) 2006 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 * *********************************************************/ #include "compat_version.h" #include "compat_autoconf.h" #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 20) #include <linux/fs.h> #include <linux/types.h> /* loff_t */ #include <linux/stddef.h> /* NULL */ /* * After 2.6.18, filldir and statfs were changed to send 64-bit inode * numbers to user space. Red Hat backported this behavior into a 2.6.17 * kernel. * * This test will fail on a kernel with such a patch. */ static int LinuxDriverFilldir(void *buf, const char *name, int namelen, loff_t offset, ino_t ino, unsigned int d_type) { return 0; } void test(void) { vfs_readdir(NULL, LinuxDriverFilldir, NULL); } #else #error "This test intentionally fails on 2.6.20 and newer kernels." #endif vmci-only/shared/autoconf/statfs1.c 0000444 0000000 0000000 00000002671 13432725347 016324 0 ustar root root /********************************************************* * Copyright (C) 2006 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 * *********************************************************/ #include "compat_version.h" #include "compat_autoconf.h" #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 19) #include <linux/fs.h> /* * Around 2.6.18, the super_block pointer in statfs was changed to a dentry * pointer. Red Hat backported this behavior into a 2.6.17 kernel. * * This test will fail on a kernel with such a patch. */ static int LinuxDriverStatFs(struct super_block *sb, struct kstatfs *stat) { return 0; } struct super_operations super_ops = { .statfs = LinuxDriverStatFs }; #else #error "This test intentionally fails on 2.6.19 and newer kernels." #endif vmci-only/shared/autoconf/dcount.c 0000444 0000000 0000000 00000002603 13432725347 016226 0 ustar root root /********************************************************* * Copyright (C) 2014 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 * *********************************************************/ #include "compat_version.h" #include "compat_autoconf.h" #if LINUX_VERSION_CODE < KERNEL_VERSION(3, 11, 0) #include <linux/dcache.h> /* * After 3.11.0, the dentry d_count field was removed. Red Hat * backported this behavior into a 3.10.0 kernel. * * This test will fail on a kernel with such a patch. */ void test(void) { struct dentry dentry; #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 38) dentry.d_count = 1; #else atomic_set(&dentry.d_count, 1); #endif } #else #error "This test intentionally fails on 3.11.0 or newer kernels." #endif vmci-only/shared/autoconf/dalias1.c 0000444 0000000 0000000 00000003325 13432725347 016252 0 ustar root root /********************************************************* * Copyright (C) 2015-2016 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 * *********************************************************/ #include "compat_version.h" #include "compat_autoconf.h" #if LINUX_VERSION_CODE < KERNEL_VERSION(3, 6, 0) && \ LINUX_VERSION_CODE >= KERNEL_VERSION(3, 2, 0) #include <linux/dcache.h> #include <linux/list.h> /* * After 3.19.0, the dentry d_alias field was moved. Fedora * backported this behavior into earlier kernels. * The type of the d_alias field changed from 3.6 onwards * which was a list head to being a list node. The check * for 3.6 onwards is done separately. * * This test will fail on a kernel with such a patch. */ void test(void) { struct dentry aliasDentry; INIT_LIST_HEAD(&aliasDentry.d_alias); } #else /* * Intentionally passes for earlier than 3.2.0 kernels as d_alias is valid. * * Intentionally passes for 3.6.0 or later kernels as d_alias is a different type. * A separate test with the different type is run for those kernel versions. */ #endif vmci-only/shared/autoconf/inode1.c 0000444 0000000 0000000 00000002703 13432725347 016112 0 ustar root root /********************************************************* * Copyright (C) 2006 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 * *********************************************************/ #include "compat_version.h" #include "compat_autoconf.h" #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 20) #include <linux/fs.h> #include <linux/stddef.h> /* NULL */ /* * After 2.6.18, inodes were "slimmed". This involved removing the union * that encapsulates inode private data (and using i_private instead), as well * as removing i_blksize. Red Hat backported this behavior into a 2.6.17 * kernel. * * This test will fail on a kernel with such a patch. */ void test(void) { struct inode inode; inode.u.generic_ip = NULL; } #else #error "This test intentionally fails on 2.6.20 and newer kernels." #endif vmci-only/shared/compat_pagemap.h 0000444 0000000 0000000 00000002535 13432725347 016102 0 ustar root root /********************************************************* * Copyright (C) 2009 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 * *********************************************************/ #ifndef __COMPAT_PAGEMAP_H__ # define __COMPAT_PAGEMAP_H__ #include <linux/pagemap.h> /* * AOP_FLAG_NOFS was defined in the same changeset that * grab_cache_page_write_begin() was introduced. */ #ifdef AOP_FLAG_NOFS #define compat_grab_cache_page_write_begin(mapping, index, flags) \ grab_cache_page_write_begin((mapping), (index), (flags)) #else #define compat_grab_cache_page_write_begin(mapping, index, flags) \ __grab_cache_page((mapping), (index)); #endif #endif /* __COMPAT_PAGEMAP_H__ */ vmci-only/shared/compat_mutex.h 0000444 0000000 0000000 00000003475 13432725347 015636 0 ustar root root /********************************************************* * Copyright (C) 2009 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 * *********************************************************/ #ifndef __COMPAT_MUTEX_H__ # define __COMPAT_MUTEX_H__ /* Blocking mutexes were introduced in 2.6.16. */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 16) #include "compat_semaphore.h" typedef struct semaphore compat_mutex_t; # define compat_define_mutex(_mx) DECLARE_MUTEX(_mx) # define compat_mutex_init(_mx) init_MUTEX(_mx) # define compat_mutex_lock(_mx) down(_mx) # define compat_mutex_lock_interruptible(_mx) down_interruptible(_mx) # define compat_mutex_unlock(_mx) up(_mx) #else #include <linux/mutex.h> typedef struct mutex compat_mutex_t; # define compat_define_mutex(_mx) DEFINE_MUTEX(_mx) # define compat_mutex_init(_mx) mutex_init(_mx) # define compat_mutex_lock(_mx) mutex_lock(_mx) # define compat_mutex_lock_interruptible(_mx) mutex_lock_interruptible(_mx) # define compat_mutex_unlock(_mx) mutex_unlock(_mx) #endif #endif /* __COMPAT_MUTEX_H__ */ vmci-only/shared/compat_string.h 0000444 0000000 0000000 00000003563 13432725347 016000 0 ustar root root /********************************************************* * Copyright (C) 2007 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 * *********************************************************/ #ifndef __COMPAT_STRING_H__ # define __COMPAT_STRING_H__ #include <linux/string.h> /* * kstrdup was born in 2.6.13. This implementation is almost identical to the * one found there. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 13) #define compat_kstrdup(s, gfp) kstrdup(s, gfp) #else #define compat_kstrdup(s, gfp) \ ({ \ size_t len; \ char *buf; \ len = strlen(s) + 1; \ buf = kmalloc(len, gfp); \ memcpy(buf, s, len); \ buf; \ }) #endif #endif /* __COMPAT_STRING_H__ */ vmci-only/shared/vmciKernelAPI2.h 0000444 0000000 0000000 00000004240 13432725350 015625 0 ustar root root /********************************************************* * Copyright (C) 2010 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 * *********************************************************/ /* * vmciKernelAPI2.h -- * * Kernel API (v2) exported from the VMCI host and guest drivers. */ #ifndef __VMCI_KERNELAPI_2_H__ #define __VMCI_KERNELAPI_2_H__ #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMK_MODULE #define INCLUDE_ALLOW_VMKERNEL #include "includeCheck.h" #include "vmciKernelAPI1.h" #if defined __cplusplus extern "C" { #endif /* Define version 2. */ #undef VMCI_KERNEL_API_VERSION #define VMCI_KERNEL_API_VERSION_2 2 #define VMCI_KERNEL_API_VERSION VMCI_KERNEL_API_VERSION_2 /* VMCI Doorbell API. */ #define VMCI_FLAG_DELAYED_CB 0x01 typedef void (*VMCICallback)(void *clientData); int vmci_doorbell_create(VMCIHandle *handle, uint32 flags, VMCIPrivilegeFlags privFlags, VMCICallback notifyCB, void *clientData); int vmci_doorbell_destroy(VMCIHandle handle); int vmci_doorbell_notify(VMCIHandle handle, VMCIPrivilegeFlags privFlags); /* Typedefs for all of the above, used by the IOCTLs and the kernel library. */ typedef int (VMCIDoorbell_CreateFct)(VMCIHandle *, uint32, VMCIPrivilegeFlags, VMCICallback, void *); typedef int (VMCIDoorbell_DestroyFct)(VMCIHandle); typedef int (VMCIDoorbell_NotifyFct)(VMCIHandle, VMCIPrivilegeFlags); #if defined __cplusplus } // extern "C" #endif #endif /* !__VMCI_KERNELAPI_2_H__ */ vmci-only/shared/vmci_kernel_if.h 0000444 0000000 0000000 00000042051 13432725350 016070 0 ustar root root /********************************************************* * Copyright (C) 2006-2016,2018 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) # error "Platform not supported." #endif #if defined(_WIN32) # include <ntddk.h> #else #define UNREFERENCED_PARAMETER(P) #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 "splock_customRanks.h" # include "semaphore_ext.h" # include "vmkapi.h" # include "world_dist.h" #endif #include "vm_basic_types.h" #include "vmci_defs.h" #if defined(VMKERNEL) # include "list.h" #else # include "dbllnklst.h" #endif #if defined __cplusplus extern "C" { #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 MCSLock VMCILock; typedef SP_IRQL VMCILockFlags; typedef Semaphore VMCIEvent; typedef Semaphore VMCIMutex; typedef World_ID VMCIHostVmID; typedef uint32 VMCIHostUser; typedef PPN64 *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. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 5, 0) typedef kuid_t VMCIHostUser; #else typedef uid_t VMCIHostUser; #endif 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; #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_NONBLOCK (MIN(SP_RANK_WAIT, \ SP_RANK_HEAPLOCK_DYNAMIC) - 1) #define VMCI_LOCK_RANK_MAX (SP_RANK_BLOCKABLE_HIGHEST_MAJOR - 2) /* * Determines whether VMCI locks will be blockable or not. If blockable, * all locks will be at or below VMCI_LOCK_RANK_MAX. If not, locks will * instead use VMCI_LOCK_RANK_MAX_NONBLOCK as the maximum. The other * VMCI_LOCK_RANK_XXX values will be rebased to be non-blocking as well * in that case. */ extern Bool vmciBlockableLock; #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. */ #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(__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); void VMCIHost_SignalBitmapAlways(VMCIHost *hostContext); void VMCIHost_SignalCallAlways(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__)) 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(_WIN32) || defined(__APPLE__) int VMCIKernelIf_Init(void); void VMCIKernelIf_Exit(void); #if defined(_WIN32) void VMCIKernelIf_DrainDelayedWork(void); #endif // _WIN32 #endif // _WIN32 || __APPLE__ #if !defined(VMKERNEL) && \ (defined(__linux__) || defined(_WIN32) || 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); int VMCIHost_RevalidateQueues(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) NOT_IMPLEMENTED() # define VMCI_UnlockQueueHeader(_q) NOT_IMPLEMENTED() #endif #if defined(VMKERNEL) int VMCI_QueueHeaderUpdated(struct VMCIQueue *produceQ); #else # define VMCI_QueueHeaderUpdated(_q) VMCI_SUCCESS #endif #if (!defined(VMKERNEL) && defined(__linux__)) || defined(_WIN32) || \ defined(__APPLE__) 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) NOT_IMPLEMENTED() #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 #if defined __cplusplus } // extern "C" #endif #endif // _VMCI_KERNEL_IF_H_ vmci-only/shared/vmware_pack_init.h 0000444 0000000 0000000 00000003651 13432725350 016441 0 ustar root root /********************************************************* * Copyright (C) 2002-2016 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 * *********************************************************/ #ifndef __VMWARE_PACK_INIT_H__ # define __VMWARE_PACK_INIT_H__ /* * vmware_pack_init.h -- * * Platform-independent code to make the compiler pack (i.e. have them * occupy the smallest possible space) structure definitions. The following * constructs are known to work --hpreg * * #include "vmware_pack_begin.h" * struct foo { * ... * } * #include "vmware_pack_end.h" * ; * * typedef * #include "vmware_pack_begin.h" * struct foo { * ... * } * #include "vmware_pack_end.h" * foo; */ #ifdef _MSC_VER /* * MSVC 6.0 emits warning 4103 when the pack push and pop pragma pairing is * not balanced within 1 included file. That is annoying because our scheme * is based on the pairing being balanced between 2 included files. * * So we disable this warning, but this is safe because the compiler will also * emit warning 4161 when there is more pops than pushes within 1 main * file --hpreg */ # pragma warning(disable:4103) #elif __GNUC__ #else # error Compiler packing... #endif #endif /* __VMWARE_PACK_INIT_H__ */ vmci-only/shared/vm_basic_defs.h 0000444 0000000 0000000 00000044517 13432725350 015711 0 ustar root root /********************************************************* * Copyright (C) 2003-2018 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 * *********************************************************/ /* * vm_basic_defs.h -- * * Standard macros for VMware source code. */ #ifndef _VM_BASIC_DEFS_H_ #define _VM_BASIC_DEFS_H_ #define INCLUDE_ALLOW_USERLEVEL #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMKERNEL #define INCLUDE_ALLOW_VMKDRIVERS #define INCLUDE_ALLOW_VMK_MODULE #define INCLUDE_ALLOW_DISTRIBUTE #define INCLUDE_ALLOW_VMCORE #include "includeCheck.h" #include "vm_basic_types.h" // For INLINE. /* Checks for FreeBSD, filtering out VMKERNEL. */ #if !defined(VMKERNEL) && defined(__FreeBSD__) #define __IS_FREEBSD__ 1 #else #define __IS_FREEBSD__ 0 #endif #define __IS_FREEBSD_VER__(ver) (__IS_FREEBSD__ && __FreeBSD_version >= (ver)) #if defined _WIN32 && defined USERLEVEL #include <stddef.h> /* * We redefine offsetof macro from stddef; make * sure that it's already defined before we do that. */ #include <windows.h> // for Sleep() and LOWORD() etc. #undef GetFreeSpace // Unpollute preprocessor namespace. #endif /* * Simple macros */ #ifndef vmw_offsetof #define vmw_offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER) #endif #if (defined __APPLE__ || defined __FreeBSD__) && \ (!defined KERNEL && !defined _KERNEL && !defined VMKERNEL && !defined __KERNEL__) # include <stddef.h> #else #ifndef offsetof #define VMW_DEFINED_OFFSETOF /* * XXX While the _WIN32 implementation appears to be identical to vmw_offsetof * in terms of behavior, they need to be separate to match verbatim the * definition used by the respective compilers, to avoid a redefinition warning. * * This is necessary until we eliminate the inclusion of <windows.h> above. */ #ifdef _WIN32 #define offsetof(s,m) (size_t)&(((s *)0)->m) /* * We use the builtin offset for gcc/clang, except when we're running under the * vmkernel's GDB macro preprocessor, since gdb doesn't understand * __builtin_offsetof. */ #elif defined __GNUC__ && !defined VMKERNEL_GDB_MACRO_BUILDER #define offsetof __builtin_offsetof #else #define offsetof vmw_offsetof #endif #endif // offsetof #endif // __APPLE__ #define VMW_CONTAINER_OF(ptr, type, member) \ ((type *)((char *)(ptr) - vmw_offsetof(type, member))) #ifndef ARRAYSIZE #define ARRAYSIZE(a) (sizeof (a) / sizeof *(a)) #endif #ifndef MIN #define MIN(_a, _b) (((_a) < (_b)) ? (_a) : (_b)) #endif /* The Solaris 9 cross-compiler complains about these not being used */ #ifndef sun static INLINE int Min(int a, int b) { return a < b ? a : b; } #endif #ifndef MAX #define MAX(_a, _b) (((_a) > (_b)) ? (_a) : (_b)) #endif #ifndef sun static INLINE int Max(int a, int b) { return a > b ? a : b; } #endif #define VMW_CLAMP(x, min, max) \ ((x) < (min) ? (min) : ((x) > (max) ? (max) : (x))) #define ROUNDUP(x,y) (((x) + (y) - 1) / (y) * (y)) #define ROUNDDOWN(x,y) ((x) / (y) * (y)) #define ROUNDUPBITS(x, bits) (((uintptr_t) (x) + MASK(bits)) & ~MASK(bits)) #define ROUNDDOWNBITS(x, bits) ((uintptr_t) (x) & ~MASK(bits)) #define CEILING(x, y) (((x) + (y) - 1) / (y)) #if defined __APPLE__ #include <machine/param.h> #undef MASK #endif /* * The MASK macro behaves badly when given negative numbers or numbers larger * than the highest order bit number (e.g. 32 on a 32-bit machine) as an * argument. The range 0..31 is safe. */ #define MASK(n) ((1 << (n)) - 1) /* make an n-bit mask */ #define MASK64(n) ((CONST64U(1) << (n)) - 1) /* make an n-bit mask */ /* * MASKRANGE64 makes a bit vector starting at bit lo and ending at bit hi. No * checking for lo < hi is done. */ #define MASKRANGE64(hi, lo) (MASK64((hi) - (lo) + 1) << (lo)) /* SIGNEXT64 sign extends a n-bit value to 64-bits. */ #define SIGNEXT64(val, n) (((int64)(val) << (64 - (n))) >> (64 - (n))) #define DWORD_ALIGN(x) ((((x) + 3) >> 2) << 2) #define QWORD_ALIGN(x) ((((x) + 7) >> 3) << 3) #define IMPLIES(a,b) (!(a) || (b)) /* * Not everybody (e.g., the monitor) has NULL */ #ifndef NULL #ifdef __cplusplus #define NULL 0 #else #define NULL ((void *)0) #endif #endif /* * Token concatenation * * The C preprocessor doesn't prescan arguments when they are * concatenated or stringified. So we need extra levels of * indirection to convince the preprocessor to expand its * arguments. */ #define CONC(x, y) x##y #define XCONC(x, y) CONC(x, y) #define XXCONC(x, y) XCONC(x, y) #define MAKESTR(x) #x #define XSTR(x) MAKESTR(x) /* * Wide versions of string constants. */ #ifndef WSTR #define WSTR_(X) L ## X #define WSTR(X) WSTR_(X) #endif /* * Page operations * * It has been suggested that these definitions belong elsewhere * (like x86types.h). However, I deem them common enough * (since even regular user-level programs may want to do * page-based memory manipulation) to be here. * -- edward */ #ifndef PAGE_SHIFT // { #if defined VM_I386 #define PAGE_SHIFT 12 #elif defined __APPLE__ #define PAGE_SHIFT 12 #elif defined VM_ARM_64 #define PAGE_SHIFT 12 #elif defined __arm__ #define PAGE_SHIFT 12 #else #error #endif #endif // } #ifndef PAGE_SIZE #define PAGE_SIZE (1 << PAGE_SHIFT) #endif #ifndef PAGE_MASK #define PAGE_MASK (PAGE_SIZE - 1) #endif #ifndef PAGE_OFFSET #define PAGE_OFFSET(_addr) ((uintptr_t)(_addr) & (PAGE_SIZE - 1)) #endif #ifndef PAGE_NUMBER #define PAGE_NUMBER(_addr) ((uintptr_t)(_addr) / PAGE_SIZE) #endif #ifndef VM_PAGE_BASE #define VM_PAGE_BASE(_addr) ((_addr) & ~(PAGE_SIZE - 1)) #endif #ifndef VM_PAGES_SPANNED #define VM_PAGES_SPANNED(_addr, _size) \ ((((_addr) & (PAGE_SIZE - 1)) + (_size) + (PAGE_SIZE - 1)) >> PAGE_SHIFT) #endif #ifndef BYTES_2_PAGES #define BYTES_2_PAGES(_nbytes) ((_nbytes) >> PAGE_SHIFT) #endif #ifndef PAGES_2_BYTES #define PAGES_2_BYTES(_npages) (((uint64)(_npages)) << PAGE_SHIFT) #endif #ifndef MBYTES_SHIFT #define MBYTES_SHIFT 20 #endif #ifndef MBYTES_2_PAGES #define MBYTES_2_PAGES(_nbytes) \ ((uint64)(_nbytes) << (MBYTES_SHIFT - PAGE_SHIFT)) #endif #ifndef PAGES_2_MBYTES #define PAGES_2_MBYTES(_npages) ((_npages) >> (MBYTES_SHIFT - PAGE_SHIFT)) #endif #ifndef ROUNDUP_PAGES_2_MBYTES #define ROUNDUP_PAGES_2_MBYTES(_npages) \ (((_npages) + MASK(MBYTES_SHIFT - PAGE_SHIFT)) >> (MBYTES_SHIFT - PAGE_SHIFT)) #endif #ifndef ROUNDDOWN_PAGES_2_MBYTES #define ROUNDDOWN_PAGES_2_MBYTES(_npages) \ ((_npages) >> (MBYTES_SHIFT - PAGE_SHIFT)) #endif #ifndef GBYTES_2_PAGES #define GBYTES_2_PAGES(_nbytes) ((uint64)(_nbytes) << (30 - PAGE_SHIFT)) #endif #ifndef PAGES_2_GBYTES #define PAGES_2_GBYTES(_npages) ((_npages) >> (30 - PAGE_SHIFT)) #endif #ifndef BYTES_2_MBYTES #define BYTES_2_MBYTES(_nbytes) ((_nbytes) >> MBYTES_SHIFT) #endif #ifndef MBYTES_2_BYTES #define MBYTES_2_BYTES(_nbytes) ((uint64)(_nbytes) << MBYTES_SHIFT) #endif #ifndef BYTES_2_GBYTES #define BYTES_2_GBYTES(_nbytes) ((_nbytes) >> 30) #endif #ifndef GBYTES_2_BYTES #define GBYTES_2_BYTES(_nbytes) ((uint64)(_nbytes) << 30) #endif #ifndef VM_PAE_LARGE_PAGE_SHIFT #define VM_PAE_LARGE_PAGE_SHIFT 21 #endif #ifndef VM_PAE_LARGE_PAGE_SIZE #define VM_PAE_LARGE_PAGE_SIZE (1 << VM_PAE_LARGE_PAGE_SHIFT) #endif #ifndef VM_PAE_LARGE_PAGE_MASK #define VM_PAE_LARGE_PAGE_MASK (VM_PAE_LARGE_PAGE_SIZE - 1) #endif #ifndef VM_PAE_LARGE_2_SMALL_PAGES #define VM_PAE_LARGE_2_SMALL_PAGES (BYTES_2_PAGES(VM_PAE_LARGE_PAGE_SIZE)) #endif #ifndef VM_PAE_LARGE_2_BYTES #define VM_PAE_LARGE_2_BYTES(_2mbytes) ((_2mbytes) << VM_PAE_LARGE_PAGE_SHIFT) #endif #ifndef VM_1GB_PAGE_SHIFT #define VM_1GB_PAGE_SHIFT 30 #endif #ifndef VM_1GB_PAGE_SIZE #define VM_1GB_PAGE_SIZE (1 << VM_1GB_PAGE_SHIFT) #endif #ifndef VM_1GB_2_PAGES #define VM_1GB_2_PAGES (BYTES_2_PAGES(VM_1GB_PAGE_SIZE)) #endif #ifndef VM_1GB_2_PDIRS #define VM_1GB_2_PDIRS (VM_1GB_PAGE_SIZE / VM_PAE_LARGE_PAGE_SIZE) #endif /* * Word operations */ #ifndef LOWORD #define LOWORD(_dw) ((_dw) & 0xffff) #endif #ifndef HIWORD #define HIWORD(_dw) (((_dw) >> 16) & 0xffff) #endif #ifndef LOBYTE #define LOBYTE(_w) ((_w) & 0xff) #endif #ifndef HIBYTE #define HIBYTE(_w) (((_w) >> 8) & 0xff) #endif #ifndef HIDWORD #define HIDWORD(_qw) ((uint32)((_qw) >> 32)) #endif #ifndef LODWORD #define LODWORD(_qw) ((uint32)(_qw)) #endif #define QWORD(_hi, _lo) ((((uint64)(_hi)) << 32) | ((uint32)(_lo))) /* * Deposit a field _src at _pos bits from the right, * with a length of _len, into the integer _target. */ #define DEPOSIT_BITS(_src,_pos,_len,_target) { \ unsigned mask = ((1 << _len) - 1); \ unsigned shiftedmask = ((1 << _len) - 1) << _pos; \ _target = (_target & ~shiftedmask) | ((_src & mask) << _pos); \ } /* * Get return address. */ #ifdef _MSC_VER #ifdef __cplusplus extern "C" #endif void *_ReturnAddress(void); #pragma intrinsic(_ReturnAddress) #define GetReturnAddress() _ReturnAddress() #elif __GNUC__ #define GetReturnAddress() __builtin_return_address(0) #endif #ifdef __GNUC__ #ifndef sun /* * A bug in __builtin_frame_address was discovered in gcc 4.1.1, and * fixed in 4.2.0; assume it originated in 4.0. PR 147638 and 554369. */ #if !(__GNUC__ == 4 && (__GNUC_MINOR__ == 0 || __GNUC_MINOR__ == 1)) #define GetFrameAddr() __builtin_frame_address(0) #endif #endif // sun #endif // __GNUC__ /* * Data prefetch was added in gcc 3.1.1 * http://www.gnu.org/software/gcc/gcc-3.1/changes.html */ #ifdef __GNUC__ # if ((__GNUC__ > 3) || (__GNUC__ == 3 && __GNUC_MINOR__ > 1) || \ (__GNUC__ == 3 && __GNUC_MINOR__ == 1 && __GNUC_PATCHLEVEL__ >= 1)) # define PREFETCH_R(var) __builtin_prefetch((var), 0 /* read */, \ 3 /* high temporal locality */) # define PREFETCH_W(var) __builtin_prefetch((var), 1 /* write */, \ 3 /* high temporal locality */) # else # define PREFETCH_R(var) ((void)(var)) # define PREFETCH_W(var) ((void)(var)) # endif #endif /* __GNUC__ */ #ifdef USERLEVEL // { /* * Standardize some Posix names on Windows. */ #ifdef _WIN32 // { /* Conflict with definition of Visual Studio 2015 */ #if (_MSC_VER < 1900) #define snprintf _snprintf #endif #define strtok_r strtok_s #if (_MSC_VER < 1500) #define vsnprintf _vsnprintf #endif typedef int uid_t; typedef int gid_t; static INLINE void sleep(unsigned int sec) { Sleep(sec * 1000); } static INLINE int usleep(unsigned long usec) { Sleep(CEILING(usec, 1000)); return 0; } typedef int pid_t; #define F_OK 0 #define X_OK 1 #define W_OK 2 #define R_OK 4 #endif // } /* * Macro for username comparison. */ #ifdef _WIN32 // { #define USERCMP(x,y) Str_Strcasecmp(x,y) #else #define USERCMP(x,y) strcmp(x,y) #endif // } #endif // } #ifndef va_copy #ifdef _WIN32 /* * Windows needs va_copy. This works for both 32 and 64-bit Windows * based on inspection of how varags.h from the Visual C CRTL is * implemented. (Future versions of the RTL may break this). */ #define va_copy(dest, src) ((dest) = (src)) #elif defined(__APPLE__) && defined(KERNEL) // The macOS kernel SDK defines va_copy in stdarg.h. #include <stdarg.h> #elif defined(__GNUC__) && (__GNUC__ < 3) /* * Old versions of gcc recognize __va_copy, but not va_copy. */ #define va_copy(dest, src) __va_copy(dest, src) #endif // _WIN32 #endif // va_copy /* * This one is outside USERLEVEL because it's used by * files compiled into the Windows hgfs driver or the display * driver. */ #if defined(_WIN32) && defined(_MSC_VER) #define PATH_MAX 256 #ifndef strcasecmp #define strcasecmp(_s1,_s2) _stricmp((_s1),(_s2)) #endif #ifndef strncasecmp #define strncasecmp(_s1,_s2,_n) _strnicmp((_s1),(_s2),(_n)) #endif #endif /* * Convenience definitions of unicode characters. */ #ifndef UTF8_ELLIPSIS #define UTF8_ELLIPSIS "\xe2\x80\xa6" #endif /* * Convenience macros and definitions. Can often be used instead of #ifdef. */ #undef ARM64_ONLY #ifdef VM_ARM_64 #define ARM64_ONLY(x) x #else #define ARM64_ONLY(x) #endif #undef X86_ONLY #ifdef VM_X86_ANY #define X86_ONLY(x) x #else #define X86_ONLY(x) #endif #undef DEBUG_ONLY #ifdef VMX86_DEBUG #define vmx86_debug 1 #define DEBUG_ONLY(x) x #else #define vmx86_debug 0 #define DEBUG_ONLY(x) #endif #ifdef VMX86_STATS #define vmx86_stats 1 #define STATS_ONLY(x) x #else #define vmx86_stats 0 #define STATS_ONLY(x) #endif #ifdef VMX86_DEVEL #define vmx86_devel 1 #define DEVEL_ONLY(x) x #else #define vmx86_devel 0 #define DEVEL_ONLY(x) #endif #ifdef VMX86_LOG #define vmx86_log 1 #define LOG_ONLY(x) x #else #define vmx86_log 0 #define LOG_ONLY(x) #endif #ifdef VMX86_BETA #define vmx86_beta 1 #define BETA_ONLY(x) x #else #define vmx86_beta 0 #define BETA_ONLY(x) #endif #ifdef VMX86_RELEASE #define vmx86_release 1 #define RELEASE_ONLY(x) x #else #define vmx86_release 0 #define RELEASE_ONLY(x) #endif #ifdef VMX86_SERVER #define vmx86_server 1 #define SERVER_ONLY(x) x #define HOSTED_ONLY(x) #else #define vmx86_server 0 #define SERVER_ONLY(x) #define HOSTED_ONLY(x) x #endif #ifdef VMKERNEL #define vmkernel 1 #define VMKERNEL_ONLY(x) x #else #define vmkernel 0 #define VMKERNEL_ONLY(x) #endif #ifdef _WIN32 #define WIN32_ONLY(x) x #define POSIX_ONLY(x) #define vmx86_win32 1 #else #define WIN32_ONLY(x) #define POSIX_ONLY(x) x #define vmx86_win32 0 #endif #ifdef __linux__ #define vmx86_linux 1 #define LINUX_ONLY(x) x #else #define vmx86_linux 0 #define LINUX_ONLY(x) #endif #ifdef __APPLE__ #define vmx86_apple 1 #define APPLE_ONLY(x) x #else #define vmx86_apple 0 #define APPLE_ONLY(x) #endif #if defined(__APPLE__) && defined(VMW_APPLE_SANDBOX) #define vmw_apple_sandbox 1 #else #define vmw_apple_sandbox 0 #endif #if defined(__APPLE__) && defined(VMW_APPLE_APP_STORE) #define vmw_apple_app_store 1 #else #define vmw_apple_app_store 0 #endif #ifdef VMM #define VMM_ONLY(x) x #else #define VMM_ONLY(x) #endif #if defined(VMM) || defined(VMKERNEL) #define USER_ONLY(x) #else #define USER_ONLY(x) x #endif #ifdef _WIN32 #define VMW_INVALID_HANDLE INVALID_HANDLE_VALUE #else #define VMW_INVALID_HANDLE (-1LL) #endif #ifdef _WIN32 #define fsync(fd) _commit(fd) #define fileno(f) _fileno(f) #else #endif /* * Debug output macros for Windows drivers (the Eng variant is for * display/printer drivers only. */ #ifdef _WIN32 #ifndef USES_OLD_WINDDK #if defined(VMX86_LOG) #ifdef _WIN64 #define WinDrvPrint(arg, ...) DbgPrintEx(DPFLTR_IHVDRIVER_ID, (ULONG)~0, arg, __VA_ARGS__) #else #define WinDrvPrint(arg, ...) DbgPrint(arg, __VA_ARGS__) #endif #define WinDrvEngPrint(arg, ...) EngDbgPrint(arg, __VA_ARGS__) #else #define WinDrvPrint(arg, ...) #define WinDrvEngPrint(arg, ...) #endif #endif #endif // _WIN32 #ifdef HOSTED_LG_PG #define hosted_lg_pg 1 #else #define hosted_lg_pg 0 #endif /* * Use to initialize cbSize for this structure to preserve < Vista * compatibility. */ #define NONCLIENTMETRICSINFO_V1_SIZE CCSIZEOF_STRUCT(NONCLIENTMETRICS, \ lfMessageFont) /* This is not intended to be thread-safe. */ #define DO_ONCE(code) \ do { \ static Bool _doOnceDone = FALSE; \ if (UNLIKELY(!_doOnceDone)) { \ _doOnceDone = TRUE; \ code; \ } \ } while (0) /* * Bug 827422 and 838523. */ #if defined __GNUC__ && __GNUC__ >= 4 #define VISIBILITY_HIDDEN __attribute__((visibility("hidden"))) #else #define VISIBILITY_HIDDEN /* nothing */ #endif /* * Bitfield extraction. */ #define EXTRACT_BITSLICE32(_val , _lsb, _msb) \ (((uint32)(_val) << (31 - (_msb))) >> ((31 - (_msb)) + (_lsb))) #define EXTRACT_BITFIELD32(_val, _pos, _len) \ EXTRACT_BITSLICE32((_val), (_pos), ((_pos) + (_len) - 1)) #define EXTRACT_BITSLICE64(_val, _lsb, _msb) \ (((uint64)(_val) << (63 - (_msb))) >> ((63 - (_msb)) + (_lsb))) #define EXTRACT_BITFIELD64(_val, _pos, _len) \ EXTRACT_BITSLICE64((_val), (_pos), ((_pos) + (_len) - 1)) /* * Typical cache line size. Use this for aligning structures to cache * lines for performance, but do not rely on it for correctness. * * On x86, all current processors newer than P4 have 64-byte lines, * but P4 had 128. * * On ARM, the line size can vary between cores. 64-byte lines are * common, but either larger or smaller powers of two are possible. */ #define CACHELINE_SIZE 64 #define CACHELINE_SHIFT 6 #define CACHELINE_ALIGNMENT_MASK (CACHELINE_SIZE - 1) /* * Bits to bytes sizes. */ #define SIZE_8BIT 1 #define SIZE_16BIT 2 #define SIZE_24BIT 3 #define SIZE_32BIT 4 #define SIZE_48BIT 6 #define SIZE_64BIT 8 #define SIZE_80BIT 10 #define SIZE_128BIT 16 #define SIZE_256BIT 32 #define SIZE_512BIT 64 /* * Allocate a variable of type _type, aligned to _align bytes, returning a * pointer to the variable in _var. Potentially _align - 1 bytes may be * wasted. On x86, GCC 6.3.0 behaves sub-optimally when variables are declared * on the stack using the aligned attribute, so this pattern is preferred. * See PRs 1795155, 1819963. */ #define WITH_PTR_TO_ALIGNED_VAR(_type, _align, _var) \ do { \ uint8 _buf_##_var[sizeof(_type) + (_align) - 1]; \ _type *_var = (_type *) ((uintptr_t)(_buf_##_var + (_align) - 1) & \ ~((uintptr_t) ((_align) - 1))); #define END_PTR_TO_ALIGNED_VAR \ } while (0) #endif // ifndef _VM_BASIC_DEFS_H_ vmci-only/shared/backdoor_def.h 0000444 0000000 0000000 00000033730 13432725350 015522 0 ustar root root /********************************************************* * Copyright (C) 1998-2018 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 * *********************************************************/ /* * backdoor_def.h -- * * This contains backdoor defines that can be included from * an assembly language file. */ #ifndef _BACKDOOR_DEF_H_ #define _BACKDOOR_DEF_H_ #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_USERLEVEL #define INCLUDE_ALLOW_VMCORE #define INCLUDE_ALLOW_VMKERNEL #include "includeCheck.h" #if defined __cplusplus extern "C" { #endif /* * If you want to add a new low-level backdoor call for a guest userland * application, please consider using the GuestRpc mechanism instead. --hpreg */ #define BDOOR_MAGIC 0x564D5868 /* Low-bandwidth backdoor port. --hpreg */ #define BDOOR_PORT 0x5658 #define BDOOR_CMD_GETMHZ 1 /* * BDOOR_CMD_APMFUNCTION is used by: * * o The FrobOS code, which instead should either program the virtual chipset * (like the new BIOS code does, matthias offered to implement that), or not * use any VM-specific code (which requires that we correctly implement * "power off on CLI HLT" for SMP VMs, boris offered to implement that) * * o The old BIOS code, which will soon be jettisoned * * --hpreg */ #define BDOOR_CMD_APMFUNCTION 2 /* CPL0 only. */ #define BDOOR_CMD_GETDISKGEO 3 #define BDOOR_CMD_GETPTRLOCATION 4 #define BDOOR_CMD_SETPTRLOCATION 5 #define BDOOR_CMD_GETSELLENGTH 6 #define BDOOR_CMD_GETNEXTPIECE 7 #define BDOOR_CMD_SETSELLENGTH 8 #define BDOOR_CMD_SETNEXTPIECE 9 #define BDOOR_CMD_GETVERSION 10 #define BDOOR_CMD_GETDEVICELISTELEMENT 11 #define BDOOR_CMD_TOGGLEDEVICE 12 #define BDOOR_CMD_GETGUIOPTIONS 13 #define BDOOR_CMD_SETGUIOPTIONS 14 #define BDOOR_CMD_GETSCREENSIZE 15 #define BDOOR_CMD_MONITOR_CONTROL 16 /* Disabled by default. */ #define BDOOR_CMD_GETHWVERSION 17 #define BDOOR_CMD_OSNOTFOUND 18 /* CPL0 only. */ #define BDOOR_CMD_GETUUID 19 #define BDOOR_CMD_GETMEMSIZE 20 //#define BDOOR_CMD_HOSTCOPY 21 /* Not in use. Was devel only. */ //#define BDOOR_CMD_SERVICE_VM 22 /* Not in use. Never shipped. */ #define BDOOR_CMD_GETTIME 23 /* Deprecated -> GETTIMEFULL. */ #define BDOOR_CMD_STOPCATCHUP 24 #define BDOOR_CMD_PUTCHR 25 /* Disabled by default. */ #define BDOOR_CMD_ENABLE_MSG 26 /* Devel only. */ //#define BDOOR_CMD_GOTO_TCL 27 /* Not in use. Was devel only */ #define BDOOR_CMD_INITPCIOPROM 28 /* CPL 0 only. */ //#define BDOOR_CMD_INT13 29 /* Not in use. */ #define BDOOR_CMD_MESSAGE 30 #define BDOOR_CMD_SIDT 31 #define BDOOR_CMD_SGDT 32 #define BDOOR_CMD_SLDT_STR 33 #define BDOOR_CMD_ISACPIDISABLED 34 //#define BDOOR_CMD_TOE 35 /* Not in use. */ #define BDOOR_CMD_ISMOUSEABSOLUTE 36 #define BDOOR_CMD_PATCH_SMBIOS_STRUCTS 37 /* CPL 0 only. */ #define BDOOR_CMD_MAPMEM 38 /* Devel only */ #define BDOOR_CMD_ABSPOINTER_DATA 39 #define BDOOR_CMD_ABSPOINTER_STATUS 40 #define BDOOR_CMD_ABSPOINTER_COMMAND 41 //#define BDOOR_CMD_TIMER_SPONGE 42 /* Not in use. */ #define BDOOR_CMD_PATCH_ACPI_TABLES 43 /* CPL 0 only. */ //#define BDOOR_CMD_DEVEL_FAKEHARDWARE 44 /* Not in use. */ #define BDOOR_CMD_GETHZ 45 #define BDOOR_CMD_GETTIMEFULL 46 //#define BDOOR_CMD_STATELOGGER 47 /* Not in use. */ #define BDOOR_CMD_CHECKFORCEBIOSSETUP 48 /* CPL 0 only. */ #define BDOOR_CMD_LAZYTIMEREMULATION 49 /* CPL 0 only. */ #define BDOOR_CMD_BIOSBBS 50 /* CPL 0 only. */ //#define BDOOR_CMD_VASSERT 51 /* Not in use. */ #define BDOOR_CMD_ISGOSDARWIN 52 #define BDOOR_CMD_DEBUGEVENT 53 #define BDOOR_CMD_OSNOTMACOSXSERVER 54 /* CPL 0 only. */ #define BDOOR_CMD_GETTIMEFULL_WITH_LAG 55 #define BDOOR_CMD_ACPI_HOTPLUG_DEVICE 56 /* Devel only. */ #define BDOOR_CMD_ACPI_HOTPLUG_MEMORY 57 /* Devel only. */ #define BDOOR_CMD_ACPI_HOTPLUG_CBRET 58 /* Devel only. */ //#define BDOOR_CMD_GET_HOST_VIDEO_MODES 59 /* Not in use. */ #define BDOOR_CMD_ACPI_HOTPLUG_CPU 60 /* Devel only. */ //#define BDOOR_CMD_USB_HOTPLUG_MOUSE 61 /* Not in use. Never shipped. */ #define BDOOR_CMD_XPMODE 62 /* CPL 0 only. */ #define BDOOR_CMD_NESTING_CONTROL 63 #define BDOOR_CMD_FIRMWARE_INIT 64 /* CPL 0 only. */ #define BDOOR_CMD_FIRMWARE_ACPI_SERVICES 65 /* CPL 0 only. */ # define BDOOR_CMD_FAS_GET_TABLE_SIZE 0 # define BDOOR_CMD_FAS_GET_TABLE_DATA 1 # define BDOOR_CMD_FAS_GET_PLATFORM_NAME 2 # define BDOOR_CMD_FAS_GET_PCIE_OSC_MASK 3 # define BDOOR_CMD_FAS_GET_APIC_ROUTING 4 # define BDOOR_CMD_FAS_GET_TABLE_SKIP 5 # define BDOOR_CMD_FAS_GET_SLEEP_ENABLES 6 # define BDOOR_CMD_FAS_GET_HARD_RESET_ENABLE 7 # define BDOOR_CMD_FAS_GET_MOUSE_HID 8 # define BDOOR_CMD_FAS_GET_SMBIOS_VERSION 9 # define BDOOR_CMD_FAS_GET_64BIT_PCI_HOLE_SIZE 10 //#define BDOOR_CMD_FAS_GET_NVDIMM_FMT_CODE 11 /* Not in use. Never shipped. */ # define BDOOR_CMD_FAS_SRP_ENABLED 12 # define BDOOR_CMD_FAS_EXIT_BOOT_SERVICES 13 #define BDOOR_CMD_SENDPSHAREHINTS 66 /* Not in use. Deprecated. */ #define BDOOR_CMD_ENABLE_USB_MOUSE 67 #define BDOOR_CMD_GET_VCPU_INFO 68 # define BDOOR_CMD_VCPU_SLC64 0 # define BDOOR_CMD_VCPU_SYNC_VTSCS 1 # define BDOOR_CMD_VCPU_HV_REPLAY_OK 2 # define BDOOR_CMD_VCPU_LEGACY_X2APIC_OK 3 # define BDOOR_CMD_VCPU_MMIO_HONORS_PAT 4 # define BDOOR_CMD_VCPU_RESERVED 31 #define BDOOR_CMD_EFI_SERIALCON_CONFIG 69 /* CPL 0 only. */ #define BDOOR_CMD_BUG328986 70 /* CPL 0 only. */ #define BDOOR_CMD_FIRMWARE_ERROR 71 /* CPL 0 only. */ # define BDOOR_CMD_FE_INSUFFICIENT_MEM 0 # define BDOOR_CMD_FE_EXCEPTION 1 # define BDOOR_CMD_FE_SGX 2 # define BDOOR_CMD_FE_PCI_MMIO 3 #define BDOOR_CMD_VMK_INFO 72 #define BDOOR_CMD_EFI_BOOT_CONFIG 73 /* CPL 0 only. */ # define BDOOR_CMD_EBC_LEGACYBOOT_ENABLED 0 # define BDOOR_CMD_EBC_GET_ORDER 1 # define BDOOR_CMD_EBC_SHELL_ACTIVE 2 # define BDOOR_CMD_EBC_GET_NETWORK_BOOT_PROTOCOL 3 # define BDOOR_CMD_EBC_QUICKBOOT_ENABLED 4 # define BDOOR_CMD_EBC_GET_PXE_ARCH 5 #define BDOOR_CMD_GET_HW_MODEL 74 /* CPL 0 only. */ #define BDOOR_CMD_GET_SVGA_CAPABILITIES 75 /* CPL 0 only. */ #define BDOOR_CMD_GET_FORCE_X2APIC 76 /* CPL 0 only */ #define BDOOR_CMD_SET_PCI_HOLE 77 /* CPL 0 only */ #define BDOOR_CMD_GET_PCI_HOLE 78 /* CPL 0 only */ #define BDOOR_CMD_GET_PCI_BAR 79 /* CPL 0 only */ #define BDOOR_CMD_SHOULD_GENERATE_SYSTEMID 80 /* CPL 0 only */ #define BDOOR_CMD_READ_DEBUG_FILE 81 /* Devel only. */ #define BDOOR_CMD_SCREENSHOT 82 /* Devel only. */ #define BDOOR_CMD_INJECT_KEY 83 /* Devel only. */ #define BDOOR_CMD_INJECT_MOUSE 84 /* Devel only. */ #define BDOOR_CMD_MKS_GUEST_STATS 85 /* CPL 0 only. */ # define BDOOR_CMD_MKSGS_RESET 0 # define BDOOR_CMD_MKSGS_ADD_PPN 1 # define BDOOR_CMD_MKSGS_REMOVE_PPN 2 #define BDOOR_CMD_ABSPOINTER_RESTRICT 86 #define BDOOR_CMD_GUEST_INTEGRITY 87 # define BDOOR_CMD_GI_GET_CAPABILITIES 0 # define BDOOR_CMD_GI_SETUP_ENTRY_POINT 1 # define BDOOR_CMD_GI_SETUP_ALERTS 2 # define BDOOR_CMD_GI_SETUP_STORE 3 # define BDOOR_CMD_GI_SETUP_EVENT_RING 4 # define BDOOR_CMD_GI_SETUP_NON_FAULT_READ 5 # define BDOOR_CMD_GI_ENTER_INTEGRITY_MODE 6 # define BDOOR_CMD_GI_EXIT_INTEGRITY_MODE 7 # define BDOOR_CMD_GI_RESET_INTEGRITY_MODE 8 # define BDOOR_CMD_GI_GET_EVENT_RING_STATE 9 # define BDOOR_CMD_GI_CONSUME_RING_EVENTS 10 # define BDOOR_CMD_GI_WATCH_MAPPINGS_START 11 # define BDOOR_CMD_GI_WATCH_MAPPINGS_STOP 12 # define BDOOR_CMD_GI_CHECK_MAPPINGS_NOW 13 # define BDOOR_CMD_GI_WATCH_PPNS_START 14 # define BDOOR_CMD_GI_WATCH_PPNS_STOP 15 # define BDOOR_CMD_GI_SEND_MSG 16 # define BDOOR_CMD_GI_TEST_READ_MOB 128 # define BDOOR_CMD_GI_TEST_ADD_EVENT 129 # define BDOOR_CMD_GI_TEST_MAPPING 130 # define BDOOR_CMD_GI_TEST_PPN 131 # define BDOOR_CMD_GI_MAX 131 #define BDOOR_CMD_MKSSTATS_SNAPSHOT 88 /* Devel only. */ # define BDOOR_CMD_MKSSTATS_START 0 # define BDOOR_CMD_MKSSTATS_STOP 1 #define BDOOR_CMD_SECUREBOOT 89 #define BDOOR_CMD_COPY_PHYSMEM 90 /* Devel only. */ #define BDOOR_CMD_STEALCLOCK 91 /* CPL 0 only. */ # define BDOOR_STEALCLOCK_STATUS_DISABLED 0 # define BDOOR_STEALCLOCK_STATUS_ENABLED 1 #define BDOOR_CMD_GUEST_PAGE_HINTS 92 /* CPL 0 only */ #define BDOOR_CMD_FIRMWARE_UPDATE 93 /* CPL 0 only. */ # define BDOOR_CMD_FU_GET_HOST_VERSION 0 # define BDOOR_CMD_FU_UPDATE_FROM_HOST 1 # define BDOOR_CMD_FU_LOCK 2 #define BDOOR_CMD_FUZZER_HELPER 94 /* Devel only. */ # define BDOOR_CMD_FUZZER_INIT 0 # define BDOOR_CMD_FUZZER_NEXT 1 #define BDOOR_CMD_PUTCHR12 95 #define BDOOR_CMD_MAX 96 /* * IMPORTANT NOTE: When modifying the behavior of an existing backdoor command, * you must adhere to the semantics expected by the oldest Tools who use that * command. Specifically, do not alter the way in which the command modifies * the registers. Otherwise backwards compatibility will suffer. */ /* Nesting control operations */ #define NESTING_CONTROL_RESTRICT_BACKDOOR 0 #define NESTING_CONTROL_OPEN_BACKDOOR 1 #define NESTING_CONTROL_QUERY 2 #define NESTING_CONTROL_MAX 2 /* EFI Boot Order options, nibble-sized. */ #define EFI_BOOT_ORDER_TYPE_EFI 0x0 #define EFI_BOOT_ORDER_TYPE_LEGACY 0x1 #define EFI_BOOT_ORDER_TYPE_NONE 0xf #define BDOOR_NETWORK_BOOT_PROTOCOL_NONE 0x0 #define BDOOR_NETWORK_BOOT_PROTOCOL_IPV4 0x1 #define BDOOR_NETWORK_BOOT_PROTOCOL_IPV6 0x2 #define BDOOR_SECUREBOOT_STATUS_DISABLED 0xFFFFFFFFUL #define BDOOR_SECUREBOOT_STATUS_APPROVED 1 #define BDOOR_SECUREBOOT_STATUS_DENIED 2 /* High-bandwidth backdoor port. --hpreg */ #define BDOORHB_PORT 0x5659 #define BDOORHB_CMD_MESSAGE 0 #define BDOORHB_CMD_VASSERT 1 #define BDOORHB_CMD_MAX 2 /* * There is another backdoor which allows access to certain TSC-related * values using otherwise illegal PMC indices when the pseudo_perfctr * control flag is set. */ #define BDOOR_PMC_HW_TSC 0x10000 #define BDOOR_PMC_REAL_NS 0x10001 #define BDOOR_PMC_APPARENT_NS 0x10002 #define BDOOR_PMC_PSEUDO_TSC 0x10003 #define IS_BDOOR_PMC(index) (((index) | 3) == 0x10003) #define BDOOR_CMD(ecx) ((ecx) & 0xffff) /* Sub commands for BDOOR_CMD_VMK_INFO */ #define BDOOR_CMD_VMK_INFO_ENTRY 1 /* * Current format for the guest page hints is: * * Arg0: BDOOR_MAGIC, Arg3: BDOOR_PORT * * Arg1: (rbx on x86) * * 0 64 * | PPN | * * Arg2: (rcx on x86) * * 0 16 32 64 * | Command | Type | Reserved | * * Arg4: (rsi on x86) * * 0 16 64 * | numPages | Reserved | * */ #define BDOOR_GUEST_PAGE_HINTS_NOT_SUPPORTED ((unsigned)-1) #define BDOOR_GUEST_PAGE_HINTS_MAX_PAGES (0xffff) #define BDOOR_GUEST_PAGE_HINTS_TYPE_PSHARE (0) #define BDOOR_GUEST_PAGE_HINTS_TYPE(reg) (((reg) >> 16) & 0xffff) #ifdef VMM /* *---------------------------------------------------------------------- * * Backdoor_CmdRequiresFullyValidVCPU -- * * A few backdoor commands require the full VCPU to be valid * (including GDTR, IDTR, TR and LDTR). The rest get read/write * access to GPRs and read access to Segment registers (selectors). * * Result: * True iff VECX contains a command that require the full VCPU to * be valid. * *---------------------------------------------------------------------- */ static INLINE Bool Backdoor_CmdRequiresFullyValidVCPU(unsigned cmd) { return cmd == BDOOR_CMD_SIDT || cmd == BDOOR_CMD_SGDT || cmd == BDOOR_CMD_SLDT_STR; } #endif #ifdef VM_ARM_64 #define BDOOR_ARM64_LB_PORT (BDOOR_PORT) #define BDOOR_ARM64_HB_PORT_IN (BDOORHB_PORT) #define BDOOR_ARM64_HB_PORT_OUT (BDOORHB_PORT +1) #define BDOOR_ARG0 REG_X0 #define BDOOR_ARG1 REG_X1 #define BDOOR_ARG2 REG_X2 #define BDOOR_ARG3 REG_X3 #define BDOOR_ARG4 REG_X4 #define BDOOR_ARG5 REG_X5 #define BDOOR_ARG6 REG_X6 #else #define BDOOR_ARG0 REG_RAX #define BDOOR_ARG1 REG_RBX #define BDOOR_ARG2 REG_RCX #define BDOOR_ARG3 REG_RDX #define BDOOR_ARG4 REG_RSI #define BDOOR_ARG5 REG_RDI #define BDOOR_ARG6 REG_RBP #endif #if defined __cplusplus } #endif #endif // _BACKDOOR_DEF_H_ vmci-only/shared/compat_ethtool.h 0000444 0000000 0000000 00000003662 13432725347 016150 0 ustar root root /********************************************************* * Copyright (C) 2007 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 * *********************************************************/ #ifndef _COMPAT_ETHTOOL_H #define _COMPAT_ETHTOOL_H /* * ethtool is a userspace utility for getting and setting ethernet device * settings. Kernel support for it was first published in 2.4.0-test11, but * only in 2.4.15 were the ethtool_value struct and the ETHTOOL_GLINK ioctl * added to ethtool.h (together, because the ETHTOOL_GLINK ioctl expects a * single value response). * * Likewise, ioctls for getting and setting TSO were published in 2.4.22. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 4, 0) # include <linux/ethtool.h> # ifndef ETHTOOL_GLINK # define ETHTOOL_GLINK 0x0a typedef struct { __u32 cmd; __u32 data; } compat_ethtool_value; # else typedef struct ethtool_value compat_ethtool_value; # endif # ifndef ETHTOOL_GTSO # define ETHTOOL_GTSO 0x1E # define ETHTOOL_STSO 0x1F # endif #endif #if COMPAT_LINUX_VERSION_CHECK_LT(3, 3, 0) # define compat_ethtool_rxfh_indir_default(i, num_queues) (i % num_queues) #else # define compat_ethtool_rxfh_indir_default(i, num_queues) ethtool_rxfh_indir_default(i, num_queues) #endif #endif /* _COMPAT_ETHTOOL_H */ vmci-only/shared/vm_basic_asm_x86_common.h 0000444 0000000 0000000 00000033175 13432725350 017623 0 ustar root root /********************************************************* * Copyright (C) 2013-2018 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 * *********************************************************/ /* * vm_basic_asm_x86_common.h -- * * Basic assembler macros common to 32-bit and 64-bit x86 ISA. */ #ifndef _VM_BASIC_ASM_X86_COMMON_H_ #define _VM_BASIC_ASM_X86_COMMON_H_ #define INCLUDE_ALLOW_USERLEVEL #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMK_MODULE #define INCLUDE_ALLOW_VMKERNEL #define INCLUDE_ALLOW_DISTRIBUTE #define INCLUDE_ALLOW_VMCORE #include "includeCheck.h" #ifndef VM_X86_ANY #error "Should be included only in x86 builds" #endif /* * x86-64 windows doesn't support inline asm so we have to use these * intrinsic functions defined in the compiler. Not all of these are well * documented. There is an array in the compiler dll (c1.dll) which has * an array of the names of all the intrinsics minus the leading * underscore. Searching around in the ntddk.h file can also be helpful. * * The declarations for the intrinsic functions were taken from the DDK. * Our declarations must match the ddk's otherwise the 64-bit c++ compiler * will complain about second linkage of the intrinsic functions. * We define the intrinsic using the basic types corresponding to the * Windows typedefs. This avoids having to include windows header files * to get to the windows types. */ #if defined(_MSC_VER) && !defined(BORA_NO_WIN32_INTRINS) #ifdef __cplusplus extern "C" { #endif /* * It seems x86 & x86-64 windows still implements these intrinsic * functions. The documentation for the x86-64 suggest the * __inbyte/__outbyte intrinsics even though the _in/_out work fine and * __inbyte/__outbyte aren't supported on x86. */ int _inp(unsigned short); unsigned short _inpw(unsigned short); unsigned long _inpd(unsigned short); int _outp(unsigned short, int); unsigned short _outpw(unsigned short, unsigned short); unsigned long _outpd(uint16, unsigned long); #pragma intrinsic(_inp, _inpw, _inpd, _outp, _outpw, _outpw, _outpd) /* * Prevents compiler from re-ordering reads, writes and reads&writes. * These functions do not add any instructions thus only affect * the compiler ordering. * * See: * `Lockless Programming Considerations for Xbox 360 and Microsoft Windows' * http://msdn.microsoft.com/en-us/library/bb310595(VS.85).aspx */ void _ReadBarrier(void); void _WriteBarrier(void); void _ReadWriteBarrier(void); #pragma intrinsic(_ReadBarrier, _WriteBarrier, _ReadWriteBarrier) void _mm_mfence(void); void _mm_lfence(void); #pragma intrinsic(_mm_mfence, _mm_lfence) long _InterlockedXor(long volatile *, long); #pragma intrinsic(_InterlockedXor) unsigned int __getcallerseflags(void); #pragma intrinsic(__getcallerseflags) #ifdef VM_X86_64 /* * intrinsic functions only supported by x86-64 windows as of 2k3sp1 */ unsigned __int64 __rdtsc(void); void __stosw(unsigned short *, unsigned short, size_t); void __stosd(unsigned long *, unsigned long, size_t); void _mm_pause(void); #pragma intrinsic(__rdtsc, __stosw, __stosd, _mm_pause) unsigned char _BitScanForward64(unsigned long *, unsigned __int64); unsigned char _BitScanReverse64(unsigned long *, unsigned __int64); #pragma intrinsic(_BitScanForward64, _BitScanReverse64) #endif /* VM_X86_64 */ unsigned char _BitScanForward(unsigned long *, unsigned long); unsigned char _BitScanReverse(unsigned long *, unsigned long); #pragma intrinsic(_BitScanForward, _BitScanReverse) unsigned char _bittest(const long *, long); unsigned char _bittestandset(long *, long); unsigned char _bittestandreset(long *, long); unsigned char _bittestandcomplement(long *, long); #pragma intrinsic(_bittest, _bittestandset, _bittestandreset, _bittestandcomplement) #ifdef VM_X86_64 unsigned char _bittestandset64(__int64 *, __int64); unsigned char _bittestandreset64(__int64 *, __int64); #pragma intrinsic(_bittestandset64, _bittestandreset64) #endif // VM_X86_64 #ifdef __cplusplus } #endif #endif // _MSC_VER #ifdef __GNUC__ /* * Checked against the Intel manual and GCC --hpreg * * volatile because reading from port can modify the state of the underlying * hardware. * * Note: The undocumented %z construct doesn't work (internal compiler error) * with gcc-2.95.1 */ #define __GCC_IN(s, type, name) \ static INLINE type \ name(uint16 port) \ { \ type val; \ \ __asm__ __volatile__( \ "in" #s " %w1, %0" \ : "=a" (val) \ : "Nd" (port) \ ); \ \ return val; \ } __GCC_IN(b, uint8, INB) __GCC_IN(w, uint16, INW) __GCC_IN(l, uint32, IN32) /* * Checked against the Intel manual and GCC --hpreg * * Note: The undocumented %z construct doesn't work (internal compiler error) * with gcc-2.95.1 */ #define __GCC_OUT(s, s2, port, val) do { \ __asm__( \ "out" #s " %" #s2 "1, %w0" \ : \ : "Nd" (port), "a" (val) \ ); \ } while (0) #define OUTB(port, val) __GCC_OUT(b, b, port, val) #define OUTW(port, val) __GCC_OUT(w, w, port, val) #define OUT32(port, val) __GCC_OUT(l, , port, val) #define GET_CURRENT_EIP(_eip) \ __asm__ __volatile("call 0\n\tpopl %0" : "=r" (_eip): ); static INLINE unsigned int GetCallerEFlags(void) { unsigned long flags; asm volatile("pushf; pop %0" : "=r"(flags)); return flags; } #elif defined(_MSC_VER) static INLINE uint8 INB(uint16 port) { return (uint8)_inp(port); } static INLINE void OUTB(uint16 port, uint8 value) { _outp(port, value); } static INLINE uint16 INW(uint16 port) { return _inpw(port); } static INLINE void OUTW(uint16 port, uint16 value) { _outpw(port, value); } static INLINE uint32 IN32(uint16 port) { return _inpd(port); } static INLINE void OUT32(uint16 port, uint32 value) { _outpd(port, value); } #ifndef VM_X86_64 #ifdef NEAR #undef NEAR #endif #define GET_CURRENT_EIP(_eip) do { \ __asm call NEAR PTR $+5 \ __asm pop eax \ __asm mov _eip, eax \ } while (0) #endif // VM_X86_64 static INLINE unsigned int GetCallerEFlags(void) { return __getcallerseflags(); } #endif // __GNUC__ /* Sequence recommended by Intel for the Pentium 4. */ #define INTEL_MICROCODE_VERSION() ( \ __SET_MSR(MSR_BIOS_SIGN_ID, 0), \ __GET_EAX_FROM_CPUID(1), \ __GET_MSR(MSR_BIOS_SIGN_ID)) /* *----------------------------------------------------------------------------- * * RDTSC_BARRIER -- * * Implements an RDTSC fence. Instructions executed prior to the * fence will have completed before the fence and all stores to * memory are flushed from the store buffer. * * On AMD, MFENCE is sufficient. On Intel, only LFENCE is * documented to fence RDTSC, but LFENCE won't drain the store * buffer. So, use MFENCE;LFENCE, which will work on both AMD and * Intel. * * It is the callers' responsibility to check for SSE2 before * calling this function. * * Results: * None. * * Side effects: * Cause loads and stores prior to this to be globally visible, and * RDTSC will not pass. * *----------------------------------------------------------------------------- */ static INLINE void RDTSC_BARRIER(void) { #ifdef __GNUC__ __asm__ __volatile__( "mfence \n\t" "lfence \n\t" ::: "memory" ); #elif defined _MSC_VER /* Prevent compiler from moving code across mfence/lfence. */ _ReadWriteBarrier(); _mm_mfence(); _mm_lfence(); _ReadWriteBarrier(); #else #error No compiler defined for RDTSC_BARRIER #endif } /* * Memory Barriers * =============== * * Terminology * ----------- * * A compiler memory barrier prevents the compiler from re-ordering memory * accesses accross the barrier. It is not a CPU instruction, it is a compiler * directive (i.e. it does not emit any code). * * A CPU memory barrier prevents the CPU from re-ordering memory accesses * accross the barrier. It is a CPU instruction. * * A memory barrier is the union of a compiler memory barrier and a CPU memory * barrier. A compiler memory barrier is a useless construct by itself. It is * only useful when combined with a CPU memory barrier, to implement a memory * barrier. * * Semantics * --------- * * At the time COMPILER_*_BARRIER were created (and references to them were * added to the code), the code was only targetting x86. The intent of the code * was really to use a memory barrier, but because x86 uses a strongly ordered * memory model, the CPU would not re-order memory accesses, and the code could * get away with using just a compiler memory barrier. So COMPILER_*_BARRIER * were born and were implemented as compiler memory barriers _on x86_. But * make no mistake, _the semantics that the code expects from * COMPILER_*_BARRIER are that of a memory barrier_! * * DO NOT USE! * ----------- * * On at least one non-x86 architecture, COMPILER_*_BARRIER are * 1) Misnomers * 2) Not fine-grained enough to provide the best performance. * For the above two reasons, usage of COMPILER_*_BARRIER is now deprecated. * _Do not add new references to COMPILER_*_BARRIER._ Instead, precisely * document the intent of your code by using * <mem_type/purpose>_<before_access_type>_BARRIER_<after_access_type>. * Existing references to COMPILER_*_BARRIER are being slowly but surely * converted, and when no references are left, COMPILER_*_BARRIER will be * retired. * * Thanks for pasting this whole comment into every architecture header. */ #if defined __GNUC__ # define COMPILER_READ_BARRIER() COMPILER_MEM_BARRIER() # define COMPILER_WRITE_BARRIER() COMPILER_MEM_BARRIER() # define COMPILER_MEM_BARRIER() __asm__ __volatile__("" ::: "memory") #elif defined _MSC_VER # define COMPILER_READ_BARRIER() _ReadBarrier() # define COMPILER_WRITE_BARRIER() _WriteBarrier() # define COMPILER_MEM_BARRIER() _ReadWriteBarrier() #endif /* * Memory barriers. These take the form of * * <mem_type/purpose>_<before_access_type>_BARRIER_<after_access_type> * * where: * <mem_type/purpose> is either SMP, DMA, or MMIO. * <*_access type> is either R(load), W(store) or RW(any). * * Above every use of these memory barriers in the code, there _must_ be a * comment to justify the use, i.e. a comment which: * * 1) Precisely identifies which memory accesses must not be re-ordered across * the memory barrier. * 2) Explains why it is important that the memory accesses not be re-ordered. * * Thanks for pasting this whole comment into every architecture header. * * On x86, we only need to care specifically about store-load reordering on * normal memory types. In other cases, only a compiler barrier is needed. * SMP_W_BARRIER_R is implemented with a locked xor operation (instead of the * mfence instruction) for performance reasons. See PR 1674199 for more * details. * * On x64, special instructions are only provided for load-load (lfence) and * store-store (sfence) ordering, and they don't apply to normal memory. */ static INLINE void SMP_W_BARRIER_R(void) { volatile long temp; #if defined __GNUC__ __asm__ __volatile__ ( "lock xorl $1, %0" : "+m" (temp) : /* no additional inputs */ : "cc", "memory"); #elif defined _MSC_VER _InterlockedXor(&temp, 1); #else #error SMP_W_BARRIER_R not defined for this compiler #endif } #define SMP_R_BARRIER_R() COMPILER_READ_BARRIER() #define SMP_R_BARRIER_W() COMPILER_MEM_BARRIER() #define SMP_R_BARRIER_RW() COMPILER_MEM_BARRIER() #define SMP_W_BARRIER_W() COMPILER_WRITE_BARRIER() #define SMP_W_BARRIER_RW() SMP_W_BARRIER_R() #define SMP_RW_BARRIER_R() SMP_W_BARRIER_R() #define SMP_RW_BARRIER_W() COMPILER_MEM_BARRIER() #define SMP_RW_BARRIER_RW() SMP_W_BARRIER_R() /* * Like the above, only for use with observers other than CPUs, * i.e. DMA masters. */ #define DMA_R_BARRIER_R() SMP_R_BARRIER_R() #define DMA_R_BARRIER_W() SMP_R_BARRIER_W() #define DMA_R_BARRIER_RW() SMP_R_BARRIER_RW() #define DMA_W_BARRIER_R() SMP_W_BARRIER_R() #define DMA_W_BARRIER_W() SMP_W_BARRIER_W() #define DMA_W_BARRIER_RW() SMP_W_BARRIER_RW() #define DMA_RW_BARRIER_R() SMP_RW_BARRIER_R() #define DMA_RW_BARRIER_W() SMP_RW_BARRIER_W() #define DMA_RW_BARRIER_RW() SMP_RW_BARRIER_RW() /* * And finally a set for use with MMIO accesses. */ #define MMIO_R_BARRIER_R() SMP_R_BARRIER_R() #define MMIO_R_BARRIER_W() SMP_R_BARRIER_W() #define MMIO_R_BARRIER_RW() SMP_R_BARRIER_RW() #define MMIO_W_BARRIER_R() SMP_W_BARRIER_R() #define MMIO_W_BARRIER_W() SMP_W_BARRIER_W() #define MMIO_W_BARRIER_RW() SMP_W_BARRIER_RW() #define MMIO_RW_BARRIER_R() SMP_RW_BARRIER_R() #define MMIO_RW_BARRIER_W() SMP_RW_BARRIER_W() #define MMIO_RW_BARRIER_RW() SMP_RW_BARRIER_RW() #endif // _VM_BASIC_ASM_X86_COMMON_H_ vmci-only/shared/vm_device_version.h 0000444 0000000 0000000 00000034705 13432725350 016631 0 ustar root root /********************************************************* * Copyright (C) 1998,2005-2012,2014-2018 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 * *********************************************************/ #ifndef VM_DEVICE_VERSION_H #define VM_DEVICE_VERSION_H #define INCLUDE_ALLOW_USERLEVEL #define INCLUDE_ALLOW_DISTRIBUTE #define INCLUDE_ALLOW_VMKDRIVERS #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMKERNEL #define INCLUDE_ALLOW_VMCORE #include "includeCheck.h" #ifdef _WIN32 #ifdef __MINGW32__ #include "initguid.h" #else #include "guiddef.h" #endif #endif /* LSILogic 53C1030 Parallel SCSI controller * LSILogic SAS1068 SAS controller */ #define PCI_VENDOR_ID_LSILOGIC 0x1000 #define PCI_DEVICE_ID_LSI53C1030 0x0030 #define PCI_DEVICE_ID_LSISAS1068 0x0054 /* Our own PCI IDs * VMware SVGA II (Unified VGA) * VMware SVGA (PCI Accelerator) * VMware vmxnet (Idealized NIC) * VMware vmxscsi (Abortive idealized SCSI controller) * VMware chipset (Subsystem ID for our motherboards) * VMware e1000 (Subsystem ID) * VMware vmxnet3 (Uniform Pass Through NIC) * VMware HD Audio codec * VMware HD Audio controller */ #define PCI_VENDOR_ID_VMWARE 0x15AD #define PCI_DEVICE_ID_VMWARE_SVGA2 0x0405 #define PCI_DEVICE_ID_VMWARE_SVGA 0x0710 #define PCI_DEVICE_ID_VMWARE_VGA 0x0711 #define PCI_DEVICE_ID_VMWARE_NET 0x0720 #define PCI_DEVICE_ID_VMWARE_SCSI 0x0730 #define PCI_DEVICE_ID_VMWARE_VMCI 0x0740 #define PCI_DEVICE_ID_VMWARE_CHIPSET 0x1976 #define PCI_DEVICE_ID_VMWARE_82545EM 0x0750 /* single port */ #define PCI_DEVICE_ID_VMWARE_82546EB 0x0760 /* dual port */ #define PCI_DEVICE_ID_VMWARE_EHCI 0x0770 #define PCI_DEVICE_ID_VMWARE_UHCI 0x0774 #define PCI_DEVICE_ID_VMWARE_XHCI_0096 0x0778 #define PCI_DEVICE_ID_VMWARE_XHCI_0100 0x0779 #define PCI_DEVICE_ID_VMWARE_1394 0x0780 #define PCI_DEVICE_ID_VMWARE_BRIDGE 0x0790 #define PCI_DEVICE_ID_VMWARE_ROOTPORT 0x07A0 #define PCI_DEVICE_ID_VMWARE_VMXNET3 0x07B0 #define PCI_DEVICE_ID_VMWARE_PVSCSI 0x07C0 #define PCI_DEVICE_ID_VMWARE_82574 0x07D0 #define PCI_DEVICE_ID_VMWARE_AHCI 0x07E0 #define PCI_DEVICE_ID_VMWARE_NVME 0x07F0 #define PCI_DEVICE_ID_VMWARE_HDAUDIO_CODEC 0x1975 #define PCI_DEVICE_ID_VMWARE_HDAUDIO_CONTROLLER 0x1977 /* * TXT vendor, device and revision ID. We are keeping vendor * as Intel since tboot code does not like anything other * than Intel in the SINIT ACM header. */ #define TXT_VENDOR_ID 0x8086 #define TXT_DEVICE_ID 0xB002 #define TXT_REVISION_ID 0x01 /* The hypervisor device might grow. Please leave room * for 7 more subfunctions. */ #define PCI_DEVICE_ID_VMWARE_HYPER 0x0800 #define PCI_DEVICE_ID_VMWARE_VMI 0x0801 #define PCI_DEVICE_VMI_CLASS 0x05 #define PCI_DEVICE_VMI_SUBCLASS 0x80 #define PCI_DEVICE_VMI_INTERFACE 0x00 #define PCI_DEVICE_VMI_REVISION 0x01 /* * Device IDs for the PCI passthru test device: * * 0x0809 is for old fashioned PCI with MSI. * 0x080A is for PCI express with MSI-X. * 0x080B is for PCI express with configurable BARs. */ #define PCI_DEVICE_ID_VMWARE_PCI_TEST 0x0809 #define PCI_DEVICE_ID_VMWARE_PCIE_TEST1 0x080A #define PCI_DEVICE_ID_VMWARE_PCIE_TEST2 0x080B #define PCI_DEVICE_ID_VMWARE_VRDMA 0x0820 #define PCI_DEVICE_ID_VMWARE_VTPM 0x0830 /* * VMware Virtual Device Test Infrastructure (VDTI) devices */ #define PCI_DEVICE_ID_VMWARE_VDTI 0x7E57 /* stands for "TEST" */ /* From linux/pci_ids.h: * AMD Lance Ethernet controller * BusLogic SCSI controller * Ensoniq ES1371 sound controller */ #define PCI_VENDOR_ID_AMD 0x1022 #define PCI_DEVICE_ID_AMD_VLANCE 0x2000 #define PCI_DEVICE_ID_AMD_IOMMU 0x1577 #define PCI_VENDOR_ID_BUSLOGIC 0x104B #define PCI_DEVICE_ID_BUSLOGIC_MULTIMASTER_NC 0x0140 #define PCI_DEVICE_ID_BUSLOGIC_MULTIMASTER 0x1040 #define PCI_VENDOR_ID_ENSONIQ 0x1274 #define PCI_DEVICE_ID_ENSONIQ_ES1371 0x1371 /* From linux/pci_ids.h: * Intel 82439TX (430 HX North Bridge) * Intel 82371AB (PIIX4 South Bridge) * Intel 82443BX (440 BX North Bridge and AGP Bridge) * Intel 82545EM (e1000, server adapter, single port) * Intel 82546EB (e1000, server adapter, dual port) * Intel HECI (as embedded in ich9m) * Intel XHCI (Panther Point / Intel 7 Series) */ #define PCI_VENDOR_ID_INTEL 0x8086 #define PCI_DEVICE_ID_INTEL_82439TX 0x7100 #define PCI_DEVICE_ID_INTEL_82371AB_0 0x7110 #define PCI_DEVICE_ID_INTEL_82371AB_2 0x7112 #define PCI_DEVICE_ID_INTEL_82371AB_3 0x7113 #define PCI_DEVICE_ID_INTEL_82371AB 0x7111 #define PCI_DEVICE_ID_INTEL_82443BX 0x7190 #define PCI_DEVICE_ID_INTEL_82443BX_1 0x7191 #define PCI_DEVICE_ID_INTEL_82443BX_2 0x7192 /* Used when no AGP support */ #define PCI_DEVICE_ID_INTEL_82545EM 0x100f #define PCI_DEVICE_ID_INTEL_82546EB 0x1010 #define PCI_DEVICE_ID_INTEL_82574 0x10d3 #define PCI_DEVICE_ID_INTEL_82574_APPLE 0x10f6 #define PCI_DEVICE_ID_INTEL_HECI 0x2a74 #define PCI_DEVICE_ID_INTEL_PANTHERPOINT_XHCI 0x1e31 /* * From drivers/usb/host/xhci-pci.c: * Intel XHCI (Lynx Point / Intel 8 Series) */ #define PCI_DEVICE_ID_INTEL_LYNXPOINT_XHCI 0x8c31 /* * Intel Volume Management Device (VMD) */ #define PCI_DEVICE_ID_INTEL_VMD_V1 0x201d /* * Intel Quickassist (QAT) devices. */ #define PCI_DEVICE_ID_INTEL_QAT_DH895XCC 0x0435 #define PCI_DEVICE_ID_INTEL_QAT_DH895XCC_VF 0x0443 #define PCI_DEVICE_ID_INTEL_QAT_C62X 0x37c8 #define PCI_DEVICE_ID_INTEL_QAT_C62X_VF 0x37c9 /* * Intel FPGAs */ #define PCI_DEVICE_ID_INTEL_FPGA_SKL_PF 0xbcc0 #define PCI_DEVICE_ID_INTEL_FPGA_SKL_VF 0xbcc1 #define E1000E_PCI_DEVICE_ID_CONFIG_STR "e1000e.pci.deviceID" #define E1000E_PCI_SUB_VENDOR_ID_CONFIG_STR "e1000e.pci.subVendorID" #define E1000E_PCI_SUB_DEVICE_ID_CONFIG_STR "e1000e.pci.subDeviceID" /* * Intel HD Audio controller and Realtek ALC885 codec. */ #define PCI_DEVICE_ID_INTEL_631XESB_632XESB 0x269a #define PCI_VENDOR_ID_REALTEK 0x10ec #define PCI_DEVICE_ID_REALTEK_ALC885 0x0885 /* * Fresco Logic xHCI (USB 3.0) Controller */ #define PCI_VENDOR_ID_FRESCO 0x1B73 #define PCI_DEVICE_ID_FRESCO_FL1000 0x1000 // Original 1-port chip #define PCI_DEVICE_ID_FRESCO_FL1009 0x1009 // New 2-port chip (Driver 3.0.98+) #define PCI_DEVICE_ID_FRESCO_FL1400 0x1400 // Unknown (4-port? Dev hardware?) /* * NEC/Renesas xHCI (USB 3.0) Controller */ #define PCI_VENDOR_ID_NEC 0x1033 #define PCI_DEVICE_ID_NEC_UPD720200 0x0194 #define PCI_REVISION_NEC_UPD720200 0x03 #define PCI_FIRMWARE_NEC_UPD720200 0x3015 #define SATA_ID_SERIAL_STR "00000000000000000001" /* Must be 20 Bytes */ #define SATA_ID_FIRMWARE_STR "00000001" /* Must be 8 Bytes */ #define AHCI_ATA_MODEL_STR PRODUCT_GENERIC_NAME " Virtual SATA Hard Drive" #define AHCI_ATAPI_MODEL_STR PRODUCT_GENERIC_NAME " Virtual SATA CDRW Drive" /************* Strings for IDE Identity Fields **************************/ #define VIDE_ID_SERIAL_STR "00000000000000000001" /* Must be 20 Bytes */ #define VIDE_ID_FIRMWARE_STR "00000001" /* Must be 8 Bytes */ /* No longer than 40 Bytes */ #define VIDE_ATA_MODEL_STR PRODUCT_GENERIC_NAME " Virtual IDE Hard Drive" #define VIDE_ATAPI_MODEL_STR PRODUCT_GENERIC_NAME " Virtual IDE CDROM Drive" #define ATAPI_VENDOR_ID "NECVMWar" /* Must be 8 Bytes */ #define ATAPI_PRODUCT_ID PRODUCT_GENERIC_NAME " IDE CDROM" /* Must be 16 Bytes */ #define ATAPI_REV_LEVEL "1.00" /* Must be 4 Bytes */ #define IDE_NUM_INTERFACES 2 /* support for two interfaces */ #define IDE_DRIVES_PER_IF 2 /************* Strings for SCSI Identity Fields **************************/ #define SCSI_DISK_MODEL_STR PRODUCT_GENERIC_NAME " Virtual SCSI Hard Drive" #define SCSI_DISK_VENDOR_NAME COMPANY_NAME #define SCSI_DISK_REV_LEVEL "1.0" #define SCSI_CDROM_MODEL_STR PRODUCT_GENERIC_NAME " Virtual SCSI CDROM Drive" #define SCSI_CDROM_VENDOR_NAME COMPANY_NAME #define SCSI_CDROM_REV_LEVEL "1.0" /************* NVME implementation limits ********************************/ #define NVME_MAX_CONTROLLERS 4 #define NVME_MIN_NAMESPACES 1 #define NVME_MAX_NAMESPACES 15 /* We support only 15 namespaces same * as SCSI devices. */ /************* SCSI implementation limits ********************************/ #define SCSI_MAX_CONTROLLERS 4 // Need more than 1 for MSCS clustering #define SCSI_MAX_DEVICES 16 // BT-958 emulates only 16 #define PVSCSI_HWV14_MAX_DEVICES 65 /* HWv14 And Later Supports 64 * + controller at ID 7 */ #define PVSCSI_MAX_DEVICES 255 // 255 (including the controller) #define PVSCSI_MAX_NUM_DISKS (PVSCSI_HWV14_MAX_DEVICES - 1) /************* SATA implementation limits ********************************/ #define SATA_MAX_CONTROLLERS 4 #define SATA_MAX_DEVICES 30 #define AHCI_MIN_PORTS 1 #define AHCI_MAX_PORTS SATA_MAX_DEVICES /* * Publicly supported maximum number of disks per VM. */ #define MAX_NUM_DISKS \ ((SATA_MAX_CONTROLLERS * SATA_MAX_DEVICES) + \ (SCSI_MAX_CONTROLLERS * SCSI_MAX_DEVICES) + \ (NVME_MAX_CONTROLLERS * NVME_MAX_NAMESPACES) + \ (IDE_NUM_INTERFACES * IDE_DRIVES_PER_IF)) /* * Maximum number of supported disks in a VM from HWV14 or later, using PVSCSI updated max * devices. The note above still holds true, but instead of publicly supporting * all devices, HWv14 simply extends the maximum support to 256 devices, * instead ~244 calculated above. * * PVSCSI_HW_MAX_DEVICES is 65 - allowing 64 disks + controller (at ID 7) * 4 * 64 = 256 devices. * */ #define MAX_NUM_DISKS_HWV14 MAX(MAX_NUM_DISKS, \ (SCSI_MAX_CONTROLLERS * PVSCSI_MAX_NUM_DISKS)) /* * VSCSI_BV_INTS is the number of uint32's needed for a bit vector * to cover all scsi devices per target. */ #define VSCSI_BV_INTS CEILING(PVSCSI_MAX_DEVICES, 8 * sizeof (uint32)) #define SCSI_IDE_CHANNEL SCSI_MAX_CONTROLLERS #define SCSI_IDE_HOSTED_CHANNEL (SCSI_MAX_CONTROLLERS + 1) #define SCSI_SATA_CHANNEL_FIRST (SCSI_IDE_HOSTED_CHANNEL + 1) #define SCSI_NVME_CHANNEL_FIRST (SCSI_SATA_CHANNEL_FIRST + \ SATA_MAX_CONTROLLERS) #define SCSI_MAX_CHANNELS (SCSI_NVME_CHANNEL_FIRST + \ NVME_MAX_CONTROLLERS) /************* SCSI-NVME channel IDs *******************************/ #define NVME_ID_TO_SCSI_ID(nvmeId) \ (SCSI_NVME_CHANNEL_FIRST + (nvmeId)) #define SCSI_ID_TO_NVME_ID(scsiId) \ ((scsiId) - SCSI_NVME_CHANNEL_FIRST) /************* SCSI-SATA channel IDs********************************/ #define SATA_ID_TO_SCSI_ID(sataId) \ (SCSI_SATA_CHANNEL_FIRST + (sataId)) #define SCSI_ID_TO_SATA_ID(scsiId) \ ((scsiId) - SCSI_SATA_CHANNEL_FIRST) /************* Strings for the VESA BIOS Identity Fields *****************/ #define VBE_OEM_STRING COMPANY_NAME " SVGA" #define VBE_VENDOR_NAME COMPANY_NAME #define VBE_PRODUCT_NAME PRODUCT_GENERIC_NAME /************* PCI implementation limits ********************************/ #define PCI_MAX_BRIDGES 15 /************* Ethernet implementation limits ***************************/ #define MAX_ETHERNET_CARDS 10 /********************** Floppy limits ***********************************/ #define MAX_FLOPPY_DRIVES 2 /************* PCI Passthrough implementation limits ********************/ #define MAX_PCI_PASSTHRU_DEVICES 16 /************* Test device implementation limits ********************/ #define MAX_PCI_TEST_DEVICES 16 /************* VDTI PCI Device implementation limits ********************/ #define MAX_VDTI_PCI_DEVICES 16 /************* USB implementation limits ********************************/ #define MAX_USB_DEVICES_PER_HOST_CONTROLLER 127 /************* NVDIMM implementation limits ********************************/ #define NVDIMM_MAX_CONTROLLERS 1 #define MAX_NVDIMM 64 /************* vRDMA implementation limits ******************************/ #define MAX_VRDMA_DEVICES 1 /************* QAT implementation limits ********************/ #define MAX_QAT_PCI_DEVICES 4 /************* Strings for Host USB Driver *******************************/ #ifdef _WIN32 /* * Globally unique ID for the VMware device interface. Define INITGUID before including * this header file to instantiate the variable. */ DEFINE_GUID(GUID_DEVICE_INTERFACE_VMWARE_USB_DEVICES, 0x2da1fe75, 0xaab3, 0x4d2c, 0xac, 0xdf, 0x39, 0x8, 0x8c, 0xad, 0xa6, 0x65); /* * Globally unique ID for the VMware device setup class. */ DEFINE_GUID(GUID_CLASS_VMWARE_USB_DEVICES, 0x3b3e62a5, 0x3556, 0x4d7e, 0xad, 0xad, 0xf5, 0xfa, 0x3a, 0x71, 0x2b, 0x56); /* * This string defines the device ID string of a VMware USB device. * The format is USB\Vid_XXXX&Pid_YYYY, where XXXX and YYYY are the * hexadecimal representations of the vendor and product ids, respectively. * * The official vendor ID for VMware, Inc. is 0x0E0F. * The product id for USB generic devices is 0x0001. */ #define USB_VMWARE_DEVICE_ID_WIDE L"USB\\Vid_0E0F&Pid_0001" #define USB_DEVICE_ID_LENGTH (sizeof(USB_VMWARE_DEVICE_ID_WIDE) / sizeof(WCHAR)) #ifdef UNICODE #define USB_PNP_SETUP_CLASS_NAME L"VMwareUSBDevices" #define USB_PNP_DRIVER_NAME L"vmusb" #else #define USB_PNP_SETUP_CLASS_NAME "VMwareUSBDevices" #define USB_PNP_DRIVER_NAME "vmusb" #endif #endif /* * Our JEDEC 2 Manufacturer ID number is 2 in bank 10. Our number is nine * bytes of continuation code (with an odd parity bit in bit 7) followed by the * number itself. * */ #define JEDEC_VENDOR_ID_VMWARE 0x289 #define JEDEC_DEVICE_ID_VMWARE_NVDIMM 0x1 #endif /* VM_DEVICE_VERSION_H */ vmci-only/shared/vmci_defs.h 0000444 0000000 0000000 00000066156 13432725350 015067 0 ustar root root /********************************************************* * Copyright (C) 2005-2017 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 * *********************************************************/ #ifndef _VMCI_DEF_H_ #define _VMCI_DEF_H_ #define INCLUDE_ALLOW_USERLEVEL #define INCLUDE_ALLOW_VMMEXT #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMCORE #define INCLUDE_ALLOW_VMK_MODULE #define INCLUDE_ALLOW_VMKERNEL #define INCLUDE_ALLOW_DISTRIBUTE #include "includeCheck.h" #include "vm_basic_types.h" #include "vm_basic_defs.h" #include "vm_atomic.h" #include "vm_assert.h" #if defined __cplusplus extern "C" { #endif /* Register offsets. */ #define VMCI_STATUS_ADDR 0x00 #define VMCI_CONTROL_ADDR 0x04 #define VMCI_ICR_ADDR 0x08 #define VMCI_IMR_ADDR 0x0c #define VMCI_DATA_OUT_ADDR 0x10 #define VMCI_DATA_IN_ADDR 0x14 #define VMCI_CAPS_ADDR 0x18 #define VMCI_RESULT_LOW_ADDR 0x1c #define VMCI_RESULT_HIGH_ADDR 0x20 /* Max number of devices. */ #define VMCI_MAX_DEVICES 1 /* Status register bits. */ #define VMCI_STATUS_INT_ON 0x1 /* Control register bits. */ #define VMCI_CONTROL_RESET 0x1 #define VMCI_CONTROL_INT_ENABLE 0x2 #define VMCI_CONTROL_INT_DISABLE 0x4 /* Capabilities register bits. */ #define VMCI_CAPS_HYPERCALL 0x1 #define VMCI_CAPS_GUESTCALL 0x2 #define VMCI_CAPS_DATAGRAM 0x4 #define VMCI_CAPS_NOTIFICATIONS 0x8 /* Interrupt Cause register bits. */ #define VMCI_ICR_DATAGRAM 0x1 #define VMCI_ICR_NOTIFICATION 0x2 /* Interrupt Mask register bits. */ #define VMCI_IMR_DATAGRAM 0x1 #define VMCI_IMR_NOTIFICATION 0x2 /* Interrupt type. */ typedef enum VMCIIntrType { VMCI_INTR_TYPE_INTX = 0, VMCI_INTR_TYPE_MSI = 1, VMCI_INTR_TYPE_MSIX = 2 } VMCIIntrType; /* * Maximum MSI/MSI-X interrupt vectors in the device. */ #define VMCI_MAX_INTRS 2 /* * Supported interrupt vectors. There is one for each ICR value above, * but here they indicate the position in the vector array/message ID. */ #define VMCI_INTR_DATAGRAM 0 #define VMCI_INTR_NOTIFICATION 1 /* * A single VMCI device has an upper limit of 128 MiB on the amount of * memory that can be used for queue pairs. */ #define VMCI_MAX_GUEST_QP_MEMORY (128 * 1024 * 1024) /* * We have a fixed set of resource IDs available in the VMX. * This allows us to have a very simple implementation since we statically * know how many will create datagram handles. If a new caller arrives and * we have run out of slots we can manually increment the maximum size of * available resource IDs. */ typedef uint32 VMCI_Resource; /* VMCI reserved hypervisor datagram resource IDs. */ #define VMCI_RESOURCES_QUERY 0 #define VMCI_GET_CONTEXT_ID 1 #define VMCI_SET_NOTIFY_BITMAP 2 #define VMCI_DOORBELL_LINK 3 #define VMCI_DOORBELL_UNLINK 4 #define VMCI_DOORBELL_NOTIFY 5 /* * VMCI_DATAGRAM_REQUEST_MAP and VMCI_DATAGRAM_REMOVE_MAP are * obsoleted by the removal of VM to VM communication. */ #define VMCI_DATAGRAM_REQUEST_MAP 6 #define VMCI_DATAGRAM_REMOVE_MAP 7 #define VMCI_EVENT_SUBSCRIBE 8 #define VMCI_EVENT_UNSUBSCRIBE 9 #define VMCI_QUEUEPAIR_ALLOC 10 #define VMCI_QUEUEPAIR_DETACH 11 /* * VMCI_VSOCK_VMX_LOOKUP was assigned to 12 for Fusion 3.0/3.1, * WS 7.0/7.1 and ESX 4.1 */ #define VMCI_HGFS_TRANSPORT 13 #define VMCI_UNITY_PBRPC_REGISTER 14 /* * This resource is used for VMCI socket control packets sent to the * hypervisor (CID 0) because RID 1 is already reserved. */ #define VSOCK_PACKET_HYPERVISOR_RID 15 #define VMCI_RESOURCE_MAX 16 /* * The core VMCI device functionality only requires the resource IDs of * VMCI_QUEUEPAIR_DETACH and below. */ #define VMCI_CORE_DEVICE_RESOURCE_MAX VMCI_QUEUEPAIR_DETACH /* * VMCI reserved host datagram resource IDs. * vsock control channel has resource id 1. */ #define VMCI_DVFILTER_DATA_PATH_DATAGRAM 2 /* VMCI Ids. */ typedef uint32 VMCIId; typedef struct VMCIIdRange { int8 action; // VMCI_FA_X, for use in filters. VMCIId begin; // Beginning of range VMCIId end; // End of range } VMCIIdRange; typedef struct VMCIHandle { VMCIId context; VMCIId resource; } VMCIHandle; static INLINE VMCIHandle VMCI_MAKE_HANDLE(VMCIId cid, // IN: VMCIId rid) // IN: { VMCIHandle h; h.context = cid; h.resource = rid; return h; } /* *---------------------------------------------------------------------- * * VMCI_HANDLE_TO_UINT64 -- * * Helper for VMCI handle to uint64 conversion. * * Results: * The uint64 value. * * Side effects: * None. * *---------------------------------------------------------------------- */ static INLINE uint64 VMCI_HANDLE_TO_UINT64(VMCIHandle handle) // IN: { uint64 handle64; handle64 = handle.context; handle64 <<= 32; handle64 |= handle.resource; return handle64; } /* *---------------------------------------------------------------------- * * VMCI_UINT64_TO_HANDLE -- * * Helper for uint64 to VMCI handle conversion. * * Results: * The VMCI handle value. * * Side effects: * None. * *---------------------------------------------------------------------- */ static INLINE VMCIHandle VMCI_UINT64_TO_HANDLE(uint64 handle64) // IN: { VMCIId context = (VMCIId)(handle64 >> 32); VMCIId resource = (VMCIId)handle64; return VMCI_MAKE_HANDLE(context, resource); } #define VMCI_HANDLE_TO_CONTEXT_ID(_handle) ((_handle).context) #define VMCI_HANDLE_TO_RESOURCE_ID(_handle) ((_handle).resource) #define VMCI_HANDLE_EQUAL(_h1, _h2) ((_h1).context == (_h2).context && \ (_h1).resource == (_h2).resource) #define VMCI_INVALID_ID 0xFFFFFFFF static const VMCIHandle VMCI_INVALID_HANDLE = {VMCI_INVALID_ID, VMCI_INVALID_ID}; #define VMCI_HANDLE_INVALID(_handle) \ VMCI_HANDLE_EQUAL((_handle), VMCI_INVALID_HANDLE) /* * The below defines can be used to send anonymous requests. * This also indicates that no response is expected. */ #define VMCI_ANON_SRC_CONTEXT_ID VMCI_INVALID_ID #define VMCI_ANON_SRC_RESOURCE_ID VMCI_INVALID_ID #define VMCI_ANON_SRC_HANDLE VMCI_MAKE_HANDLE(VMCI_ANON_SRC_CONTEXT_ID, \ VMCI_ANON_SRC_RESOURCE_ID) /* The lowest 16 context ids are reserved for internal use. */ #define VMCI_RESERVED_CID_LIMIT 16 /* * Hypervisor context id, used for calling into hypervisor * supplied services from the VM. */ #define VMCI_HYPERVISOR_CONTEXT_ID 0 /* * Well-known context id, a logical context that contains a set of * well-known services. This context ID is now obsolete. */ #define VMCI_WELL_KNOWN_CONTEXT_ID 1 /* * Context ID used by host endpoints. */ #define VMCI_HOST_CONTEXT_ID 2 #define VMCI_HOST_CONTEXT_INVALID_EVENT ((uintptr_t)~0) #define VMCI_CONTEXT_IS_VM(_cid) (VMCI_INVALID_ID != _cid && \ _cid > VMCI_HOST_CONTEXT_ID) /* * The VMCI_CONTEXT_RESOURCE_ID is used together with VMCI_MAKE_HANDLE to make * handles that refer to a specific context. */ #define VMCI_CONTEXT_RESOURCE_ID 0 /* *----------------------------------------------------------------------------- * * VMCI error codes. * *----------------------------------------------------------------------------- */ #define VMCI_SUCCESS_QUEUEPAIR_ATTACH 5 #define VMCI_SUCCESS_QUEUEPAIR_CREATE 4 #define VMCI_SUCCESS_LAST_DETACH 3 #define VMCI_SUCCESS_ACCESS_GRANTED 2 #define VMCI_SUCCESS_ENTRY_DEAD 1 #define VMCI_SUCCESS 0LL #define VMCI_ERROR_INVALID_RESOURCE (-1) #define VMCI_ERROR_INVALID_ARGS (-2) #define VMCI_ERROR_NO_MEM (-3) #define VMCI_ERROR_DATAGRAM_FAILED (-4) #define VMCI_ERROR_MORE_DATA (-5) #define VMCI_ERROR_NO_MORE_DATAGRAMS (-6) #define VMCI_ERROR_NO_ACCESS (-7) #define VMCI_ERROR_NO_HANDLE (-8) #define VMCI_ERROR_DUPLICATE_ENTRY (-9) #define VMCI_ERROR_DST_UNREACHABLE (-10) #define VMCI_ERROR_PAYLOAD_TOO_LARGE (-11) #define VMCI_ERROR_INVALID_PRIV (-12) #define VMCI_ERROR_GENERIC (-13) #define VMCI_ERROR_PAGE_ALREADY_SHARED (-14) #define VMCI_ERROR_CANNOT_SHARE_PAGE (-15) #define VMCI_ERROR_CANNOT_UNSHARE_PAGE (-16) #define VMCI_ERROR_NO_PROCESS (-17) #define VMCI_ERROR_NO_DATAGRAM (-18) #define VMCI_ERROR_NO_RESOURCES (-19) #define VMCI_ERROR_UNAVAILABLE (-20) #define VMCI_ERROR_NOT_FOUND (-21) #define VMCI_ERROR_ALREADY_EXISTS (-22) #define VMCI_ERROR_NOT_PAGE_ALIGNED (-23) #define VMCI_ERROR_INVALID_SIZE (-24) #define VMCI_ERROR_REGION_ALREADY_SHARED (-25) #define VMCI_ERROR_TIMEOUT (-26) #define VMCI_ERROR_DATAGRAM_INCOMPLETE (-27) #define VMCI_ERROR_INCORRECT_IRQL (-28) #define VMCI_ERROR_EVENT_UNKNOWN (-29) #define VMCI_ERROR_OBSOLETE (-30) #define VMCI_ERROR_QUEUEPAIR_MISMATCH (-31) #define VMCI_ERROR_QUEUEPAIR_NOTSET (-32) #define VMCI_ERROR_QUEUEPAIR_NOTOWNER (-33) #define VMCI_ERROR_QUEUEPAIR_NOTATTACHED (-34) #define VMCI_ERROR_QUEUEPAIR_NOSPACE (-35) #define VMCI_ERROR_QUEUEPAIR_NODATA (-36) #define VMCI_ERROR_BUSMEM_INVALIDATION (-37) #define VMCI_ERROR_MODULE_NOT_LOADED (-38) #define VMCI_ERROR_DEVICE_NOT_FOUND (-39) #define VMCI_ERROR_QUEUEPAIR_NOT_READY (-40) #define VMCI_ERROR_WOULD_BLOCK (-41) /* VMCI clients should return error code withing this range */ #define VMCI_ERROR_CLIENT_MIN (-500) #define VMCI_ERROR_CLIENT_MAX (-550) /* Internal error codes. */ #define VMCI_SHAREDMEM_ERROR_BAD_CONTEXT (-1000) #define VMCI_PATH_MAX 256 /* VMCI reserved events. */ typedef uint32 VMCI_Event; #define VMCI_EVENT_CTX_ID_UPDATE 0 // Only applicable to guest endpoints #define VMCI_EVENT_CTX_REMOVED 1 // Applicable to guest and host #define VMCI_EVENT_QP_RESUMED 2 // Only applicable to guest endpoints #define VMCI_EVENT_QP_PEER_ATTACH 3 // Applicable to guest, host and VMX #define VMCI_EVENT_QP_PEER_DETACH 4 // Applicable to guest, host and VMX #define VMCI_EVENT_MEM_ACCESS_ON 5 // Applicable to VMX and vmk. On vmk, // this event has the Context payload type. #define VMCI_EVENT_MEM_ACCESS_OFF 6 // Applicable to VMX and vmk. Same as // above for the payload type. #define VMCI_EVENT_GUEST_PAUSED 7 // Applicable to vmk. This event has the // Context payload type. #define VMCI_EVENT_GUEST_UNPAUSED 8 // Applicable to vmk. Same as above for // the payload type. #define VMCI_EVENT_MAX 9 /* * Of the above events, a few are reserved for use in the VMX, and * other endpoints (guest and host kernel) should not use them. For * the rest of the events, we allow both host and guest endpoints to * subscribe to them, to maintain the same API for host and guest * endpoints. */ #define VMCI_EVENT_VALID_VMX(_event) (_event == VMCI_EVENT_QP_PEER_ATTACH || \ _event == VMCI_EVENT_QP_PEER_DETACH || \ _event == VMCI_EVENT_MEM_ACCESS_ON || \ _event == VMCI_EVENT_MEM_ACCESS_OFF) #if defined(VMX86_SERVER) #define VMCI_EVENT_VALID(_event) (_event < VMCI_EVENT_MAX) #else // VMX86_SERVER #define VMCI_EVENT_VALID(_event) (_event < VMCI_EVENT_MAX && \ _event != VMCI_EVENT_MEM_ACCESS_ON && \ _event != VMCI_EVENT_MEM_ACCESS_OFF && \ _event != VMCI_EVENT_GUEST_PAUSED && \ _event != VMCI_EVENT_GUEST_UNPAUSED) #endif // VMX86_SERVER /* Reserved guest datagram resource ids. */ #define VMCI_EVENT_HANDLER 0 /* VMCI privileges. */ typedef enum VMCIResourcePrivilegeType { VMCI_PRIV_CH_PRIV, VMCI_PRIV_DESTROY_RESOURCE, VMCI_PRIV_ASSIGN_CLIENT, VMCI_PRIV_DG_CREATE, VMCI_PRIV_DG_SEND, VMCI_PRIV_NOTIFY, VMCI_NUM_PRIVILEGES, } VMCIResourcePrivilegeType; /* * VMCI coarse-grained privileges (per context or host * process/endpoint. An entity with the restricted flag is only * allowed to interact with the hypervisor and trusted entities. */ typedef uint32 VMCIPrivilegeFlags; #define VMCI_PRIVILEGE_FLAG_RESTRICTED 0x01 #define VMCI_PRIVILEGE_FLAG_TRUSTED 0x02 #define VMCI_PRIVILEGE_ALL_FLAGS (VMCI_PRIVILEGE_FLAG_RESTRICTED | \ VMCI_PRIVILEGE_FLAG_TRUSTED) #define VMCI_NO_PRIVILEGE_FLAGS 0x00 #define VMCI_DEFAULT_PROC_PRIVILEGE_FLAGS VMCI_NO_PRIVILEGE_FLAGS #define VMCI_LEAST_PRIVILEGE_FLAGS VMCI_PRIVILEGE_FLAG_RESTRICTED #define VMCI_MAX_PRIVILEGE_FLAGS VMCI_PRIVILEGE_FLAG_TRUSTED #define VMCI_PUBLIC_GROUP_NAME "vmci public group" /* 0 through VMCI_RESERVED_RESOURCE_ID_MAX are reserved. */ #define VMCI_RESERVED_RESOURCE_ID_MAX 1023 #define VMCI_DOMAIN_NAME_MAXLEN 32 #define VMCI_LGPFX "VMCI: " /* * VMCIQueueHeader * * A Queue cannot stand by itself as designed. Each Queue's header * contains a pointer into itself (the producerTail) and into its peer * (consumerHead). The reason for the separation is one of * accessibility: Each end-point can modify two things: where the next * location to enqueue is within its produceQ (producerTail); and * where the next dequeue location is in its consumeQ (consumerHead). * * An end-point cannot modify the pointers of its peer (guest to * guest; NOTE that in the host both queue headers are mapped r/w). * But, each end-point needs read access to both Queue header * structures in order to determine how much space is used (or left) * in the Queue. This is because for an end-point to know how full * its produceQ is, it needs to use the consumerHead that points into * the produceQ but -that- consumerHead is in the Queue header for * that end-points consumeQ. * * Thoroughly confused? Sorry. * * producerTail: the point to enqueue new entrants. When you approach * a line in a store, for example, you walk up to the tail. * * consumerHead: the point in the queue from which the next element is * dequeued. In other words, who is next in line is he who is at the * head of the line. * * Also, producerTail points to an empty byte in the Queue, whereas * consumerHead points to a valid byte of data (unless producerTail == * consumerHead in which case consumerHead does not point to a valid * byte of data). * * For a queue of buffer 'size' bytes, the tail and head pointers will be in * the range [0, size-1]. * * If produceQHeader->producerTail == consumeQHeader->consumerHead * then the produceQ is empty. */ typedef struct VMCIQueueHeader { /* All fields are 64bit and aligned. */ VMCIHandle handle; /* Identifier. */ Atomic_uint64 producerTail; /* Offset in this queue. */ Atomic_uint64 consumerHead; /* Offset in peer queue. */ } VMCIQueueHeader; /* * If one client of a QueuePair is a 32bit entity, we restrict the QueuePair * size to be less than 4GB, and use 32bit atomic operations on the head and * tail pointers. 64bit atomic read on a 32bit entity involves cmpxchg8b which * is an atomic read-modify-write. This will cause traces to fire when a 32bit * consumer tries to read the producer's tail pointer, for example, because the * consumer has read-only access to the producer's tail pointer. * * We provide the following macros to invoke 32bit or 64bit atomic operations * based on the architecture the code is being compiled on. */ /* Architecture independent maximum queue size. */ #define QP_MAX_QUEUE_SIZE_ARCH_ANY CONST64U(0xffffffff) #ifdef __x86_64__ # define QP_MAX_QUEUE_SIZE_ARCH CONST64U(0xffffffffffffffff) # define QPAtomic_ReadOffset(x) Atomic_Read64(x) # define QPAtomic_WriteOffset(x, y) Atomic_Write64(x, y) #else /* * Wrappers below are being used to call Atomic_Read32 because of the * 'type punned' compilation warning received when Atomic_Read32 is * called with a Atomic_uint64 pointer typecasted to Atomic_uint32 * pointer from QPAtomic_ReadOffset. Ditto with QPAtomic_WriteOffset. */ static INLINE uint32 TypeSafe_Atomic_Read32(void *var) // IN: { return Atomic_Read32((Atomic_uint32 *)(var)); } static INLINE void TypeSafe_Atomic_Write32(void *var, uint32 val) // IN: { Atomic_Write32((Atomic_uint32 *)(var), (uint32)(val)); } # define QP_MAX_QUEUE_SIZE_ARCH CONST64U(0xffffffff) # define QPAtomic_ReadOffset(x) TypeSafe_Atomic_Read32((void *)(x)) # define QPAtomic_WriteOffset(x, y) \ TypeSafe_Atomic_Write32((void *)(x), (uint32)(y)) #endif /* __x86_64__ */ /* *----------------------------------------------------------------------------- * * QPAddPointer -- * * Helper to add a given offset to a head or tail pointer. Wraps the value * of the pointer around the max size of the queue. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE void QPAddPointer(Atomic_uint64 *var, // IN: size_t add, // IN: uint64 size) // IN: { uint64 newVal = QPAtomic_ReadOffset(var); if (newVal >= size - add) { newVal -= size; } newVal += add; QPAtomic_WriteOffset(var, newVal); } /* *----------------------------------------------------------------------------- * * VMCIQueueHeader_ProducerTail() -- * * Helper routine to get the Producer Tail from the supplied queue. * * Results: * The contents of the queue's producer tail. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE uint64 VMCIQueueHeader_ProducerTail(const VMCIQueueHeader *qHeader) // IN: { VMCIQueueHeader *qh = (VMCIQueueHeader *)qHeader; return QPAtomic_ReadOffset(&qh->producerTail); } /* *----------------------------------------------------------------------------- * * VMCIQueueHeader_ConsumerHead() -- * * Helper routine to get the Consumer Head from the supplied queue. * * Results: * The contents of the queue's consumer tail. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE uint64 VMCIQueueHeader_ConsumerHead(const VMCIQueueHeader *qHeader) // IN: { VMCIQueueHeader *qh = (VMCIQueueHeader *)qHeader; return QPAtomic_ReadOffset(&qh->consumerHead); } /* *----------------------------------------------------------------------------- * * VMCIQueueHeader_AddProducerTail() -- * * Helper routine to increment the Producer Tail. Fundamentally, * QPAddPointer() is used to manipulate the tail itself. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE void VMCIQueueHeader_AddProducerTail(VMCIQueueHeader *qHeader, // IN/OUT: size_t add, // IN: uint64 queueSize) // IN: { QPAddPointer(&qHeader->producerTail, add, queueSize); } /* *----------------------------------------------------------------------------- * * VMCIQueueHeader_AddConsumerHead() -- * * Helper routine to increment the Consumer Head. Fundamentally, * QPAddPointer() is used to manipulate the head itself. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE void VMCIQueueHeader_AddConsumerHead(VMCIQueueHeader *qHeader, // IN/OUT: size_t add, // IN: uint64 queueSize) // IN: { QPAddPointer(&qHeader->consumerHead, add, queueSize); } /* *----------------------------------------------------------------------------- * * VMCIQueueHeader_CheckAlignment -- * * Checks if the given queue is aligned to page boundary. Returns TRUE if * the alignment is good. * * Results: * TRUE or FALSE. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE Bool VMCIQueueHeader_CheckAlignment(const VMCIQueueHeader *qHeader) // IN: { uintptr_t hdr, offset; hdr = (uintptr_t) qHeader; offset = hdr & (PAGE_SIZE -1); return offset == 0; } /* *----------------------------------------------------------------------------- * * VMCIQueueHeader_GetPointers -- * * Helper routine for getting the head and the tail pointer for a queue. * Both the VMCIQueues are needed to get both the pointers for one queue. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE void VMCIQueueHeader_GetPointers(const VMCIQueueHeader *produceQHeader, // IN: const VMCIQueueHeader *consumeQHeader, // IN: uint64 *producerTail, // OUT: uint64 *consumerHead) // OUT: { if (producerTail) { *producerTail = VMCIQueueHeader_ProducerTail(produceQHeader); } if (consumerHead) { *consumerHead = VMCIQueueHeader_ConsumerHead(consumeQHeader); } } /* *----------------------------------------------------------------------------- * * VMCIQueueHeader_ResetPointers -- * * Reset the tail pointer (of "this" queue) and the head pointer (of * "peer" queue). * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE void VMCIQueueHeader_ResetPointers(VMCIQueueHeader *qHeader) // IN/OUT: { QPAtomic_WriteOffset(&qHeader->producerTail, CONST64U(0)); QPAtomic_WriteOffset(&qHeader->consumerHead, CONST64U(0)); } /* *----------------------------------------------------------------------------- * * VMCIQueueHeader_Init -- * * Initializes a queue's state (head & tail pointers). * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE void VMCIQueueHeader_Init(VMCIQueueHeader *qHeader, // IN/OUT: const VMCIHandle handle) // IN: { qHeader->handle = handle; VMCIQueueHeader_ResetPointers(qHeader); } /* *----------------------------------------------------------------------------- * * VMCIQueueHeader_FreeSpace -- * * Finds available free space in a produce queue to enqueue more * data or reports an error if queue pair corruption is detected. * * Results: * Free space size in bytes or an error code. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE int64 VMCIQueueHeader_FreeSpace(const VMCIQueueHeader *produceQHeader, // IN: const VMCIQueueHeader *consumeQHeader, // IN: const uint64 produceQSize) // IN: { uint64 tail; uint64 head; uint64 freeSpace; tail = VMCIQueueHeader_ProducerTail(produceQHeader); head = VMCIQueueHeader_ConsumerHead(consumeQHeader); if (tail >= produceQSize || head >= produceQSize) { return VMCI_ERROR_INVALID_SIZE; } /* * Deduct 1 to avoid tail becoming equal to head which causes ambiguity. If * head and tail are equal it means that the queue is empty. */ if (tail >= head) { freeSpace = produceQSize - (tail - head) - 1; } else { freeSpace = head - tail - 1; } return freeSpace; } /* *----------------------------------------------------------------------------- * * VMCIQueueHeader_BufReady -- * * VMCIQueueHeader_FreeSpace() does all the heavy lifting of * determing the number of free bytes in a Queue. This routine, * then subtracts that size from the full size of the Queue so * the caller knows how many bytes are ready to be dequeued. * * Results: * On success, available data size in bytes (up to MAX_INT64). * On failure, appropriate error code. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE int64 VMCIQueueHeader_BufReady(const VMCIQueueHeader *consumeQHeader, // IN: const VMCIQueueHeader *produceQHeader, // IN: const uint64 consumeQSize) // IN: { int64 freeSpace; freeSpace = VMCIQueueHeader_FreeSpace(consumeQHeader, produceQHeader, consumeQSize); if (freeSpace < VMCI_SUCCESS) { return freeSpace; } else { return consumeQSize - freeSpace - 1; } } /* * Defines for the VMCI traffic filter: * - VMCI_FA_<name> defines the filter action values * - VMCI_FP_<name> defines the filter protocol values * - VMCI_FD_<name> defines the direction values (guest or host) * - VMCI_FT_<name> are the type values (allow or deny) */ #define VMCI_FA_INVALID -1 #define VMCI_FA_ALLOW 0 #define VMCI_FA_DENY (VMCI_FA_ALLOW + 1) #define VMCI_FA_MAX (VMCI_FA_DENY + 1) #define VMCI_FP_INVALID -1 #define VMCI_FP_HYPERVISOR 0 #define VMCI_FP_QUEUEPAIR (VMCI_FP_HYPERVISOR + 1) #define VMCI_FP_DOORBELL (VMCI_FP_QUEUEPAIR + 1) #define VMCI_FP_DATAGRAM (VMCI_FP_DOORBELL + 1) #define VMCI_FP_STREAMSOCK (VMCI_FP_DATAGRAM + 1) #define VMCI_FP_ANY (VMCI_FP_STREAMSOCK + 1) #define VMCI_FP_MAX (VMCI_FP_ANY + 1) #define VMCI_FD_INVALID -1 #define VMCI_FD_GUEST 0 #define VMCI_FD_HOST (VMCI_FD_GUEST + 1) #define VMCI_FD_ANY (VMCI_FD_HOST + 1) #define VMCI_FD_MAX (VMCI_FD_ANY + 1) /* * The filter list tracks VMCI Id ranges for a given filter. */ typedef struct { uint32 len; VMCIIdRange *list; } VMCIFilterList; /* * The filter info is used to communicate the filter configuration * from the VMX to the host kernel. */ typedef struct { VA64 list; // List of VMCIIdRange uint32 len; // Length of list uint8 dir; // VMCI_FD_X uint8 proto; // VMCI_FP_X } VMCIFilterInfo; /* * In the host kernel, the ingoing and outgoing filters are * separated. The VMCIProtoFilters type captures all filters in one * direction. The VMCIFilters type captures all filters. */ typedef VMCIFilterList VMCIProtoFilters[VMCI_FP_MAX]; typedef VMCIProtoFilters VMCIFilters[VMCI_FD_MAX]; #if defined __cplusplus } // extern "C" #endif #endif // _VMCI_DEF_H_ vmci-only/shared/pgtbl.h 0000444 0000000 0000000 00000007430 13432725347 014234 0 ustar root root /********************************************************* * Copyright (C) 2002,2014-2017 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 * *********************************************************/ #ifndef __PGTBL_H__ # define __PGTBL_H__ #include <linux/highmem.h> #include "compat_pgtable.h" #include "compat_spinlock.h" #include "compat_page.h" /* *----------------------------------------------------------------------------- * * PgtblVa2MPNLocked -- * * Walks through the hardware page tables to try to find the pte * associated to a virtual address. Then maps PTE to MPN. * * Results: * INVALID_MPN on failure * mpn on success * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE MPN PgtblVa2MPNLocked(struct mm_struct *mm, // IN: Mm structure of a process VA addr) // IN: Address in the virtual address // space of that process { pgd_t *pgd; compat_p4d_t *p4d; MPN mpn; pgd = pgd_offset(mm, addr); if (pgd_present(*pgd) == 0) { return INVALID_MPN; } if (pgd_large(*pgd)) { /* Linux kernel does not support PGD huge pages. */ /* return pgd_pfn(*pgd) + ((addr & PGD_MASK) >> PAGE_SHIFT); */ return INVALID_MPN; } p4d = compat_p4d_offset(pgd, addr); if (compat_p4d_present(*p4d) == 0) { return INVALID_MPN; } if (compat_p4d_large(*p4d)) { mpn = compat_p4d_pfn(*p4d) + ((addr & ~COMPAT_P4D_MASK) >> PAGE_SHIFT); } else { pud_t *pud; pud = pud_offset(p4d, addr); if (pud_present(*pud) == 0) { return INVALID_MPN; } if (pud_large(*pud)) { mpn = pud_pfn(*pud) + ((addr & ~PUD_MASK) >> PAGE_SHIFT); } else { pmd_t *pmd; pmd = pmd_offset(pud, addr); if (pmd_present(*pmd) == 0) { return INVALID_MPN; } if (pmd_large(*pmd)) { mpn = pmd_pfn(*pmd) + ((addr & ~PMD_MASK) >> PAGE_SHIFT); } else { pte_t *pte; pte = pte_offset_map(pmd, addr); if (pte_present(*pte) == 0) { pte_unmap(pte); return INVALID_MPN; } mpn = pte_pfn(*pte); pte_unmap(pte); } } } if (mpn >= INVALID_MPN) { mpn = INVALID_MPN; } return mpn; } /* *----------------------------------------------------------------------------- * * PgtblVa2MPN -- * * Walks through the hardware page tables of the current process to try to * find the page structure associated to a virtual address. * * Results: * Same as PgtblVa2MPNLocked() * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE MPN PgtblVa2MPN(VA addr) // IN { struct mm_struct *mm; MPN mpn; /* current->mm is NULL for kernel threads, so use active_mm. */ mm = current->active_mm; spin_lock(&mm->page_table_lock); mpn = PgtblVa2MPNLocked(mm, addr); spin_unlock(&mm->page_table_lock); return mpn; } #endif /* __PGTBL_H__ */ vmci-only/shared/compat_version.h 0000444 0000000 0000000 00000007363 13432725347 016161 0 ustar root root /********************************************************* * Copyright (C) 1998 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 * *********************************************************/ #ifndef __COMPAT_VERSION_H__ # define __COMPAT_VERSION_H__ #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMCORE #define INCLUDE_ALLOW_DISTRIBUTE #define INCLUDE_ALLOW_VMKDRIVERS #include "includeCheck.h" #ifndef __linux__ # error "linux-version.h" #endif #include <linux/version.h> #ifndef KERNEL_VERSION # error KERNEL_VERSION macro is not defined, environment is busted #endif /* * Distinguish relevant classes of Linux kernels. * * The convention is that version X defines all * the KERNEL_Y symbols where Y <= X. * * XXX Do not add more definitions here. This way of doing things does not * scale, and we are going to phase it out soon --hpreg */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 1, 0) # define KERNEL_2_1 #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 2, 0) # define KERNEL_2_2 #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 3, 1) # define KERNEL_2_3_1 #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 3, 15) /* new networking */ # define KERNEL_2_3_15 #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 3, 25) /* new procfs */ # define KERNEL_2_3_25 #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 3, 29) /* even newer procfs */ # define KERNEL_2_3_29 #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 3, 43) /* softnet changes */ # define KERNEL_2_3_43 #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 3, 47) /* more softnet changes */ # define KERNEL_2_3_47 #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 3, 99) /* name in netdevice struct is array and not pointer */ # define KERNEL_2_3_99 #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 4, 0) /* New 'owner' member at the beginning of struct file_operations */ # define KERNEL_2_4_0 #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 4, 8) /* New netif_rx_ni() --hpreg */ # define KERNEL_2_4_8 #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 5, 2) /* New kdev_t, major()/minor() API --hpreg */ # define KERNEL_2_5_2 #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 5, 5) /* New sk_alloc(), pte_offset_map()/pte_unmap() --hpreg */ # define KERNEL_2_5_5 #endif /* Linux kernel 3.0 can be called 2.6.40, and 3.1 can be 2.6.41... * Use COMPAT_LINUX_VERSION_CHECK_LT iff you need to compare running kernel to * versions 3.0 and above. * */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 0, 0) /* Straight forward comparison if kernel version is 3.0.0 and beyond */ # define COMPAT_LINUX_VERSION_CHECK_LT(a, b, c) LINUX_VERSION_CODE < KERNEL_VERSION (a, b, c) #elif LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 40) /* Use b of the check to calculate corresponding c of kernel * version to compare */ # define COMPAT_LINUX_VERSION_CHECK_LT(a, b, c) LINUX_VERSION_CODE < KERNEL_VERSION (2, 6, (b + 40)) #else /* This is anyways lesser than any 3.x versions */ # define COMPAT_LINUX_VERSION_CHECK_LT(a, b, c) 1 #endif #endif /* __COMPAT_VERSION_H__ */ vmci-only/shared/compat_pgtable.h 0000444 0000000 0000000 00000005563 13432725347 016112 0 ustar root root /********************************************************* * Copyright (C) 2002-2017 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 * *********************************************************/ #ifndef __COMPAT_PGTABLE_H__ # define __COMPAT_PGTABLE_H__ #if defined(CONFIG_PARAVIRT) && defined(CONFIG_HIGHPTE) # if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 21) # include <asm/paravirt.h> # undef paravirt_map_pt_hook # define paravirt_map_pt_hook(type, va, pfn) do {} while (0) # endif #endif #include <asm/pgtable.h> /* * p4d level appeared in 4.12. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(4, 12, 0) # define compat_p4d_offset(pgd, address) p4d_offset(pgd, address) # define compat_p4d_present(p4d) p4d_present(p4d) # define compat_p4d_large(p4d) p4d_large(p4d) # define compat_p4d_pfn(p4d) p4d_pfn(p4d) # define COMPAT_P4D_MASK P4D_MASK typedef p4d_t compat_p4d_t; #else # define compat_p4d_offset(pgd, address) (pgd) # define compat_p4d_present(p4d) (1) # define compat_p4d_large(p4d) (0) # define compat_p4d_pfn(p4d) INVALID_MPN /* Not used */ # define COMPAT_P4D_MASK 0 /* Not used */ typedef pgd_t compat_p4d_t; #endif /* pud_pfn did not exist before 3.8. */ #if LINUX_VERSION_CODE < KERNEL_VERSION(3, 8, 0) # define pud_pfn(pud) INVALID_MPN #endif /* * Define VM_PAGE_KERNEL_EXEC for vmapping executable pages. * * On ia32 PAGE_KERNEL_EXEC was introduced in 2.6.8.1. Unfortunately it accesses * __PAGE_KERNEL_EXEC which is not exported for modules. So we use * __PAGE_KERNEL and just cut _PAGE_NX bit from it. * * For ia32 kernels before 2.6.8.1 we use PAGE_KERNEL directly, these kernels * do not have noexec support. * * On x86-64 situation is a bit better: they always supported noexec, but * before 2.6.8.1 flag was named PAGE_KERNEL_EXECUTABLE, and it was renamed * to PAGE_KERNEL_EXEC when ia32 got noexec too (see above). */ #ifdef CONFIG_X86 #ifdef _PAGE_NX #define VM_PAGE_KERNEL_EXEC __pgprot(__PAGE_KERNEL & ~_PAGE_NX) #else #define VM_PAGE_KERNEL_EXEC PAGE_KERNEL #endif #else #define VM_PAGE_KERNEL_EXEC PAGE_KERNEL_EXEC #endif #endif /* __COMPAT_PGTABLE_H__ */ vmci-only/shared/compat_page.h 0000444 0000000 0000000 00000004663 13432725347 015410 0 ustar root root /********************************************************* * Copyright (C) 2002 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 * *********************************************************/ #ifndef __COMPAT_PAGE_H__ # define __COMPAT_PAGE_H__ #include <linux/mm.h> #include <asm/page.h> /* The pfn_to_page() API appeared in 2.5.14 and changed to function during 2.6.x */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0) && !defined(pfn_to_page) # define pfn_to_page(_pfn) (mem_map + (_pfn)) # define page_to_pfn(_page) ((_page) - mem_map) #endif /* The virt_to_page() API appeared in 2.4.0 --hpreg */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 0) && !defined(virt_to_page) # define virt_to_page(_kvAddr) pfn_to_page(MAP_NR(_kvAddr)) #endif /* * The get_order() API appeared at some point in 2.3.x, and was then backported * in 2.2.17-21mdk and in the stock 2.2.18. Because we can only detect its * definition through makefile tricks, we provide our own for now --hpreg */ static inline int compat_get_order(unsigned long size) // IN { int order; size = (size - 1) >> (PAGE_SHIFT - 1); order = -1; do { size >>= 1; order++; } while (size); return order; } /* * BUG() was added to <asm/page.h> in 2.2.18, and was moved to <asm/bug.h> * in 2.5.58. * * XXX: Technically, this belongs in some sort of "compat_asm_page.h" file, but * since our compatibility wrappers don't distinguish between <asm/xxx.h> and * <linux/xxx.h>, putting it here is reasonable. */ #ifndef BUG #define BUG() do { \ printk("kernel BUG at %s:%d!\n", __FILE__, __LINE__); \ __asm__ __volatile__(".byte 0x0f,0x0b"); \ } while (0) #endif #endif /* __COMPAT_PAGE_H__ */ vmci-only/shared/includeCheck.h 0000444 0000000 0000000 00000007463 13432725350 015505 0 ustar root root /********************************************************* * Copyright (C) 1998-2016 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 * *********************************************************/ /* * includeCheck.h -- * * Restrict include file use. * * In every .h file, define one or more of these * * INCLUDE_ALLOW_VMX * INCLUDE_ALLOW_USERLEVEL * INCLUDE_ALLOW_VMCORE * INCLUDE_ALLOW_MODULE * INCLUDE_ALLOW_VMKERNEL * INCLUDE_ALLOW_DISTRIBUTE * INCLUDE_ALLOW_VMK_MODULE * INCLUDE_ALLOW_VMKDRIVERS * INCLUDE_ALLOW_MKS * * Then include this file. * * Any file that has INCLUDE_ALLOW_DISTRIBUTE defined will potentially * be distributed in source form along with GPLed code. Ensure * that this is acceptable. */ /* * Declare a VMCORE-only variable to help classify object * files. The variable goes in the common block and does * not create multiple definition link-time conflicts. */ #if defined VMCORE && defined VMX86_DEVEL && defined VMX86_DEBUG && \ defined linux && !defined MODULE && \ !defined COMPILED_WITH_VMCORE #define COMPILED_WITH_VMCORE compiled_with_vmcore #ifdef ASM .comm compiled_with_vmcore, 0 #else asm(".comm compiled_with_vmcore, 0"); #endif /* ASM */ #endif #if defined VMCORE && \ !(defined VMX86_VMX || defined VMM || \ defined MONITOR_APP || defined VMMON) #error "Makefile problem: VMCORE without VMX86_VMX or \ VMM or MONITOR_APP or MODULE." #endif #if defined VMCORE && !defined INCLUDE_ALLOW_VMCORE #error "The surrounding include file is not allowed in vmcore." #endif #undef INCLUDE_ALLOW_VMCORE #if defined VMX86_VMX && !defined VMCORE && \ !defined INCLUDE_ALLOW_VMX && !defined INCLUDE_ALLOW_USERLEVEL && \ !defined INCLUDE_ALLOW_MKS #error "The surrounding include file is not allowed in the VMX." #endif #undef INCLUDE_ALLOW_VMX #if defined USERLEVEL && !defined VMX86_VMX && !defined VMCORE && \ !defined INCLUDE_ALLOW_USERLEVEL && !defined INCLUDE_ALLOW_MKS #error "The surrounding include file is not allowed at userlevel." #endif #undef INCLUDE_ALLOW_USERLEVEL #if defined MODULE && !defined VMKERNEL_MODULE && \ !defined VMMON && !defined INCLUDE_ALLOW_MODULE #error "The surrounding include file is not allowed in driver modules." #endif #undef INCLUDE_ALLOW_MODULE #if defined VMMON && !defined INCLUDE_ALLOW_VMMON #error "The surrounding include file is not allowed in vmmon." #endif #undef INCLUDE_ALLOW_VMMON #if defined VMKERNEL && !defined INCLUDE_ALLOW_VMKERNEL #error "The surrounding include file is not allowed in the vmkernel." #endif #undef INCLUDE_ALLOW_VMKERNEL #if defined GPLED_CODE && !defined INCLUDE_ALLOW_DISTRIBUTE #error "The surrounding include file is not allowed in GPL code." #endif #undef INCLUDE_ALLOW_DISTRIBUTE #if defined VMKERNEL_MODULE && !defined VMKERNEL && \ !defined INCLUDE_ALLOW_VMK_MODULE && !defined INCLUDE_ALLOW_VMKDRIVERS #error "The surrounding include file is not allowed in vmkernel modules." #endif #undef INCLUDE_ALLOW_VMK_MODULE #undef INCLUDE_ALLOW_VMKDRIVERS #if defined INCLUDE_ALLOW_MKS && !(defined COREMKS) #error "The surrounding include file is not allowed outside of the MKS." #endif #undef INCLUDE_ALLOW_MKS vmci-only/shared/compat_pci.h 0000444 0000000 0000000 00000005152 13432725347 015241 0 ustar root root /********************************************************* * Copyright (C) 1999 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 * *********************************************************/ /* * compat_pci.h: PCI compatibility wrappers. */ #ifndef __COMPAT_PCI_H__ #define __COMPAT_PCI_H__ #include "compat_ioport.h" #include <linux/pci.h> #ifndef DMA_BIT_MASK # define DMA_BIT_MASK(n) DMA_##n##BIT_MASK #endif /* * Power Management related compat wrappers. */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 10) # define compat_pci_save_state(pdev) pci_save_state((pdev), NULL) # define compat_pci_restore_state(pdev) pci_restore_state((pdev), NULL) #else # define compat_pci_save_state(pdev) pci_save_state((pdev)) # define compat_pci_restore_state(pdev) pci_restore_state((pdev)) #endif #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 11) # define pm_message_t u32 # define compat_pci_choose_state(pdev, state) (state) # define PCI_D0 0 # define PCI_D3hot 3 #else # define compat_pci_choose_state(pdev, state) pci_choose_state((pdev), (state)) #endif /* 2.6.14 changed the PCI shutdown callback */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 14) # define COMPAT_PCI_SHUTDOWN(func) .driver = { .shutdown = (func), } # define COMPAT_PCI_DECLARE_SHUTDOWN(func, var) (func)(struct device *(var)) # define COMPAT_PCI_TO_DEV(dev) (to_pci_dev(dev)) #else # define COMPAT_PCI_SHUTDOWN(func) .shutdown = (func) # define COMPAT_PCI_DECLARE_SHUTDOWN(func, var) (func)(struct pci_dev *(var)) # define COMPAT_PCI_TO_DEV(dev) (dev) #endif /* 2.6.26 introduced the device_set_wakeup_enable() function */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 26) # define compat_device_set_wakeup_enable(dev, val) do {} while(0) #else # define compat_device_set_wakeup_enable(dev, val) \ device_set_wakeup_enable(dev, val) #endif #endif /* __COMPAT_PCI_H__ */ vmci-only/shared/compat_log2.h 0000444 0000000 0000000 00000003672 13432725347 015336 0 ustar root root /********************************************************* * Copyright (C) 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 * *********************************************************/ #ifndef __COMPAT_LOG2_H__ # define __COMPAT_LOG2_H__ #ifndef LINUX_VERSION_CODE # error "Include compat_version.h before compat_log2.h" #endif /* linux/log2.h was introduced in 2.6.20. */ #if LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 19) # include <linux/log2.h> #endif /* * is_power_of_2 was introduced in 2.6.21. This implementation is almost * identical to the one found there. */ #if LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 20) #define compat_is_power_of_2(n) is_power_of_2(n) #else static inline __attribute__((const)) int compat_is_power_of_2(unsigned long n) { return (n != 0 && ((n && (n - 1)) == 0)); } #endif /* * rounddown_power_of_two was introduced in 2.6.24. This implementation is * similar to the one in log2.h but with input of int instead of long to * avoid more version related checks for fls_long(). */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 24) #define compat_rounddown_pow_of_two(n) rounddown_pow_of_two(n) #else static inline __attribute__((const)) unsigned int compat_rounddown_pow_of_two(unsigned int n) { return 1U << (fls(n) -1); } #endif #endif /* __COMPAT_LOG2_H__ */ vmci-only/shared/compat_cred.h 0000444 0000000 0000000 00000003244 13432725347 015403 0 ustar root root /********************************************************* * Copyright (C) 2002 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 * *********************************************************/ #ifndef __COMPAT_CRED_H__ # define __COMPAT_CRED_H__ /* * Include linux/cred.h via linux/sched.h - it is not nice, but * as cpp does not have #ifexist... */ #if LINUX_VERSION_CODE < KERNEL_VERSION(4, 11, 0) #include <linux/sched.h> #else #include <linux/cred.h> #endif #if !defined(current_fsuid) && LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 29) #define current_uid() (current->uid) #define current_euid() (current->euid) #define current_fsuid() (current->fsuid) #define current_gid() (current->gid) #define current_egid() (current->egid) #define current_fsgid() (current->fsgid) #endif #if !defined(cap_set_full) /* cap_set_full was removed in kernel version 3.0-rc4. */ #define cap_set_full(_c) do { (_c) = CAP_FULL_SET; } while (0) #endif #if !defined(GLOBAL_ROOT_UID) #define GLOBAL_ROOT_UID (0) #endif #endif /* __COMPAT_CRED_H__ */ vmci-only/shared/compat_ioport.h 0000444 0000000 0000000 00000004041 13432725347 015776 0 ustar root root /********************************************************* * Copyright (C) 2003 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 * *********************************************************/ #ifndef __COMPAT_IOPORT_H__ # define __COMPAT_IOPORT_H__ #include <linux/ioport.h> #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 0) static inline void * compat_request_region(unsigned long start, unsigned long len, const char *name) { if (check_region(start, len)) { return NULL; } request_region(start, len, name); return (void*)1; } #else #define compat_request_region(start, len, name) request_region(start, len, name) #endif #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 3, 7) /* mmap io support starts from 2.3.7, fail the call for kernel prior to that */ static inline void * compat_request_mem_region(unsigned long start, unsigned long len, const char *name) { return NULL; } static inline void compat_release_mem_region(unsigned long start, unsigned long len) { return; } #else #define compat_request_mem_region(start, len, name) request_mem_region(start, len, name) #define compat_release_mem_region(start, len) release_mem_region(start, len) #endif /* these two macro defs are needed by compat_pci_request_region */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 3, 15) # define IORESOURCE_IO 0x00000100 # define IORESOURCE_MEM 0x00000200 #endif #endif /* __COMPAT_IOPORT_H__ */ vmci-only/shared/vm_atomic.h 0000444 0000000 0000000 00000305435 13432725350 015102 0 ustar root root /********************************************************* * Copyright (C) 1998-2018 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 * *********************************************************/ /* * vm_atomic.h -- * * Atomic power * * Note: Only partially tested on ARM processors: Works for View Open * Client, which shouldn't have threads, and ARMv8 processors. * * In ARM, GCC intrinsics (__sync*) compile but might not * work, while MS intrinsics (_Interlocked*) do not compile. */ #ifndef _ATOMIC_H_ #define _ATOMIC_H_ #define INCLUDE_ALLOW_USERLEVEL #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMKDRIVERS #define INCLUDE_ALLOW_VMK_MODULE #define INCLUDE_ALLOW_VMKERNEL #define INCLUDE_ALLOW_DISTRIBUTE #define INCLUDE_ALLOW_VMCORE #include "includeCheck.h" #include "vm_basic_types.h" #include "vm_assert.h" #if defined __cplusplus extern "C" { #endif /* * There are two concepts involved when dealing with atomic accesses: * 1. Atomicity of the access itself * 2. Ordering of the access with respect to other reads&writes (from the view * of other processors/devices). * * Two examples help to clarify #2: * a. Inc: A caller implementing a simple independent global event counter * might not care if the compiler or processor visibly reorders the * increment around other memory accesses. * b. Dec: A caller implementing a reference count absolutely *doesn't* want * the compiler or processor to visibly reordering writes after that * decrement: if that happened, the program could then end up writing * to memory that was freed by another processor. * * C11 has standardized a good model for expressing these orderings when doing * atomics. It defines three *tiers* of ordering: * 1. Sequential Consistency (every processor sees the same total order of * events) * * 2. Acquire/Release ordering (roughly, everybody can agree previous events * have completed, but they might disagree on the ordering of previous * independent events). * * The relative ordering provided by this tier is sufficient for common * locking and initialization activities, but is insufficient for unusual * synchronization schemes (e.g. IRIW aka Independent Read Independent * Write designs such Dekker's algorithm, Peterson's algorithm, etc.) * * In other words, this tier is close in behavior to Sequential Consistency * in much the same way a General-Relativity universe is close to a * Newtonian universe. * 3. Relaxed (i.e unordered/unfenced) * * In C11 standard's terminology for atomic memory ordering, * - in case (a) we want "relaxed" ordering for perf and, * - in case (b) we want "sequentially consistent" ordering (or perhaps the * only slightly weaker "release" ordering) for correctness. * * There are standardized mappings of operations to orderings for every * processor architecture. See * - https://www.cl.cam.ac.uk/~pes20/cpp/cpp0xmappings.html * - http://preshing.com/20120913/acquire-and-release-semantics/ * * In this file: * 1. all RMW (Read/Modify/Write) operations are sequentially consistent. * This includes operations like Atomic_IncN, Atomic_ReadIfEqualWriteN, * Atomic_ReadWriteN, etc. * 2. all R and W operations are relaxed. This includes operations like * Atomic_WriteN, Atomic_ReadN, Atomic_TestBitN, etc. * * The below routines of course ensure both the CPU and compiler honor the * ordering constraint. * * Notes: * 1. Since R-only and W-only operations do not provide ordering, callers * using them for synchronizing operations like double-checked * initialization or releasing spinlocks must provide extra barriers. * 2. This implementation of Atomic operations is suboptimal. On x86,simple * reads and writes have acquire/release semantics at the hardware level. * On arm64, we have separate instructions for sequentially consistent * reads and writes (the same instructions are used for acquire/release). * Neither of these are exposed for R-only or W-only callers. * * For further details on x86 and ARM memory ordering see * https://wiki.eng.vmware.com/ARM/MemoryOrdering. */ #ifdef VM_ARM_64 # include "vm_atomic_arm64_begin.h" #endif /* Basic atomic types: 8, 16, 32, 64 and 128 bits */ typedef struct Atomic_uint8 { volatile uint8 value; } Atomic_uint8 ALIGNED(1); typedef struct Atomic_uint16 { volatile uint16 value; } Atomic_uint16 ALIGNED(2); typedef struct Atomic_uint32 { volatile uint32 value; } Atomic_uint32 ALIGNED(4); typedef struct Atomic_uint64 { volatile uint64 value; } Atomic_uint64 ALIGNED(8); #if defined __GNUC__ && defined VM_64BIT && \ (defined __GCC_HAVE_SYNC_COMPARE_AND_SWAP_16 || defined VM_ARM_64) typedef struct Atomic_uint128 { volatile uint128 value; } Atomic_uint128 ALIGNED(16); #endif /* * Prototypes for msft atomics. These are defined & inlined by the * compiler so no function definition is needed. The prototypes are * needed for C++. * * The declarations for the intrinsic functions were taken from ntddk.h * in the DDK. The declarations must match otherwise the 64-bit C++ * compiler will complain about second linkage of the intrinsic functions. * We define the intrinsic using the basic types corresponding to the * Windows typedefs. This avoids having to include windows header files * to get to the windows types. */ #if defined _MSC_VER && !defined BORA_NO_WIN32_INTRINS #ifdef __cplusplus extern "C" { #endif long _InterlockedExchange(long volatile*, long); long _InterlockedCompareExchange(long volatile*, long, long); long _InterlockedExchangeAdd(long volatile*, long); long _InterlockedDecrement(long volatile*); long _InterlockedIncrement(long volatile*); __int64 _InterlockedCompareExchange64(__int64 volatile*, __int64, __int64); #pragma intrinsic(_InterlockedExchange, _InterlockedCompareExchange) #pragma intrinsic(_InterlockedExchangeAdd, _InterlockedDecrement) #pragma intrinsic(_InterlockedIncrement) #pragma intrinsic(_InterlockedCompareExchange64) # if _MSC_VER >= 1600 char _InterlockedExchange8(char volatile *, char); char _InterlockedCompareExchange8(char volatile *, char, char); #pragma intrinsic(_InterlockedCompareExchange8, _InterlockedCompareExchange8) #endif #if defined VM_X86_64 long _InterlockedAnd(long volatile*, long); __int64 _InterlockedAnd64(__int64 volatile*, __int64); long _InterlockedOr(long volatile*, long); __int64 _InterlockedOr64(__int64 volatile*, __int64); long _InterlockedXor(long volatile*, long); __int64 _InterlockedXor64(__int64 volatile*, __int64); __int64 _InterlockedExchangeAdd64(__int64 volatile*, __int64); __int64 _InterlockedIncrement64(__int64 volatile*); __int64 _InterlockedDecrement64(__int64 volatile*); __int64 _InterlockedExchange64(__int64 volatile*, __int64); #if !defined _WIN64 #pragma intrinsic(_InterlockedAnd, _InterlockedAnd64) #pragma intrinsic(_InterlockedOr, _InterlockedOr64) #pragma intrinsic(_InterlockedXor, _InterlockedXor64) #pragma intrinsic(_InterlockedExchangeAdd64, _InterlockedIncrement64) #pragma intrinsic(_InterlockedDecrement64, _InterlockedExchange64) #endif /* !_WIN64 */ #endif /* __x86_64__ */ #ifdef __cplusplus } #endif #endif /* _MSC_VER */ #if defined __arm__ /* * LDREX without STREX or CLREX may cause problems in environments where the * context switch may not clear the reference monitor - according ARM manual * the reference monitor should be cleared after a context switch, but some * may not like Linux kernel's non-preemptive context switch path. So use of * ARM routines in kernel code may not be safe. */ # if defined __ARM_ARCH_7__ || defined __ARM_ARCH_7A__ || \ defined __ARM_ARCH_7R__|| defined __ARM_ARCH_7M__ # define VM_ARM_V7 # ifdef __KERNEL__ # warning LDREX/STREX may not be safe in linux kernel, since it \ does not issue CLREX on context switch (as of 2011-09-29). # endif # else # error Only ARMv7 extends the synchronization primitives ldrex/strex. \ For the lower ARM version, please implement the atomic functions \ by kernel APIs. # endif #endif /* Data Memory Barrier */ #ifdef VM_ARM_V7 #define dmb() __asm__ __volatile__("dmb" : : : "memory") #endif /* Convert a volatile uint32 to Atomic_uint32. */ static INLINE Atomic_uint32 * Atomic_VolatileToAtomic32(volatile uint32 *var) // IN: { return (Atomic_uint32 *)var; } #define Atomic_VolatileToAtomic Atomic_VolatileToAtomic32 /* Convert a volatile uint64 to Atomic_uint64. */ static INLINE Atomic_uint64 * Atomic_VolatileToAtomic64(volatile uint64 *var) // IN: { return (Atomic_uint64 *)var; } /* * The Read/Modify/Write operations on x86/x64 are all written using the * "memory" constraint. This is to ensure the compiler treats the operation as * a full barrier, flushing any pending/cached state currently residing in * registers. */ #if defined _MSC_VER && _MSC_VER < 1600 && defined __x86_64__ uint8 VMWInterlockedExchange8(uint8 volatile *ptr, uint8 val); uint8 VMWInterlockedCompareExchange8(uint8 volatile *ptr, uint8 newVal, uint8 oldVal); #endif #if defined __GNUC__ && defined VM_ARM_32 /* Force the link step to fail for unimplemented functions. */ extern int AtomicUndefined(void const *); #endif /* *----------------------------------------------------------------------------- * * Atomic_ReadIfEqualWrite128 -- * * Compare and exchange a 16 byte tuple. * * Results: * old value * * Side effects: * None * *----------------------------------------------------------------------------- */ #if defined __GNUC__ && defined VM_64BIT && \ (defined __GCC_HAVE_SYNC_COMPARE_AND_SWAP_16 || defined VM_ARM_64) static INLINE uint128 Atomic_ReadIfEqualWrite128(Atomic_uint128 *ptr, // IN/OUT uint128 oldVal, // IN uint128 newVal) // IN { #ifdef __GCC_HAVE_SYNC_COMPARE_AND_SWAP_16 return __sync_val_compare_and_swap(&ptr->value, oldVal, newVal); #elif defined VM_ARM_64 union { uint128 raw; struct { uint64 lo; uint64 hi; }; } res, _old = { oldVal }, _new = { newVal }; uint32 failed; SMP_RW_BARRIER_RW(); __asm__ __volatile__( "1: ldxp %x0, %x1, %3 \n\t" " cmp %x0, %x4 \n\t" " ccmp %x1, %x5, #0, eq \n\t" " b.ne 2f \n\t" " stxp %w2, %x6, %x7, %3 \n\t" " cbnz %w2, 1b \n\t" "2: \n\t" : "=&r" (res.lo), "=&r" (res.hi), "=&r" (failed), "+Q" (ptr->value) : "r" (_old.lo), "r" (_old.hi), "r" (_new.lo), "r" (_new.hi) : "cc" ); SMP_RW_BARRIER_RW(); return res.raw; #endif } #endif /* *----------------------------------------------------------------------------- * * Atomic_Read8 -- * * Read the value of the specified object atomically. * * Results: * The value of the atomic variable. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE uint8 Atomic_Read8(Atomic_uint8 const *var) // IN: { uint8 val; #if defined __GNUC__ && defined VM_ARM_32 val = AtomicUndefined(var); #elif defined VM_ARM_64 val = _VMATOM_X(R, 8, &var->value); #elif defined __GNUC__ && (defined __i386__ || defined __x86_64__) __asm__ __volatile__( "movb %1, %0" : "=q" (val) : "m" (var->value) ); #elif defined _MSC_VER val = var->value; #else #error No compiler defined for Atomic_Read8 #endif return val; } /* *----------------------------------------------------------------------------- * * Atomic_ReadWrite8 -- * * Read followed by write. * * Results: * The value of the atomic variable before the write. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE uint8 Atomic_ReadWrite8(Atomic_uint8 *var, // IN/OUT: uint8 val) // IN: { #if defined __GNUC__ && defined VM_ARM_32 return AtomicUndefined(var + val); #elif defined VM_ARM_64 return _VMATOM_X(RW, 8, TRUE, &var->value, val); #elif defined __GNUC__ && (defined __i386__ || defined __x86_64__) __asm__ __volatile__( "xchgb %0, %1" : "=q" (val), "+m" (var->value) : "0" (val) : "memory" ); return val; #elif defined _MSC_VER && _MSC_VER >= 1600 return _InterlockedExchange8((volatile char *)&var->value, val); #elif defined _MSC_VER && defined __i386__ #pragma warning(push) #pragma warning(disable : 4035) // disable no-return warning { __asm movzx eax, val __asm mov ebx, var __asm xchg [ebx]Atomic_uint8.value, al } #pragma warning(pop) #elif defined _MSC_VER && defined __x86_64__ return VMWInterlockedExchange8(&var->value, val); #else #error No compiler defined for Atomic_ReadWrite8 #endif } /* *----------------------------------------------------------------------------- * * Atomic_Write8 -- * * Write the specified value to the specified object atomically. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Write8(Atomic_uint8 *var, // IN/OUT: uint8 val) // IN: { #if defined __GNUC__ && defined VM_ARM_32 AtomicUndefined(var + val); #elif defined VM_ARM_64 _VMATOM_X(W, 8, &var->value, val); #elif defined __GNUC__ && (defined __i386__ || defined __x86_64__) __asm__ __volatile__( "movb %1, %0" : "=m" (var->value) : "qn" (val) ); #elif defined _MSC_VER var->value = val; #else #error No compiler defined for Atomic_Write8 #endif } /* *----------------------------------------------------------------------------- * * Atomic_ReadIfEqualWrite8 -- * * Compare exchange: Read variable, if equal to oldVal, write newVal. * * Results: * The value of the atomic variable before the write. * * Side effects: * The variable may be modified. * *----------------------------------------------------------------------------- */ static INLINE uint8 Atomic_ReadIfEqualWrite8(Atomic_uint8 *var, // IN/OUT: uint8 oldVal, // IN: uint8 newVal) // IN: { #if defined __GNUC__ && defined VM_ARM_32 return AtomicUndefined(var + oldVal + newVal); #elif defined VM_ARM_64 return _VMATOM_X(RIFEQW, 8, TRUE, &var->value, oldVal, newVal); #elif defined __GNUC__ && (defined __i386__ || defined __x86_64__) uint8 val; __asm__ __volatile__( "lock; cmpxchgb %2, %1" : "=a" (val), "+m" (var->value) : "q" (newVal), "0" (oldVal) : "cc", "memory" ); return val; #elif defined _MSC_VER && _MSC_VER >= 1600 return _InterlockedCompareExchange8((volatile char *)&var->value, newVal, oldVal); #elif defined _MSC_VER && defined __i386__ #pragma warning(push) #pragma warning(disable : 4035) // disable no-return warning { __asm mov al, oldVal __asm mov ebx, var __asm mov cl, newVal __asm lock cmpxchg [ebx]Atomic_uint8.value, cl __asm movzx eax, al // eax is the return value, this is documented to work - edward } #pragma warning(pop) #elif defined _MSC_VER && defined __x86_64__ return VMWInterlockedCompareExchange8(&var->value, newVal, oldVal); #else #error No compiler defined for Atomic_ReadIfEqualWrite8 #endif } /* *----------------------------------------------------------------------------- * * Atomic_ReadAnd8 -- * * Atomic read (returned), bitwise AND with a value, write. * * Results: * The value of the variable before the operation. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE uint8 Atomic_ReadAnd8(Atomic_uint8 *var, // IN/OUT uint8 val) // IN { uint8 res; #if defined VM_ARM_64 res = _VMATOM_X(ROP, 8, TRUE, &var->value, and, val); #else do { res = Atomic_Read8(var); } while (res != Atomic_ReadIfEqualWrite8(var, res, res & val)); #endif return res; } /* *----------------------------------------------------------------------------- * * Atomic_And8 -- * * Atomic read, bitwise AND with a value, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_And8(Atomic_uint8 *var, // IN/OUT uint8 val) // IN { #if defined VM_ARM_64 _VMATOM_X(OP, 8, TRUE, &var->value, and, val); #else (void)Atomic_ReadAnd8(var, val); #endif } /* *----------------------------------------------------------------------------- * * Atomic_ReadOr8 -- * * Atomic read (returned), bitwise OR with a value, write. * * Results: * The value of the variable before the operation. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE uint8 Atomic_ReadOr8(Atomic_uint8 *var, // IN/OUT uint8 val) // IN { uint8 res; #if defined VM_ARM_64 res = _VMATOM_X(ROP, 8, TRUE, &var->value, orr, val); #else do { res = Atomic_Read8(var); } while (res != Atomic_ReadIfEqualWrite8(var, res, res | val)); #endif return res; } /* *----------------------------------------------------------------------------- * * Atomic_Or8 -- * * Atomic read, bitwise OR with a value, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Or8(Atomic_uint8 *var, // IN/OUT uint8 val) // IN { #if defined VM_ARM_64 _VMATOM_X(OP, 8, TRUE, &var->value, orr, val); #else (void)Atomic_ReadOr8(var, val); #endif } /* *----------------------------------------------------------------------------- * * Atomic_ReadXor8 -- * * Atomic read (returned), bitwise XOR with a value, write. * * Results: * The value of the variable before the operation. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE uint8 Atomic_ReadXor8(Atomic_uint8 *var, // IN/OUT uint8 val) // IN { uint8 res; #if defined VM_ARM_64 res = _VMATOM_X(ROP, 8, TRUE, &var->value, eor, val); #else do { res = Atomic_Read8(var); } while (res != Atomic_ReadIfEqualWrite8(var, res, res ^ val)); #endif return res; } /* *----------------------------------------------------------------------------- * * Atomic_Xor8 -- * * Atomic read, bitwise XOR with a value, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Xor8(Atomic_uint8 *var, // IN/OUT uint8 val) // IN { #if defined VM_ARM_64 _VMATOM_X(OP, 8, TRUE, &var->value, eor, val); #else (void)Atomic_ReadXor8(var, val); #endif } /* *----------------------------------------------------------------------------- * * Atomic_ReadAdd8 -- * * Atomic read (returned), add a value, write. * * Results: * The value of the variable before the operation. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE uint8 Atomic_ReadAdd8(Atomic_uint8 *var, // IN/OUT uint8 val) // IN { uint8 res; #if defined VM_ARM_64 res = _VMATOM_X(ROP, 8, TRUE, &var->value, add, val); #else do { res = Atomic_Read8(var); } while (res != Atomic_ReadIfEqualWrite8(var, res, res + val)); #endif return res; } /* *----------------------------------------------------------------------------- * * Atomic_Add8 -- * * Atomic read, add a value, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Add8(Atomic_uint8 *var, // IN/OUT uint8 val) // IN { #if defined VM_ARM_64 _VMATOM_X(OP, 8, TRUE, &var->value, add, val); #else (void)Atomic_ReadAdd8(var, val); #endif } /* *----------------------------------------------------------------------------- * * Atomic_Sub8 -- * * Atomic read, subtract a value, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Sub8(Atomic_uint8 *var, // IN/OUT uint8 val) // IN { #if defined VM_ARM_64 _VMATOM_X(OP, 8, TRUE, &var->value, sub, val); #else Atomic_Add8(var, -val); #endif } /* *----------------------------------------------------------------------------- * * Atomic_Inc8 -- * * Atomic read, increment, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Inc8(Atomic_uint8 *var) // IN/OUT { Atomic_Add8(var, 1); } /* *----------------------------------------------------------------------------- * * Atomic_Dec8 -- * * Atomic read, decrement, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Dec8(Atomic_uint8 *var) // IN/OUT { Atomic_Sub8(var, 1); } /* *----------------------------------------------------------------------------- * * Atomic_ReadInc8 -- * * Atomic read (returned), increment, write. * * Results: * The value of the variable before the operation. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE uint8 Atomic_ReadInc8(Atomic_uint8 *var) // IN/OUT { return Atomic_ReadAdd8(var, 1); } /* *----------------------------------------------------------------------------- * * Atomic_ReadDec8 -- * * Atomic read (returned), decrement, write. * * Results: * The value of the variable before the operation. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE uint8 Atomic_ReadDec8(Atomic_uint8 *var) // IN/OUT { return Atomic_ReadAdd8(var, (uint8)-1); } /* *----------------------------------------------------------------------------- * * Atomic_Read32 -- * * Read * * Results: * The value of the atomic variable. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE uint32 Atomic_Read32(Atomic_uint32 const *var) // IN { uint32 value; #if defined VMM || defined VM_ARM_64 || defined VMKERNEL || defined VMKERNEL_MODULE ASSERT(((uintptr_t)var % 4) == 0); #endif #if defined __GNUC__ /* * Use inline assembler to force using a single load instruction to * ensure that the compiler doesn't split a transfer operation into multiple * instructions. */ #if defined VM_ARM_32 __asm__ __volatile__( "ldr %0, [%1]" : "=r" (value) : "r" (&var->value) ); #elif defined VM_ARM_64 value = _VMATOM_X(R, 32, &var->value); #else __asm__ __volatile__( "mov %1, %0" : "=r" (value) : "m" (var->value) ); #endif #elif defined _MSC_VER /* * Microsoft docs guarantee simple reads and writes to properly * aligned 32-bit variables use only a single instruction. * http://msdn.microsoft.com/en-us/library/ms684122%28VS.85%29.aspx */ value = var->value; #else #error No compiler defined for Atomic_Read #endif return value; } #define Atomic_Read Atomic_Read32 /* *----------------------------------------------------------------------------- * * Atomic_ReadWrite32 -- * * Read followed by write * * Results: * The value of the atomic variable before the write. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE uint32 Atomic_ReadWrite32(Atomic_uint32 *var, // IN/OUT uint32 val) // IN { #if defined __GNUC__ #ifdef VM_ARM_V7 register volatile uint32 retVal; register volatile uint32 res; dmb(); __asm__ __volatile__( "1: ldrex %[retVal], [%[var]] \n\t" "strex %[res], %[val], [%[var]] \n\t" "teq %[res], #0 \n\t" "bne 1b" : [retVal] "=&r" (retVal), [res] "=&r" (res) : [var] "r" (&var->value), [val] "r" (val) : "cc" ); dmb(); return retVal; #elif defined VM_ARM_64 return _VMATOM_X(RW, 32, TRUE, &var->value, val); #else /* VM_X86_ANY */ /* Checked against the Intel manual and GCC --walken */ __asm__ __volatile__( "xchgl %0, %1" : "=r" (val), "+m" (var->value) : "0" (val) : "memory" ); return val; #endif /* VM_X86_ANY */ #elif defined _MSC_VER return _InterlockedExchange((long *)&var->value, (long)val); #else #error No compiler defined for Atomic_ReadWrite #endif // __GNUC__ } #define Atomic_ReadWrite Atomic_ReadWrite32 /* *----------------------------------------------------------------------------- * * Atomic_Write32 -- * * Write * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Write32(Atomic_uint32 *var, // OUT uint32 val) // IN { #if defined VMM || defined VM_ARM_64 || defined VMKERNEL || defined VMKERNEL_MODULE ASSERT(((uintptr_t)var % 4) == 0); #endif #if defined __GNUC__ #if defined VM_ARM_64 _VMATOM_X(W, 32, &var->value, val); #elif defined VM_ARM_32 /* * Best left this way due to the intricacies of exclusive load/store * operations on legacy (32-bit) ARM. * * A3.4.1 ARM DDI 0406C: * * When a processor writes using any instruction other than a * Store-Exclusive: * * - if the write is to a physical address that is not covered by its local * monitor the write does not affect the state of the local monitor * - if the write is to a physical address that is covered by its local * monitor it is IMPLEMENTATION DEFINED whether the write affects the * state of the local monitor. * * A3.4.5 ARM DDI 0406C: * * If two STREX instructions are executed without an intervening LDREX the * second STREX returns a status value of 1. This means that: * * - ARM recommends that, in a given thread of execution, every STREX has a * preceding LDREX associated with it * - it is not necessary for every LDREX to have a subsequent STREX. */ Atomic_ReadWrite32(var, val); #else /* * Use inline assembler to force using a single store instruction to * ensure that the compiler doesn't split a transfer operation into multiple * instructions. */ __asm__ __volatile__( "mov %1, %0" : "=m" (var->value) : "r" (val) ); #endif #elif defined _MSC_VER /* * Microsoft docs guarantee simple reads and writes to properly * aligned 32-bit variables use only a single instruction. * http://msdn.microsoft.com/en-us/library/ms684122%28VS.85%29.aspx */ var->value = val; #else #error No compiler defined for Atomic_Write #endif } #define Atomic_Write Atomic_Write32 /* *----------------------------------------------------------------------------- * * Atomic_ReadIfEqualWrite32 -- * * Compare exchange: Read variable, if equal to oldVal, write newVal * * Results: * The value of the atomic variable before the write. * * Side effects: * The variable may be modified. * *----------------------------------------------------------------------------- */ static INLINE uint32 Atomic_ReadIfEqualWrite32(Atomic_uint32 *var, // IN/OUT uint32 oldVal, // IN uint32 newVal) // IN { #if defined __GNUC__ #ifdef VM_ARM_V7 register uint32 retVal; register uint32 res; dmb(); __asm__ __volatile__( "1: ldrex %[retVal], [%[var]] \n\t" "mov %[res], #0 \n\t" "teq %[retVal], %[oldVal] \n\t" "strexeq %[res], %[newVal], [%[var]] \n\t" "teq %[res], #0 \n\t" "bne 1b" : [retVal] "=&r" (retVal), [res] "=&r" (res) : [var] "r" (&var->value), [oldVal] "r" (oldVal), [newVal] "r" (newVal) : "cc" ); dmb(); return retVal; #elif defined VM_ARM_64 return _VMATOM_X(RIFEQW, 32, TRUE, &var->value, oldVal, newVal); #else /* VM_X86_ANY */ uint32 val; /* Checked against the Intel manual and GCC --walken */ __asm__ __volatile__( "lock; cmpxchgl %2, %1" : "=a" (val), "+m" (var->value) : "r" (newVal), "0" (oldVal) : "cc", "memory" ); return val; #endif /* VM_X86_ANY */ #elif defined _MSC_VER return _InterlockedCompareExchange((long *)&var->value, (long)newVal, (long)oldVal); #else #error No compiler defined for Atomic_ReadIfEqualWrite #endif } #define Atomic_ReadIfEqualWrite Atomic_ReadIfEqualWrite32 #if defined VM_64BIT || defined VM_ARM_V7 /* *----------------------------------------------------------------------------- * * Atomic_ReadIfEqualWrite64 -- * * Compare exchange: Read variable, if equal to oldVal, write newVal * * Results: * The value of the atomic variable before the write. * * Side effects: * The variable may be modified. * *----------------------------------------------------------------------------- */ static INLINE uint64 Atomic_ReadIfEqualWrite64(Atomic_uint64 *var, // IN/OUT uint64 oldVal, // IN uint64 newVal) // IN { #if defined __GNUC__ #ifdef VM_ARM_V7 register uint64 retVal; register uint32 res; dmb(); /* * Under Apple LLVM version 5.0 (clang-500.2.76) (based on LLVM 3.3svn) * There will be a warning: * "value size does not match register size specified by the constraint * and modifier [-Wasm-operand-widths]" * on the lines: * : [var] "r" (&var->value), [oldVal] "r" (oldVal), [newVal] "r" (newVal) * ^ * : [var] "r" (&var->value), [oldVal] "r" (oldVal), [newVal] "r" (newVal) * ^ * * Furthermore, using a 32-bits register to store a * 64-bits value of an variable looks risky. */ #if defined __APPLE__ && __clang__ == 1 && __clang_major__ >= 5 #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wasm-operand-widths" #endif __asm__ __volatile__( "1: ldrexd %[retVal], %H[retVal], [%[var]] \n\t" "mov %[res], #0 \n\t" "teq %[retVal], %[oldVal] \n\t" "teqeq %H[retVal], %H[oldVal] \n\t" "strexdeq %[res], %[newVal], %H[newVal], [%[var]] \n\t" "teq %[res], #0 \n\t" "bne 1b" : [retVal] "=&r" (retVal), [res] "=&r" (res) : [var] "r" (&var->value), [oldVal] "r" (oldVal), [newVal] "r" (newVal) : "cc" ); #if defined __APPLE__ && __clang__ == 1 && __clang_major__ >= 5 #pragma clang diagnostic pop #endif // defined __APPLE__ && __clang__ == 1 && __clang_major__ >= 5 dmb(); return retVal; #elif defined VM_ARM_64 return _VMATOM_X(RIFEQW, 64, TRUE, &var->value, oldVal, newVal); #else /* VM_X86_64 */ uint64 val; /* Checked against the AMD manual and GCC --hpreg */ __asm__ __volatile__( "lock; cmpxchgq %2, %1" : "=a" (val), "+m" (var->value) : "r" (newVal), "0" (oldVal) : "cc", "memory" ); return val; #endif //VM_ARM_V7 #elif defined _MSC_VER return _InterlockedCompareExchange64((__int64 *)&var->value, (__int64)newVal, (__int64)oldVal); #else #error No compiler defined for Atomic_ReadIfEqualWrite64 #endif } #endif /* *----------------------------------------------------------------------------- * * Atomic_And32 -- * * Atomic read, bitwise AND with a value, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_And32(Atomic_uint32 *var, // IN/OUT uint32 val) // IN { #if defined __GNUC__ #ifdef VM_ARM_V7 register volatile uint32 res; register volatile uint32 tmp; dmb(); __asm__ __volatile__( "1: ldrex %[tmp], [%[var]] \n\t" "and %[tmp], %[tmp], %[val] \n\t" "strex %[res], %[tmp], [%[var]] \n\t" "teq %[res], #0 \n\t" "bne 1b" : [res] "=&r" (res), [tmp] "=&r" (tmp) : [var] "r" (&var->value), [val] "r" (val) : "cc" ); dmb(); #elif defined VM_ARM_64 _VMATOM_X(OP, 32, TRUE, &var->value, and, val); #else /* VM_X86_ANY */ /* Checked against the Intel manual and GCC --walken */ __asm__ __volatile__( "lock; andl %1, %0" : "+m" (var->value) : "ri" (val) : "cc", "memory" ); #endif /* VM_X86_ANY */ #elif defined _MSC_VER #if defined __x86_64__ || defined VM_ARM_32 _InterlockedAnd((long *)&var->value, (long)val); #else __asm mov eax, val __asm mov ebx, var __asm lock and [ebx]Atomic_uint32.value, eax #endif #else #error No compiler defined for Atomic_And #endif } #define Atomic_And Atomic_And32 /* *----------------------------------------------------------------------------- * * Atomic_Or32 -- * * Atomic read, bitwise OR with a value, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Or32(Atomic_uint32 *var, // IN/OUT uint32 val) // IN { #if defined __GNUC__ #ifdef VM_ARM_V7 register volatile uint32 res; register volatile uint32 tmp; dmb(); __asm__ __volatile__( "1: ldrex %[tmp], [%[var]] \n\t" "orr %[tmp], %[tmp], %[val] \n\t" "strex %[res], %[tmp], [%[var]] \n\t" "teq %[res], #0 \n\t" "bne 1b" : [res] "=&r" (res), [tmp] "=&r" (tmp) : [var] "r" (&var->value), [val] "r" (val) : "cc" ); dmb(); #elif defined VM_ARM_64 _VMATOM_X(OP, 32, TRUE, &var->value, orr, val); #else /* VM_X86_ANY */ /* Checked against the Intel manual and GCC --walken */ __asm__ __volatile__( "lock; orl %1, %0" : "+m" (var->value) : "ri" (val) : "cc", "memory" ); #endif /* VM_X86_ANY */ #elif defined _MSC_VER #if defined __x86_64__ || defined VM_ARM_32 _InterlockedOr((long *)&var->value, (long)val); #else __asm mov eax, val __asm mov ebx, var __asm lock or [ebx]Atomic_uint32.value, eax #endif #else #error No compiler defined for Atomic_Or #endif } #define Atomic_Or Atomic_Or32 /* *----------------------------------------------------------------------------- * * Atomic_Xor32 -- * * Atomic read, bitwise XOR with a value, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Xor32(Atomic_uint32 *var, // IN/OUT uint32 val) // IN { #if defined __GNUC__ #ifdef VM_ARM_V7 register volatile uint32 res; register volatile uint32 tmp; dmb(); __asm__ __volatile__( "1: ldrex %[tmp], [%[var]] \n\t" "eor %[tmp], %[tmp], %[val] \n\t" "strex %[res], %[tmp], [%[var]] \n\t" "teq %[res], #0 \n\t" "bne 1b" : [res] "=&r" (res), [tmp] "=&r" (tmp) : [var] "r" (&var->value), [val] "r" (val) : "cc" ); dmb(); #elif defined VM_ARM_64 _VMATOM_X(OP, 32, TRUE, &var->value, eor, val); #else /* VM_X86_ANY */ /* Checked against the Intel manual and GCC --walken */ __asm__ __volatile__( "lock; xorl %1, %0" : "+m" (var->value) : "ri" (val) : "cc", "memory" ); #endif /* VM_X86_ANY */ #elif defined _MSC_VER #if defined __x86_64__ || defined VM_ARM_32 _InterlockedXor((long *)&var->value, (long)val); #else __asm mov eax, val __asm mov ebx, var __asm lock xor [ebx]Atomic_uint32.value, eax #endif #else #error No compiler defined for Atomic_Xor #endif } #define Atomic_Xor Atomic_Xor32 #if defined VM_64BIT /* *----------------------------------------------------------------------------- * * Atomic_Xor64 -- * * Atomic read, bitwise XOR with a value, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Xor64(Atomic_uint64 *var, // IN/OUT uint64 val) // IN { #if defined __GNUC__ #if defined VM_ARM_64 _VMATOM_X(OP, 64, TRUE, &var->value, eor, val); #else /* VM_X86_64 */ /* Checked against the AMD manual and GCC --hpreg */ __asm__ __volatile__( "lock; xorq %1, %0" : "+m" (var->value) : "re" (val) : "cc", "memory" ); #endif #elif defined _MSC_VER _InterlockedXor64((__int64 *)&var->value, (__int64)val); #else #error No compiler defined for Atomic_Xor64 #endif } #endif /* *----------------------------------------------------------------------------- * * Atomic_Add32 -- * * Atomic read, add a value, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Add32(Atomic_uint32 *var, // IN/OUT uint32 val) // IN { #if defined __GNUC__ #ifdef VM_ARM_V7 register volatile uint32 res; register volatile uint32 tmp; dmb(); __asm__ __volatile__( "1: ldrex %[tmp], [%[var]] \n\t" "add %[tmp], %[tmp], %[val] \n\t" "strex %[res], %[tmp], [%[var]] \n\t" "teq %[res], #0 \n\t" "bne 1b" : [res] "=&r" (res), [tmp] "=&r" (tmp) : [var] "r" (&var->value), [val] "r" (val) : "cc" ); dmb(); #elif defined VM_ARM_64 _VMATOM_X(OP, 32, TRUE, &var->value, add, val); #else /* VM_X86_ANY */ /* Checked against the Intel manual and GCC --walken */ __asm__ __volatile__( "lock; addl %1, %0" : "+m" (var->value) : "ri" (val) : "cc", "memory" ); #endif /* VM_X86_ANY */ #elif defined _MSC_VER _InterlockedExchangeAdd((long *)&var->value, (long)val); #else #error No compiler defined for Atomic_Add #endif } #define Atomic_Add Atomic_Add32 /* *----------------------------------------------------------------------------- * * Atomic_Sub32 -- * * Atomic read, subtract a value, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Sub32(Atomic_uint32 *var, // IN/OUT uint32 val) // IN { #if defined __GNUC__ #ifdef VM_ARM_V7 register volatile uint32 res; register volatile uint32 tmp; dmb(); __asm__ __volatile__( "1: ldrex %[tmp], [%[var]] \n\t" "sub %[tmp], %[tmp], %[val] \n\t" "strex %[res], %[tmp], [%[var]] \n\t" "teq %[res], #0 \n\t" "bne 1b" : [res] "=&r" (res), [tmp] "=&r" (tmp) : [var] "r" (&var->value), [val] "r" (val) : "cc" ); dmb(); #elif defined VM_ARM_64 _VMATOM_X(OP, 32, TRUE, &var->value, sub, val); #else /* VM_X86_ANY */ /* Checked against the Intel manual and GCC --walken */ __asm__ __volatile__( "lock; subl %1, %0" : "+m" (var->value) : "ri" (val) : "cc", "memory" ); #endif /* VM_X86_ANY */ #elif defined _MSC_VER _InterlockedExchangeAdd((long *)&var->value, -(long)val); #else #error No compiler defined for Atomic_Sub #endif } #define Atomic_Sub Atomic_Sub32 /* *----------------------------------------------------------------------------- * * Atomic_Inc32 -- * * Atomic read, increment, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Inc32(Atomic_uint32 *var) // IN/OUT { #ifdef __GNUC__ #if defined VM_ARM_ANY Atomic_Add32(var, 1); #else /* VM_X86_ANY */ /* Checked against the Intel manual and GCC --walken */ __asm__ __volatile__( "lock; incl %0" : "+m" (var->value) : : "cc", "memory" ); #endif /* VM_X86_ANY */ #elif defined _MSC_VER _InterlockedIncrement((long *)&var->value); #else #error No compiler defined for Atomic_Inc #endif } #define Atomic_Inc Atomic_Inc32 /* *----------------------------------------------------------------------------- * * Atomic_Dec32 -- * * Atomic read, decrement, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Dec32(Atomic_uint32 *var) // IN/OUT { #ifdef __GNUC__ #if defined VM_ARM_ANY Atomic_Sub32(var, 1); #else /* VM_X86_ANY */ /* Checked against the Intel manual and GCC --walken */ __asm__ __volatile__( "lock; decl %0" : "+m" (var->value) : : "cc", "memory" ); #endif /* VM_X86_ANY */ #elif defined _MSC_VER _InterlockedDecrement((long *)&var->value); #else #error No compiler defined for Atomic_Dec #endif } #define Atomic_Dec Atomic_Dec32 /* * Note that the technique below can be used to implement ReadX(), where X is * an arbitrary mathematical function. */ /* *----------------------------------------------------------------------------- * * Atomic_ReadOr32 -- * * Atomic read (returned), bitwise OR with a value, write. * * Results: * The value of the variable before the operation. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE uint32 Atomic_ReadOr32(Atomic_uint32 *var, // IN/OUT uint32 val) // IN { uint32 res; #if defined VM_ARM_64 res = _VMATOM_X(ROP, 32, TRUE, &var->value, orr, val); #else do { res = Atomic_Read32(var); } while (res != Atomic_ReadIfEqualWrite32(var, res, res | val)); #endif return res; } /* *----------------------------------------------------------------------------- * * Atomic_ReadAnd32 -- * * Atomic read (returned), bitwise And with a value, write. * * Results: * The value of the variable before the operation. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE uint32 Atomic_ReadAnd32(Atomic_uint32 *var, // IN/OUT uint32 val) // IN { uint32 res; #if defined VM_ARM_64 res = _VMATOM_X(ROP, 32, TRUE, &var->value, and, val); #else do { res = Atomic_Read32(var); } while (res != Atomic_ReadIfEqualWrite32(var, res, res & val)); #endif return res; } #if defined VM_64BIT /* *----------------------------------------------------------------------------- * * Atomic_ReadOr64 -- * * Atomic read (returned), bitwise OR with a value, write. * * Results: * The value of the variable before the operation. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE uint64 Atomic_ReadOr64(Atomic_uint64 *var, // IN/OUT uint64 val) // IN { uint64 res; #if defined VM_ARM_64 res = _VMATOM_X(ROP, 64, TRUE, &var->value, orr, val); #else do { res = var->value; } while (res != Atomic_ReadIfEqualWrite64(var, res, res | val)); #endif return res; } /* *----------------------------------------------------------------------------- * * Atomic_ReadAnd64 -- * * Atomic read (returned), bitwise AND with a value, write. * * Results: * The value of the variable before the operation. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE uint64 Atomic_ReadAnd64(Atomic_uint64 *var, // IN/OUT uint64 val) // IN { uint64 res; #if defined VM_ARM_64 res = _VMATOM_X(ROP, 64, TRUE, &var->value, and, val); #else do { res = var->value; } while (res != Atomic_ReadIfEqualWrite64(var, res, res & val)); #endif return res; } #endif /* defined VM_64BIT */ /* *----------------------------------------------------------------------------- * * Atomic_ReadAdd32 -- * * Atomic read (returned), add a value, write. * * If you have to implement ReadAdd32() on an architecture other than * x86 or x86-64, you might want to consider doing something similar to * Atomic_ReadOr32(). * * Results: * The value of the variable before the operation. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE uint32 Atomic_ReadAdd32(Atomic_uint32 *var, // IN/OUT uint32 val) // IN { #if defined __GNUC__ #ifdef VM_ARM_V7 register volatile uint32 res; register volatile uint32 retVal; register volatile uint32 tmp; dmb(); __asm__ __volatile__( "1: ldrex %[retVal], [%[var]] \n\t" "add %[tmp], %[val], %[retVal] \n\t" "strex %[res], %[tmp], [%[var]] \n\t" "teq %[res], #0 \n\t" "bne 1b" : [tmp] "=&r" (tmp), [res] "=&r" (res), [retVal] "=&r" (retVal) : [var] "r" (&var->value), [val] "r" (val) : "cc" ); dmb(); return retVal; #elif defined VM_ARM_64 return _VMATOM_X(ROP, 32, TRUE, &var->value, add, val); #else /* VM_X86_ANY */ /* Checked against the Intel manual and GCC --walken */ __asm__ __volatile__( "lock; xaddl %0, %1" : "=r" (val), "+m" (var->value) : "0" (val) : "cc", "memory" ); return val; #endif /* VM_X86_ANY */ #elif defined _MSC_VER return _InterlockedExchangeAdd((long *)&var->value, (long)val); #else #error No compiler defined for Atomic_ReadAdd32 #endif } /* *----------------------------------------------------------------------------- * * Atomic_ReadInc32 -- * * Atomic read (returned), increment, write. * * Results: * The value of the variable before the operation. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE uint32 Atomic_ReadInc32(Atomic_uint32 *var) // IN/OUT { return Atomic_ReadAdd32(var, 1); } /* *----------------------------------------------------------------------------- * * Atomic_ReadDec32 -- * * Atomic read (returned), decrement, write. * * Results: * The value of the variable before the operation. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE uint32 Atomic_ReadDec32(Atomic_uint32 *var) // IN/OUT { return Atomic_ReadAdd32(var, (uint32)-1); } /* *----------------------------------------------------------------------------- * * Atomic_CMPXCHG64 -- * * Compare exchange: Read variable, if equal to oldVal, write newVal * * Results: * TRUE if equal, FALSE if not equal * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE Bool Atomic_CMPXCHG64(Atomic_uint64 *var, // IN/OUT uint64 oldVal, // IN uint64 newVal) // IN { #if defined __GNUC__ #if defined VM_ARM_ANY return Atomic_ReadIfEqualWrite64(var, oldVal, newVal) == oldVal; #else /* VM_X86_ANY */ Bool equal; /* Checked against the Intel manual and GCC --walken */ #if defined __x86_64__ uint64 dummy; __asm__ __volatile__( "lock; cmpxchgq %3, %0" "\n\t" "sete %1" : "+m" (*var), "=qm" (equal), "=a" (dummy) : "r" (newVal), "2" (oldVal) : "cc", "memory" ); #else /* 32-bit version for non-ARM */ typedef struct { uint32 lowValue; uint32 highValue; } S_uint64; int dummy1, dummy2; # if defined __PIC__ /* * Rules for __asm__ statements in __PIC__ code * -------------------------------------------- * * The compiler uses %ebx for __PIC__ code, so an __asm__ statement cannot * clobber %ebx. The __asm__ statement can temporarily modify %ebx, but _for * each parameter that is used while %ebx is temporarily modified_: * * 1) The constraint cannot be "m", because the memory location the compiler * chooses could then be relative to %ebx. * * 2) The constraint cannot be a register class which contains %ebx (such as * "r" or "q"), because the register the compiler chooses could then be * %ebx. (This happens when compiling the Fusion UI with gcc 4.2.1, Apple * build 5577.) * * 3) Using register classes even for other values is problematic, as gcc * can decide e.g. %ecx == %edi == 0 (as compile-time constants) and * ends up using one register for two things. Which breaks xchg's ability * to temporarily put the PIC pointer somewhere else. PR772455 * * For that reason alone, the __asm__ statement should keep the regions * where it temporarily modifies %ebx as small as possible, and should * prefer specific register assignments. */ __asm__ __volatile__( "xchgl %%ebx, %6" "\n\t" "lock; cmpxchg8b (%3)" "\n\t" "xchgl %%ebx, %6" "\n\t" "sete %0" : "=qm" (equal), "=a" (dummy1), "=d" (dummy2) : /* * See the "Rules for __asm__ statements in __PIC__ code" above: %3 * must use a register class which does not contain %ebx. * "a"/"c"/"d" are already used, so we are left with either "S" or "D". * * Note that this assembly uses ALL GP registers (with %esp reserved for * stack, %ebp reserved for frame, %ebx reserved for PIC). */ "S" (var), "1" (((S_uint64 *)&oldVal)->lowValue), "2" (((S_uint64 *)&oldVal)->highValue), "D" (((S_uint64 *)&newVal)->lowValue), "c" (((S_uint64 *)&newVal)->highValue) : "cc", "memory" ); # else __asm__ __volatile__( "lock; cmpxchg8b %0" "\n\t" "sete %1" : "+m" (*var), "=qm" (equal), "=a" (dummy1), "=d" (dummy2) : "2" (((S_uint64 *)&oldVal)->lowValue), "3" (((S_uint64 *)&oldVal)->highValue), "b" (((S_uint64 *)&newVal)->lowValue), "c" (((S_uint64 *)&newVal)->highValue) : "cc", "memory" ); # endif #endif return equal; #endif //VM_ARM_V7 #elif defined _MSC_VER return (__int64)oldVal == _InterlockedCompareExchange64((__int64 *)&var->value, (__int64)newVal, (__int64)oldVal); #else #error No compiler defined for Atomic_CMPXCHG64 #endif // !GNUC } /* *----------------------------------------------------------------------------- * * Atomic_CMPXCHG32 -- * * Compare exchange: Read variable, if equal to oldVal, write newVal * * Results: * TRUE if equal, FALSE if not equal * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE Bool Atomic_CMPXCHG32(Atomic_uint32 *var, // IN/OUT uint32 oldVal, // IN uint32 newVal) // IN { #if defined __GNUC__ #if defined VM_ARM_ANY return Atomic_ReadIfEqualWrite32(var, oldVal, newVal) == oldVal; #else /* VM_X86_ANY */ Bool equal; uint32 dummy; __asm__ __volatile__( "lock; cmpxchgl %3, %0" "\n\t" "sete %1" : "+m" (*var), "=qm" (equal), "=a" (dummy) : "r" (newVal), "2" (oldVal) : "cc", "memory" ); return equal; #endif /* VM_X86_ANY */ #else // defined __GNUC__ return Atomic_ReadIfEqualWrite32(var, oldVal, newVal) == oldVal; #endif // !defined __GNUC__ } /* *----------------------------------------------------------------------------- * * Atomic_Read64 -- * * Read and return. * * Results: * The value of the atomic variable. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE uint64 Atomic_Read64(Atomic_uint64 const *var) // IN { #if defined __GNUC__ uint64 value; #endif #if defined VMM || defined VM_ARM_64 || defined VMKERNEL || defined VMKERNEL_MODULE ASSERT((uintptr_t)var % 8 == 0); #endif #if defined __GNUC__ && defined __x86_64__ /* * Use asm to ensure we emit a single load. */ __asm__ __volatile__( "movq %1, %0" : "=r" (value) : "m" (var->value) ); #elif defined __GNUC__ && defined __i386__ /* * Since cmpxchg8b will replace the contents of EDX:EAX with the * value in memory if there is no match, we need only execute the * instruction once in order to atomically read 64 bits from * memory. The only constraint is that ECX:EBX must have the same * value as EDX:EAX so that if the comparison succeeds. We * intentionally don't tell gcc that we are using ebx and ecx as we * don't modify them and do not care what value they store. */ __asm__ __volatile__( "mov %%ebx, %%eax" "\n\t" "mov %%ecx, %%edx" "\n\t" "lock; cmpxchg8b %1" : "=&A" (value) : "m" (*var) : "cc" ); #elif defined _MSC_VER && defined __x86_64__ /* * Microsoft docs guarantee "Simple reads and writes to properly * aligned 64-bit variables are atomic on 64-bit Windows." * http://msdn.microsoft.com/en-us/library/ms684122%28VS.85%29.aspx * * XXX Verify that value is properly aligned. Bug 61315. */ return var->value; #elif defined _MSC_VER && defined VM_ARM_32 return _InterlockedAdd64((__int64 *)&var->value, 0); #elif defined _MSC_VER && defined __i386__ # pragma warning(push) # pragma warning(disable : 4035) // disable no-return warning { __asm mov ecx, var __asm mov edx, ecx __asm mov eax, ebx __asm lock cmpxchg8b [ecx] // edx:eax is the return value; this is documented to work. --mann } # pragma warning(pop) #elif defined __GNUC__ && defined VM_ARM_V7 __asm__ __volatile__( "ldrexd %[value], %H[value], [%[var]] \n\t" : [value] "=&r" (value) : [var] "r" (&var->value) ); #elif defined VM_ARM_64 value = _VMATOM_X(R, 64, &var->value); #endif #if defined __GNUC__ return value; #endif } /* *---------------------------------------------------------------------- * * Atomic_ReadUnaligned64 -- * * Atomically read a 64 bit integer, possibly misaligned. * This function can be *very* expensive, costing over 50 kcycles * on Nehalem. * * Note that "var" needs to be writable, even though it will not * be modified. * * Results: * The value of the atomic variable. * * Side effects: * None * *---------------------------------------------------------------------- */ #if defined VM_64BIT static INLINE uint64 Atomic_ReadUnaligned64(Atomic_uint64 const *var) // IN: { return Atomic_ReadIfEqualWrite64((Atomic_uint64*)var, 0, 0); } #endif /* *---------------------------------------------------------------------- * * Atomic_ReadAdd64 -- * * Atomically adds a 64-bit integer to another * * Results: * Returns the old value just prior to the addition * * Side effects: * None * *---------------------------------------------------------------------- */ static INLINE uint64 Atomic_ReadAdd64(Atomic_uint64 *var, // IN/OUT uint64 val) // IN { #if defined VM_ARM_64 return _VMATOM_X(ROP, 64, TRUE, &var->value, add, val); #elif defined __x86_64__ #if defined __GNUC__ __asm__ __volatile__( "lock; xaddq %0, %1" : "=r" (val), "+m" (var->value) : "0" (val) : "cc", "memory" ); return val; #elif defined _MSC_VER return _InterlockedExchangeAdd64((__int64 *)&var->value, (__int64)val); #else #error No compiler defined for Atomic_ReadAdd64 #endif #else uint64 oldVal; uint64 newVal; do { oldVal = var->value; newVal = oldVal + val; } while (!Atomic_CMPXCHG64(var, oldVal, newVal)); return oldVal; #endif } /* *---------------------------------------------------------------------- * * Atomic_ReadSub64 -- * * Atomically subtracts a 64-bit integer to another * * Results: * Returns the old value just prior to the subtraction * * Side effects: * None * *---------------------------------------------------------------------- */ static INLINE uint64 Atomic_ReadSub64(Atomic_uint64 *var, // IN/OUT uint64 val) // IN { #if defined VM_ARM_64 return _VMATOM_X(ROP, 64, TRUE, &var->value, sub, val); #else return Atomic_ReadAdd64(var, -(int64)val); #endif } /* *---------------------------------------------------------------------- * * Atomic_ReadInc64 -- * * Atomically increments a 64-bit integer * * Results: * Returns the old value just prior to incrementing * * Side effects: * None * *---------------------------------------------------------------------- */ static INLINE uint64 Atomic_ReadInc64(Atomic_uint64 *var) // IN/OUT { return Atomic_ReadAdd64(var, 1); } /* *---------------------------------------------------------------------- * * Atomic_ReadDec64 -- * * Atomically decrements a 64-bit integer * * Results: * Returns the old value just prior to decrementing * * Side effects: * None * *---------------------------------------------------------------------- */ static INLINE uint64 Atomic_ReadDec64(Atomic_uint64 *var) // IN/OUT { return Atomic_ReadAdd64(var, (uint64)CONST64(-1)); } /* *----------------------------------------------------------------------------- * * Atomic_Add64 -- * * Atomic read, add a value, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Add64(Atomic_uint64 *var, // IN/OUT uint64 val) // IN { #if !defined VM_64BIT Atomic_ReadAdd64(var, val); /* Return value is unused. */ #elif defined __GNUC__ #if defined VM_ARM_64 _VMATOM_X(OP, 64, TRUE, &var->value, add, val); #else /* defined VM_X86_64 */ /* Checked against the AMD manual and GCC --hpreg */ __asm__ __volatile__( "lock; addq %1, %0" : "+m" (var->value) : "re" (val) : "cc", "memory" ); #endif #elif defined _MSC_VER _InterlockedExchangeAdd64((__int64 *)&var->value, (__int64)val); #else #error No compiler defined for Atomic_Add64 #endif } /* *----------------------------------------------------------------------------- * * Atomic_Sub64 -- * * Atomic read, subtract a value, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Sub64(Atomic_uint64 *var, // IN/OUT uint64 val) // IN { #if !defined VM_64BIT Atomic_ReadSub64(var, val); /* Return value is unused. */ #elif defined __GNUC__ #if defined VM_ARM_64 _VMATOM_X(OP, 64, TRUE, &var->value, sub, val); #else /* VM_X86_64 */ /* Checked against the AMD manual and GCC --hpreg */ __asm__ __volatile__( "lock; subq %1, %0" : "+m" (var->value) : "re" (val) : "cc", "memory" ); #endif #elif defined _MSC_VER _InterlockedExchangeAdd64((__int64 *)&var->value, (__int64)-val); #else #error No compiler defined for Atomic_Sub64 #endif } /* *----------------------------------------------------------------------------- * * Atomic_Inc64 -- * * Atomic read, increment, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Inc64(Atomic_uint64 *var) // IN/OUT { #if defined VM_ARM_64 Atomic_Add64(var, 1); #elif !defined __x86_64__ Atomic_ReadInc64(var); /* Return value is unused. */ #elif defined __GNUC__ /* Checked against the AMD manual and GCC --hpreg */ __asm__ __volatile__( "lock; incq %0" : "+m" (var->value) : : "cc", "memory" ); #elif defined _MSC_VER _InterlockedIncrement64((__int64 *)&var->value); #else #error No compiler defined for Atomic_Inc64 #endif } /* *----------------------------------------------------------------------------- * * Atomic_Dec64 -- * * Atomic read, decrement, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Dec64(Atomic_uint64 *var) // IN/OUT { #if defined VM_ARM_64 Atomic_Sub64(var, 1); #elif !defined __x86_64__ Atomic_ReadDec64(var); /* Return value is unused. */ #elif defined __GNUC__ /* Checked against the AMD manual and GCC --hpreg */ __asm__ __volatile__( "lock; decq %0" : "+m" (var->value) : : "cc", "memory" ); #elif defined _MSC_VER _InterlockedDecrement64((__int64 *)&var->value); #else #error No compiler defined for Atomic_Dec64 #endif } /* *----------------------------------------------------------------------------- * * Atomic_ReadWrite64 -- * * Read followed by write * * Results: * The value of the atomic variable before the write. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE uint64 Atomic_ReadWrite64(Atomic_uint64 *var, // IN/OUT uint64 val) // IN { #if defined __x86_64__ #if defined __GNUC__ /* Checked against the AMD manual and GCC --hpreg */ __asm__ __volatile__( "xchgq %0, %1" : "=r" (val), "+m" (var->value) : "0" (val) : "memory" ); return val; #elif defined _MSC_VER return _InterlockedExchange64((__int64 *)&var->value, (__int64)val); #else #error No compiler defined for Atomic_ReadWrite64 #endif #elif defined VM_ARM_64 return _VMATOM_X(RW, 64, TRUE, &var->value, val); #else uint64 oldVal; do { oldVal = var->value; } while (!Atomic_CMPXCHG64(var, oldVal, val)); return oldVal; #endif } /* *----------------------------------------------------------------------------- * * Atomic_Write64 -- * * Write * * Results: * None. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Write64(Atomic_uint64 *var, // OUT uint64 val) // IN { #if defined VMM || defined VM_ARM_64 || defined VMKERNEL || defined VMKERNEL_MODULE ASSERT((uintptr_t)var % 8 == 0); #endif #if defined __x86_64__ #if defined __GNUC__ /* * There is no move instruction for 64-bit immediate to memory, so unless * the immediate value fits in 32-bit (i.e. can be sign-extended), GCC * breaks the assignment into two movl instructions. The code below forces * GCC to load the immediate value into a register first. */ __asm__ __volatile__( "movq %1, %0" : "=m" (var->value) : "r" (val) ); #elif defined _MSC_VER /* * Microsoft docs guarantee "Simple reads and writes to properly aligned * 64-bit variables are atomic on 64-bit Windows." * http://msdn.microsoft.com/en-us/library/ms684122%28VS.85%29.aspx * * XXX Verify that value is properly aligned. Bug 61315. */ var->value = val; #else #error No compiler defined for Atomic_Write64 #endif #elif defined VM_ARM_64 _VMATOM_X(W, 64, &var->value, val); #else (void)Atomic_ReadWrite64(var, val); #endif } /* *----------------------------------------------------------------------------- * * Atomic_Or64 -- * * Atomic read, bitwise OR with a 64-bit value, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Or64(Atomic_uint64 *var, // IN/OUT uint64 val) // IN { #if defined __x86_64__ #if defined __GNUC__ /* Checked against the AMD manual and GCC --hpreg */ __asm__ __volatile__( "lock; orq %1, %0" : "+m" (var->value) : "re" (val) : "cc", "memory" ); #elif defined _MSC_VER _InterlockedOr64((__int64 *)&var->value, (__int64)val); #else #error No compiler defined for Atomic_Or64 #endif #elif defined VM_ARM_64 _VMATOM_X(OP, 64, TRUE, &var->value, orr, val); #else // __x86_64__ uint64 oldVal; uint64 newVal; do { oldVal = var->value; newVal = oldVal | val; } while (!Atomic_CMPXCHG64(var, oldVal, newVal)); #endif } /* *----------------------------------------------------------------------------- * * Atomic_And64 -- * * Atomic read, bitwise AND with a 64-bit value, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_And64(Atomic_uint64 *var, // IN/OUT uint64 val) // IN { #if defined __x86_64__ #if defined __GNUC__ /* Checked against the AMD manual and GCC --hpreg */ __asm__ __volatile__( "lock; andq %1, %0" : "+m" (var->value) : "re" (val) : "cc", "memory" ); #elif defined _MSC_VER _InterlockedAnd64((__int64 *)&var->value, (__int64)val); #else #error No compiler defined for Atomic_And64 #endif #elif defined VM_ARM_64 _VMATOM_X(OP, 64, TRUE, &var->value, and, val); #else // __x86_64__ uint64 oldVal; uint64 newVal; do { oldVal = var->value; newVal = oldVal & val; } while (!Atomic_CMPXCHG64(var, oldVal, newVal)); #endif } /* *----------------------------------------------------------------------------- * * Atomic_SetBit64 -- * * Atomically set the bit 'bit' in var. Bit must be between 0 and 63. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_SetBit64(Atomic_uint64 *var, // IN/OUT unsigned bit) // IN { #if defined __x86_64__ && defined __GNUC__ ASSERT(bit <= 63); __asm__ __volatile__( "lock; btsq %1, %0" : "+m" (var->value) : "ri" ((uint64)bit) : "cc", "memory" ); #else uint64 oldVal; uint64 newVal; ASSERT(bit <= 63); do { oldVal = var->value; newVal = oldVal | (CONST64U(1) << bit); } while (!Atomic_CMPXCHG64(var, oldVal, newVal)); #endif } /* *----------------------------------------------------------------------------- * * Atomic_ClearBit64 -- * * Atomically clear the bit 'bit' in var. Bit must be between 0 and 63. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_ClearBit64(Atomic_uint64 *var, // IN/OUT unsigned bit) // IN { #if defined __x86_64__ && defined __GNUC__ ASSERT(bit <= 63); __asm__ __volatile__( "lock; btrq %1, %0" : "+m" (var->value) : "ri" ((uint64)bit) : "cc", "memory" ); #else uint64 oldVal; uint64 newVal; ASSERT(bit <= 63); do { oldVal = var->value; newVal = oldVal & ~(CONST64U(1) << bit); } while (!Atomic_CMPXCHG64(var, oldVal, newVal)); #endif } /* *----------------------------------------------------------------------------- * * Atomic_TestBit64 -- * * Read the bit 'bit' in var. Bit must be between 0 and 63. * * Results: * TRUE if the tested bit was set; else FALSE. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE Bool Atomic_TestBit64(Atomic_uint64 *var, // IN unsigned bit) // IN { Bool out; ASSERT(bit <= 63); #if defined __x86_64__ && defined __GNUC__ __asm__ __volatile__( "btq %2, %1; setc %0" : "=rm"(out) : "m" (var->value), "rJ" ((uint64)bit) : "cc" ); #else out = (var->value & (CONST64U(1) << bit)) != 0; #endif return out; } /* *----------------------------------------------------------------------------- * * Atomic_TestSetBit64 -- * * Atomically test and set the bit 'bit' in var. * Bit must be between 0 and 63. * * Results: * TRUE if the tested bit was set; else FALSE. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE Bool Atomic_TestSetBit64(Atomic_uint64 *var, // IN/OUT unsigned bit) // IN { #if defined __x86_64__ && defined __GNUC__ Bool out; ASSERT(bit <= 63); __asm__ __volatile__( "lock; btsq %2, %1; setc %0" : "=rm" (out), "+m" (var->value) : "rJ" ((uint64)bit) : "cc", "memory" ); return out; #else uint64 oldVal; uint64 mask; ASSERT(bit <= 63); mask = CONST64U(1) << bit; do { oldVal = var->value; } while (!Atomic_CMPXCHG64(var, oldVal, oldVal | mask)); return (oldVal & mask) != 0; #endif } #if defined __GNUC__ /* *----------------------------------------------------------------------------- * * Atomic_Read16 -- * * Read and return. * * Results: * The value of the atomic variable. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE uint16 Atomic_Read16(Atomic_uint16 const *var) // IN { uint16 value; #if defined VMM || defined VM_ARM_64 || defined VMKERNEL || defined VMKERNEL_MODULE ASSERT((uintptr_t)var % 2 == 0); #endif #if defined __GNUC__ #if defined __x86_64__ || defined __i386__ __asm__ __volatile__( "movw %1, %0" : "=r" (value) : "m" (var->value) ); #elif defined VM_ARM_V7 NOT_TESTED(); __asm__ __volatile__( "ldrh %0, [%1]" : "=r" (value) : "r" (&var->value) ); #elif defined VM_ARM_64 value = _VMATOM_X(R, 16, &var->value); #else #error No 16-bits atomics. #endif #endif return value; } /* *----------------------------------------------------------------------------- * * Atomic_ReadWrite16 -- * * Read followed by write * * Results: * The value of the atomic variable before the write. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE uint16 Atomic_ReadWrite16(Atomic_uint16 *var, // IN/OUT: uint16 val) // IN: { #if defined __GNUC__ #if defined __x86_64__ || defined __i386__ __asm__ __volatile__( "xchgw %0, %1" : "=r" (val), "+m" (var->value) : "0" (val) : "memory" ); return val; #elif defined VM_ARM_V7 register volatile uint16 retVal; register volatile uint16 res; NOT_TESTED(); dmb(); __asm__ __volatile__( "1: ldrexh %[retVal], [%[var]] \n\t" "strexh %[res], %[val], [%[var]] \n\t" "teq %[res], #0 \n\t" "bne 1b" : [retVal] "=&r" (retVal), [res] "=&r" (res) : [var] "r" (&var->value), [val] "r" (val) : "cc" ); dmb(); return retVal; #elif defined VM_ARM_64 return _VMATOM_X(RW, 16, TRUE, &var->value, val); #else #error No 16-bits atomics. #endif #endif } /* *----------------------------------------------------------------------------- * * Atomic_Write16 -- * * Write * * Results: * None. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Write16(Atomic_uint16 *var, // OUT: uint16 val) // IN: { #if defined VMM || defined VM_ARM_64 || defined VMKERNEL || defined VMKERNEL_MODULE ASSERT((uintptr_t)var % 2 == 0); #endif #if defined __GNUC__ #if defined __x86_64__ || defined __i386__ __asm__ __volatile__( "movw %1, %0" : "=m" (var->value) : "r" (val) ); #elif defined VM_ARM_64 _VMATOM_X(W, 16, &var->value, val); #elif defined VM_ARM_32 /* * Best left this way due to the intricacies of exclusive load/store * operations on legacy (32-bit) ARM. */ Atomic_ReadWrite16(var, val); #else #error No 16-bits atomics. #endif #endif } /* *----------------------------------------------------------------------------- * * Atomic_ReadIfEqualWrite16 -- * * Compare exchange: Read variable, if equal to oldVal, write newVal * * Results: * The value of the atomic variable before the write. * * Side effects: * The variable may be modified. * *----------------------------------------------------------------------------- */ static INLINE uint16 Atomic_ReadIfEqualWrite16(Atomic_uint16 *var, // IN/OUT uint16 oldVal, // IN uint16 newVal) // IN { #if defined __GNUC__ #if defined __x86_64__ || defined __i386__ uint16 val; __asm__ __volatile__( "lock; cmpxchgw %2, %1" : "=a" (val), "+m" (var->value) : "r" (newVal), "0" (oldVal) : "cc", "memory" ); return val; #elif defined VM_ARM_V7 register uint16 retVal; register uint16 res; NOT_TESTED(); dmb(); __asm__ __volatile__( "1: ldrexh %[retVal], [%[var]] \n\t" "mov %[res], #0 \n\t" "teq %[retVal], %[oldVal] \n\t" "strexheq %[res], %[newVal], [%[var]] \n\t" "teq %[res], #0 \n\t" "bne 1b" : [retVal] "=&r" (retVal), [res] "=&r" (res) : [var] "r" (&var->value), [oldVal] "r" (oldVal), [newVal] "r" (newVal) : "cc" ); dmb(); return retVal; #elif defined VM_ARM_64 return _VMATOM_X(RIFEQW, 16, TRUE, &var->value, oldVal, newVal); #else #error No 16-bits atomics. #endif #endif } /* *----------------------------------------------------------------------------- * * Atomic_And16 -- * * Atomic read, bitwise AND with a 16-bit value, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_And16(Atomic_uint16 *var, // IN/OUT uint16 val) // IN { #if defined __GNUC__ #if defined __x86_64__ || defined __i386__ __asm__ __volatile__( "lock; andw %1, %0" : "+m" (var->value) : "re" (val) : "cc", "memory" ); #elif defined VM_ARM_V7 register volatile uint16 res; register volatile uint16 tmp; NOT_TESTED(); dmb(); __asm__ __volatile__( "1: ldrexh %[tmp], [%[var]] \n\t" "and %[tmp], %[tmp], %[val] \n\t" "strexh %[res], %[tmp], [%[var]] \n\t" "teq %[res], #0 \n\t" "bne 1b" : [res] "=&r" (res), [tmp] "=&r" (tmp) : [var] "r" (&var->value), [val] "r" (val) : "cc" ); dmb(); #elif defined VM_ARM_64 _VMATOM_X(OP, 16, TRUE, &var->value, and, val); #else #error No 16-bits atomics. #endif #endif } /* *----------------------------------------------------------------------------- * * Atomic_Or16 -- * * Atomic read, bitwise OR with a 16-bit value, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Or16(Atomic_uint16 *var, // IN/OUT uint16 val) // IN { #if defined __GNUC__ #if defined __x86_64__ || defined __i386__ __asm__ __volatile__( "lock; orw %1, %0" : "+m" (var->value) : "re" (val) : "cc", "memory" ); #elif defined VM_ARM_V7 register volatile uint16 res; register volatile uint16 tmp; NOT_TESTED(); dmb(); __asm__ __volatile__( "1: ldrexh %[tmp], [%[var]] \n\t" "orr %[tmp], %[tmp], %[val] \n\t" "strexh %[res], %[tmp], [%[var]] \n\t" "teq %[res], #0 \n\t" "bne 1b" : [res] "=&r" (res), [tmp] "=&r" (tmp) : [var] "r" (&var->value), [val] "r" (val) : "cc" ); dmb(); #elif defined VM_ARM_64 _VMATOM_X(OP, 16, TRUE, &var->value, orr, val); #else #error No 16-bits atomics. #endif #endif } /* *----------------------------------------------------------------------------- * * Atomic_Xor16 -- * * Atomic read, bitwise XOR with a value, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Xor16(Atomic_uint16 *var, // IN/OUT uint16 val) // IN { #if defined __GNUC__ #if defined __x86_64__ || defined __i386__ __asm__ __volatile__( "lock; xorw %1, %0" : "+m" (var->value) : "re" (val) : "cc", "memory" ); #elif defined VM_ARM_V7 register volatile uint16 res; register volatile uint16 tmp; NOT_TESTED(); dmb(); __asm__ __volatile__( "1: ldrexh %[tmp], [%[var]] \n\t" "eor %[tmp], %[tmp], %[val] \n\t" "strexh %[res], %[tmp], [%[var]] \n\t" "teq %[res], #0 \n\t" "bne 1b" : [res] "=&r" (res), [tmp] "=&r" (tmp) : [var] "r" (&var->value), [val] "r" (val) : "cc" ); dmb(); #elif defined VM_ARM_64 _VMATOM_X(OP, 16, TRUE, &var->value, eor, val); #else #error No 16-bits atomics. #endif #endif } /* *----------------------------------------------------------------------------- * * Atomic_Add16 -- * * Atomic read, add a value, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Add16(Atomic_uint16 *var, // IN/OUT uint16 val) // IN { #if defined __GNUC__ #if defined __x86_64__ || defined __i386__ __asm__ __volatile__( "lock; addw %1, %0" : "+m" (var->value) : "re" (val) : "cc", "memory" ); #elif defined VM_ARM_V7 register volatile uint16 res; register volatile uint16 tmp; NOT_TESTED(); dmb(); __asm__ __volatile__( "1: ldrexh %[tmp], [%[var]] \n\t" "add %[tmp], %[tmp], %[val] \n\t" "strexh %[res], %[tmp], [%[var]] \n\t" "teq %[res], #0 \n\t" "bne 1b" : [res] "=&r" (res), [tmp] "=&r" (tmp) : [var] "r" (&var->value), [val] "r" (val) : "cc" ); dmb(); #elif defined VM_ARM_64 _VMATOM_X(OP, 16, TRUE, &var->value, add, val); #else #error No 16-bits atomics. #endif #endif } /* *----------------------------------------------------------------------------- * * Atomic_Sub16 -- * * Atomic read, subtract a value, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Sub16(Atomic_uint16 *var, // IN/OUT uint16 val) // IN { #if defined __GNUC__ #if defined __x86_64__ || defined __i386__ __asm__ __volatile__( "lock; subw %1, %0" : "+m" (var->value) : "re" (val) : "cc", "memory" ); #elif defined VM_ARM_V7 register volatile uint16 res; register volatile uint16 tmp; NOT_TESTED(); dmb(); __asm__ __volatile__( "1: ldrexh %[tmp], [%[var]] \n\t" "sub %[tmp], %[tmp], %[val] \n\t" "strexh %[res], %[tmp], [%[var]] \n\t" "teq %[res], #0 \n\t" "bne 1b" : [res] "=&r" (res), [tmp] "=&r" (tmp) : [var] "r" (&var->value), [val] "r" (val) : "cc" ); dmb(); #elif defined VM_ARM_64 _VMATOM_X(OP, 16, TRUE, &var->value, sub, val); #else #error No 16-bits atomics. #endif #endif } /* *----------------------------------------------------------------------------- * * Atomic_Inc16 -- * * Atomic read, increment, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Inc16(Atomic_uint16 *var) // IN/OUT { #if defined __GNUC__ #if defined __x86_64__ || defined __i386__ __asm__ __volatile__( "lock; incw %0" : "+m" (var->value) : : "cc", "memory" ); #elif defined VM_ARM_ANY Atomic_Add16(var, 1); #else #error No 16-bits atomics. #endif #endif } /* *----------------------------------------------------------------------------- * * Atomic_Dec16 -- * * Atomic read, decrement, write. * * Results: * None * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE void Atomic_Dec16(Atomic_uint16 *var) // IN/OUT { #if defined __GNUC__ #if defined __x86_64__ || defined __i386__ __asm__ __volatile__( "lock; decw %0" : "+m" (var->value) : : "cc", "memory" ); #elif defined VM_ARM_ANY Atomic_Sub16(var, 1); #else #error No 16-bits atomics. #endif #endif } /* *----------------------------------------------------------------------------- * * Atomic_ReadOr16 -- * * Atomic read (returned), bitwise OR with a value, write. * * Results: * The value of the variable before the operation. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE uint16 Atomic_ReadOr16(Atomic_uint16 *var, // IN/OUT uint16 val) // IN { uint16 res; #if defined VM_ARM_64 res = _VMATOM_X(ROP, 16, TRUE, &var->value, orr, val); #else do { res = var->value; } while (res != Atomic_ReadIfEqualWrite16(var, res, res | val)); #endif return res; } /* *---------------------------------------------------------------------- * * Atomic_ReadAdd16 -- * * Atomically adds a 16-bit integer to another * * Results: * Returns the old value just prior to the addition * * Side effects: * None * *---------------------------------------------------------------------- */ static INLINE uint16 Atomic_ReadAdd16(Atomic_uint16 *var, // IN/OUT uint16 val) // IN: { #if defined __GNUC__ #if defined __x86_64__ || defined __i386__ __asm__ __volatile__( "lock; xaddw %0, %1" : "=r" (val), "+m" (var->value) : "0" (val) : "cc", "memory" ); return val; #elif defined VM_ARM_V7 register volatile uint16 res; register volatile uint16 retVal; register volatile uint16 tmp; NOT_TESTED(); dmb(); __asm__ __volatile__( "1: ldrexh %[retVal], [%[var]] \n\t" "add %[tmp], %[val], %[retVal] \n\t" "strexh %[res], %[tmp], [%[var]] \n\t" "teq %[res], #0 \n\t" "bne 1b" : [tmp] "=&r" (tmp), [res] "=&r" (res), [retVal] "=&r" (retVal) : [var] "r" (&var->value), [val] "r" (val) : "cc" ); dmb(); return retVal; #elif defined VM_ARM_64 return _VMATOM_X(ROP, 16, TRUE, &var->value, add, val); #else #error No 16-bits atomics. #endif #endif } /* *---------------------------------------------------------------------- * * Atomic_ReadInc16 -- * * Atomically increments a 64-bit integer * * Results: * Returns the old value just prior to incrementing * * Side effects: * None * *---------------------------------------------------------------------- */ static INLINE uint16 Atomic_ReadInc16(Atomic_uint16 *var) // IN/OUT { return Atomic_ReadAdd16(var, 1); } /* *---------------------------------------------------------------------- * * Atomic_ReadDec16 -- * * Atomically decrements a 64-bit integer * * Results: * Returns the old value just prior to decrementing * * Side effects: * None * *---------------------------------------------------------------------- */ static INLINE uint16 Atomic_ReadDec16(Atomic_uint16 *var) // IN/OUT { return Atomic_ReadAdd16(var, -1); } #endif /* * Template code for the Atomic_<name> type and its operators. * * The cast argument is an intermediate type cast to make some * compilers stop complaining about casting uint32 <-> void *, * even though we only do it in the 32-bit case so they are always * the same size. So for val of type uint32, instead of * (void *)val, we have (void *)(uintptr_t)val. * The specific problem case is the Windows ddk compiler * (as used by the SVGA driver). -- edward * * NOTE: See the comment in vm_assert.h for why we need UNUSED_TYPE in * AtomicAssertOnCompile(), and why we need to be very careful doing so. */ #define MAKE_ATOMIC_TYPE(name, size, in, out, cast) \ typedef Atomic_uint ## size Atomic_ ## name; \ \ \ static INLINE void \ AtomicAssertOnCompile ## name(void) \ { \ enum { AssertOnCompileMisused = 8 * sizeof (in) == size \ && 8 * sizeof (out) == size \ && 8 * sizeof (cast) == size \ ? 1 : -1 }; \ UNUSED_TYPE(typedef char AssertOnCompileFailed[AssertOnCompileMisused]);\ } \ \ \ static INLINE out \ Atomic_Read ## name(Atomic_ ## name const *var) \ { \ return (out)(cast)Atomic_Read ## size(var); \ } \ \ \ static INLINE void \ Atomic_Write ## name(Atomic_ ## name *var, \ in val) \ { \ Atomic_Write ## size(var, (uint ## size)(cast)val); \ } \ \ \ static INLINE out \ Atomic_ReadWrite ## name(Atomic_ ## name *var, \ in val) \ { \ return (out)(cast)Atomic_ReadWrite ## size(var, \ (uint ## size)(cast)val); \ } \ \ \ static INLINE out \ Atomic_ReadIfEqualWrite ## name(Atomic_ ## name *var, \ in oldVal, \ in newVal) \ { \ return (out)(cast)Atomic_ReadIfEqualWrite ## size(var, \ (uint ## size)(cast)oldVal, (uint ## size)(cast)newVal); \ } \ \ \ static INLINE void \ Atomic_And ## name(Atomic_ ## name *var, \ in val) \ { \ Atomic_And ## size(var, (uint ## size)(cast)val); \ } \ \ \ static INLINE void \ Atomic_Or ## name(Atomic_ ## name *var, \ in val) \ { \ Atomic_Or ## size(var, (uint ## size)(cast)val); \ } \ \ \ static INLINE void \ Atomic_Xor ## name(Atomic_ ## name *var, \ in val) \ { \ Atomic_Xor ## size(var, (uint ## size)(cast)val); \ } \ \ \ static INLINE void \ Atomic_Add ## name(Atomic_ ## name *var, \ in val) \ { \ Atomic_Add ## size(var, (uint ## size)(cast)val); \ } \ \ \ static INLINE void \ Atomic_Sub ## name(Atomic_ ## name *var, \ in val) \ { \ Atomic_Sub ## size(var, (uint ## size)(cast)val); \ } \ \ \ static INLINE void \ Atomic_Inc ## name(Atomic_ ## name *var) \ { \ Atomic_Inc ## size(var); \ } \ \ \ static INLINE void \ Atomic_Dec ## name(Atomic_ ## name *var) \ { \ Atomic_Dec ## size(var); \ } \ \ \ static INLINE out \ Atomic_ReadOr ## name(Atomic_ ## name *var, \ in val) \ { \ return (out)(cast)Atomic_ReadOr ## size(var, (uint ## size)(cast)val); \ } \ \ \ static INLINE out \ Atomic_ReadAdd ## name(Atomic_ ## name *var, \ in val) \ { \ return (out)(cast)Atomic_ReadAdd ## size(var, (uint ## size)(cast)val); \ } \ \ \ static INLINE out \ Atomic_ReadInc ## name(Atomic_ ## name *var) \ { \ return (out)(cast)Atomic_ReadInc ## size(var); \ } \ \ \ static INLINE out \ Atomic_ReadDec ## name(Atomic_ ## name *var) \ { \ return (out)(cast)Atomic_ReadDec ## size(var); \ } /* * Since we use a macro to generate these definitions, it is hard to look for * them. So DO NOT REMOVE THIS COMMENT and keep it up-to-date. --hpreg * * Atomic_Ptr * Atomic_ReadPtr -- * Atomic_WritePtr -- * Atomic_ReadWritePtr -- * Atomic_ReadIfEqualWritePtr -- * Atomic_AndPtr -- * Atomic_OrPtr -- * Atomic_XorPtr -- * Atomic_AddPtr -- * Atomic_SubPtr -- * Atomic_IncPtr -- * Atomic_DecPtr -- * Atomic_ReadOrPtr -- * Atomic_ReadAddPtr -- * Atomic_ReadIncPtr -- * Atomic_ReadDecPtr -- * * Atomic_Int * Atomic_ReadInt -- * Atomic_WriteInt -- * Atomic_ReadWriteInt -- * Atomic_ReadIfEqualWriteInt -- * Atomic_AndInt -- * Atomic_OrInt -- * Atomic_XorInt -- * Atomic_AddInt -- * Atomic_SubInt -- * Atomic_IncInt -- * Atomic_DecInt -- * Atomic_ReadOrInt -- * Atomic_ReadAddInt -- * Atomic_ReadIncInt -- * Atomic_ReadDecInt -- * * Atomic_Bool * Atomic_ReadBool -- * Atomic_WriteBool -- * Atomic_ReadWriteBool -- * Atomic_ReadIfEqualWriteBool -- * Atomic_AndBool -- * Atomic_OrBool -- * Atomic_XorBool -- * Atomic_AddBool -- * Atomic_SubBool -- * Atomic_IncBool -- * Atomic_DecBool -- * Atomic_ReadOrBool -- * Atomic_ReadAddBool -- * Atomic_ReadIncBool -- * Atomic_ReadDecBool -- */ #if defined VM_64BIT MAKE_ATOMIC_TYPE(Ptr, 64, void const *, void *, uintptr_t) #else MAKE_ATOMIC_TYPE(Ptr, 32, void const *, void *, uintptr_t) #endif MAKE_ATOMIC_TYPE(Int, 32, int, int, int) MAKE_ATOMIC_TYPE(Bool, 8, Bool, Bool, Bool) /* * Define arbitrary sized bit vector to be used by * Atomic_TestSetBitVector and Atomic_TestClearBitVector. */ #define ATOMIC_BITVECTOR(varName, capacity) \ Atomic_uint8 varName[CEILING(capacity, 8)] /* *----------------------------------------------------------------------------- * * Atomic_TestSetBitVector -- * * Atomically test and set the bit 'index' in bit vector var. * * The index input value specifies which bit to modify and is 0-based. * * Results: * Returns the value of the bit before modification. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE Bool Atomic_TestSetBitVector(Atomic_uint8 *var, // IN/OUT unsigned index) // IN { #if defined __x86_64__ && defined __GNUC__ Bool bit; __asm__ __volatile__( "lock; bts %2, %1;" "setc %0" : "=qQm" (bit), "+m" (var->value) : "rI" (index) : "cc", "memory" ); return bit; #else uint8 bit = 1 << index % 8; return (Atomic_ReadOr8(var + index / 8, bit) & bit) != 0; #endif } /* *----------------------------------------------------------------------------- * * Atomic_TestClearBitVector -- * * Atomically test and clear the bit 'index' in bit vector var. * * The index input value specifies which bit to modify and is 0-based. * * Results: * Returns the value of the bit before modification. * * Side effects: * None * *----------------------------------------------------------------------------- */ static INLINE Bool Atomic_TestClearBitVector(Atomic_uint8 *var, // IN/OUT unsigned index) // IN { #if defined __x86_64__ && defined __GNUC__ Bool bit; __asm__ __volatile__( "lock; btr %2, %1;" "setc %0" : "=qQm" (bit), "+m" (var->value) : "rI" (index) : "cc", "memory" ); return bit; #else uint8 bit = 1 << index % 8; return (Atomic_ReadAnd8(var + index / 8, ~bit) & bit) != 0; #endif } /* *----------------------------------------------------------------------------- * * Atomic_TestBitVector -- * * Test the bit 'index' (zero-based) in bit vector var. *----------------------------------------------------------------------------- */ static INLINE Bool Atomic_TestBitVector(const Atomic_uint8 *var, // IN unsigned index) // IN { uint8 bit = 1 << index % 8; return (Atomic_Read8(var + index / 8) & bit) != 0; } #ifdef VM_ARM_64 # include "vm_atomic_arm64_end.h" #endif #if defined __cplusplus } // extern "C" #endif #endif // ifndef _ATOMIC_H_ vmci-only/shared/vm_basic_types.h 0000444 0000000 0000000 00000070343 13432725350 016130 0 ustar root root /********************************************************* * Copyright (C) 1998-2018 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 * *********************************************************/ /* * * vm_basic_types.h -- * * basic data types. */ #ifndef _VM_BASIC_TYPES_H_ #define _VM_BASIC_TYPES_H_ #define INCLUDE_ALLOW_USERLEVEL #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMKERNEL #define INCLUDE_ALLOW_VMKDRIVERS #define INCLUDE_ALLOW_VMK_MODULE #define INCLUDE_ALLOW_DISTRIBUTE #define INCLUDE_ALLOW_VMCORE #include "includeCheck.h" /* * Macros __i386__ and __ia64 are intrinsically defined by GCC */ #if defined _MSC_VER && defined _M_X64 # define __x86_64__ #elif defined _MSC_VER && defined _M_IX86 # define __i386__ #endif /* * Setup a bunch of defines for instruction set architecture (ISA) related * properties. * * For compiler types/size: * * - VM_32BIT for a 32-bit ISA (with the same C compiler types/sizes as 32-bit * x86/ARM). * - VM_64BIT for a 64-bit ISA (with the same C compiler types/sizes as 64-bit * x86/ARM). * * For a given <arch> in {X86, ARM}: * * - VM_<arch>_32 for the 32-bit variant. * - VM_<arch>_64 for the 64-bit variant. * - VM_<arch>_ANY for any variant of <arch>. * * VM_X86_ANY is synonymous with the confusing and deprecated VM_I386 (which * should really be VM_X86_32). */ #ifdef __i386__ /* * VM_I386 is historically synonymous with VM_X86_ANY in bora, but misleading, * since it is confused with the __i386__ gcc but defined for both 32- and * 64-bit x86. We retain it here for legacy compatibility. */ #define VM_I386 #define VM_X86_32 #define VM_X86_ANY #define VM_32BIT #endif #ifdef __x86_64__ #define VM_X86_64 #define vm_x86_64 1 #define VM_I386 #define VM_X86_ANY #define VM_64BIT #else #define vm_x86_64 0 #endif #ifdef __arm__ #define VM_ARM_32 #define VM_ARM_ANY #define VM_32BIT #endif #ifdef __aarch64__ #define VM_ARM_64 #define vm_arm_64 1 #define VM_ARM_ANY #define VM_64BIT #else #define vm_arm_64 0 #endif #define vm_64bit (sizeof (void *) == 8) #ifdef _MSC_VER #pragma warning (3 :4505) // unreferenced local function #pragma warning (disable :4018) // signed/unsigned mismatch #pragma warning (disable :4761) // integral size mismatch in argument; conversion supplied #pragma warning (disable :4305) // truncation from 'const int' to 'short' #pragma warning (disable :4244) // conversion from 'unsigned short' to 'unsigned char' #pragma warning (disable :4267) // truncation of 'size_t' #pragma warning (disable :4146) // unary minus operator applied to unsigned type, result still unsigned #pragma warning (disable :4142) // benign redefinition of type #endif #if defined(__cplusplus) && __cplusplus >= 201103L || \ defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L || \ defined(__APPLE__) || defined(HAVE_STDINT_H) /* * We're using <stdint.h> instead of <cstdint> below because some C++ code * deliberately compiles without C++ include paths. */ #include <stdint.h> typedef uint64_t uint64; typedef int64_t int64; typedef uint32_t uint32; typedef int32_t int32; typedef uint16_t uint16; typedef int16_t int16; typedef uint8_t uint8; typedef int8_t int8; #else /* !HAVE_STDINT_H */ /* Pre-c99 or pre-c++11; use compiler extension to get 64-bit types */ #ifdef _MSC_VER typedef unsigned __int64 uint64; typedef signed __int64 int64; #elif __GNUC__ # if defined(VM_X86_64) || defined(VM_ARM_64) typedef unsigned long uint64; typedef long int64; # else /* * Only strict c90 (without extensions) lacks a 'long long' type. * If this declaration fails ... use -std=c99 or -std=gnu90. */ typedef unsigned long long uint64; typedef long long int64; # endif #else # error - Need compiler define for int64/uint64 #endif /* _MSC_VER */ typedef unsigned int uint32; typedef unsigned short uint16; typedef unsigned char uint8; typedef int int32; typedef short int16; typedef signed char int8; #endif /* HAVE_STDINT_H */ /* * The _XTYPEDEF_BOOL guard prevents colliding with: * <X11/Xlib.h> #define Bool int * <X11/Xdefs.h> typedef int Bool; * If using this header AND X11 headers, be sure to #undef Bool and * be careful about the different size. */ #if !defined(_XTYPEDEF_BOOL) #define _XTYPEDEF_BOOL /* * C does not specify whether char is signed or unsigned, and * both gcc and msvc implement it as a non-signed, non-unsigned type. * Thus, (uint8_t *)&Bool and (int8_t *)&Bool are possible compile errors. * This is intentional. */ typedef char Bool; #endif #ifndef FALSE #define FALSE 0 #endif #ifndef TRUE #define TRUE 1 #endif #define IS_BOOL(x) (((x) & ~1) == 0) /* * FreeBSD (for the tools build) unconditionally defines these in * sys/inttypes.h so don't redefine them if this file has already * been included. [greg] * * This applies to Solaris as well. */ /* * Before trying to do the includes based on OS defines, see if we can use * feature-based defines to get as much functionality as possible */ #ifdef HAVE_INTTYPES_H #include <inttypes.h> #endif #ifdef HAVE_SYS_TYPES_H #include <sys/types.h> #endif #ifdef HAVE_SYS_INTTYPES_H #include <sys/inttypes.h> #endif #ifdef HAVE_STDLIB_H #include <stdlib.h> #endif #ifdef __FreeBSD__ #include <sys/param.h> /* For __FreeBSD_version */ #endif #if !defined(USING_AUTOCONF) # if defined(__FreeBSD__) || defined(sun) # ifdef KLD_MODULE # include <sys/types.h> # else # if __FreeBSD_version >= 500043 # if !defined(VMKERNEL) # include <inttypes.h> # endif # include <sys/types.h> # else # include <sys/inttypes.h> # endif # endif # elif defined __APPLE__ # if KERNEL # include <sys/unistd.h> # include <sys/types.h> /* mostly for size_t */ # include <stdint.h> # else # include <unistd.h> # include <inttypes.h> # include <stdlib.h> # include <stdint.h> # endif # elif defined __ANDROID__ # include <stdint.h> # else # if !defined(__intptr_t_defined) && !defined(intptr_t) # ifdef VM_I386 # define __intptr_t_defined # if defined(VM_X86_64) typedef int64 intptr_t; # else typedef int32 intptr_t; # endif # elif defined(VM_ARM_64) # define __intptr_t_defined typedef int64 intptr_t; # elif defined(__arm__) # define __intptr_t_defined typedef int32 intptr_t; # endif # endif # ifndef _STDINT_H # ifdef VM_I386 # if defined(VM_X86_64) typedef uint64 uintptr_t; # else typedef uint32 uintptr_t; # endif # elif defined(VM_ARM_64) typedef uint64 uintptr_t; # elif defined(__arm__) typedef uint32 uintptr_t; # endif # endif # endif #endif #if defined(__GNUC__) && defined(__SIZEOF_INT128__) typedef unsigned __int128 uint128; typedef __int128 int128; #define MIN_INT128 ((int128)1 << 127) #define MAX_INT128 (~MIN_INT128) #define MIN_UINT128 ((uint128)0) #define MAX_UINT128 (~MIN_UINT128) #endif /* * Time * XXX These should be cleaned up. -- edward */ typedef int64 VmTimeType; /* Time in microseconds */ typedef int64 VmTimeRealClock; /* Real clock kept in microseconds */ typedef int64 VmTimeVirtualClock; /* Virtual Clock kept in CPU cycles */ /* * Printf format specifiers for size_t and 64-bit number. * Use them like this: * printf("%" FMT64 "d\n", big); * The spaces are important for C++11 compatibility. * * FMTH is for handles/fds. */ #ifdef _MSC_VER /* MSVC added C99-compatible formatting in vs2015. */ #define FMT64 "I64" #ifdef VM_X86_64 #define FMTSZ "I64" #define FMTPD "I64" #define FMTH "I64" #else #define FMTSZ "I" #define FMTPD "I" #define FMTH "I" #endif #elif defined __APPLE__ /* macOS hosts use the same formatters for 32- and 64-bit. */ #define FMT64 "ll" #if KERNEL /* macOS osfmk/kern added 'z' length specifier in 10.13 */ #define FMTSZ "l" #else #define FMTSZ "z" #endif #define FMTPD "l" #define FMTH "" #elif defined __GNUC__ /* * Every POSIX system we target has C99-compatible printf * (supports 'z' for size_t and 'll' for long long). */ #define FMTH "" #define FMTSZ "z" #if defined(VM_X86_64) || defined(VM_ARM_64) #define FMT64 "l" #define FMTPD "l" #else #define FMT64 "ll" #define FMTPD "" #endif #else #error - Need compiler define for FMT64 and FMTSZ #endif /* * Suffix for 64-bit constants. Use it like this: * CONST64(0x7fffffffffffffff) for signed or * CONST64U(0x7fffffffffffffff) for unsigned. * * 2004.08.30(thutt): * The vmcore/asm64/gen* programs are compiled as 32-bit * applications, but must handle 64 bit constants. If the * 64-bit-constant defining macros are already defined, the * definition will not be overwritten. */ #if !defined(CONST64) || !defined(CONST64U) #ifdef _MSC_VER #define CONST64(c) c##I64 #define CONST64U(c) c##uI64 #elif defined __APPLE__ #define CONST64(c) c##LL #define CONST64U(c) c##uLL #elif __GNUC__ #if defined(VM_X86_64) || defined(VM_ARM_64) #define CONST64(c) c##L #define CONST64U(c) c##uL #else #define CONST64(c) c##LL #define CONST64U(c) c##uLL #endif #else #error - Need compiler define for CONST64 #endif #endif /* * Use CONST3264/CONST3264U if you want a constant to be * treated as a 32-bit number on 32-bit compiles and * a 64-bit number on 64-bit compiles. Useful in the case * of shifts, like (CONST3264U(1) << x), where x could be * more than 31 on a 64-bit compile. */ #if defined(VM_X86_64) || defined(VM_ARM_64) #define CONST3264(a) CONST64(a) #define CONST3264U(a) CONST64U(a) #else #define CONST3264(a) (a) #define CONST3264U(a) (a) #endif #define MIN_INT8 ((int8)0x80) #define MAX_INT8 ((int8)0x7f) #define MIN_UINT8 ((uint8)0) #define MAX_UINT8 ((uint8)0xff) #define MIN_INT16 ((int16)0x8000) #define MAX_INT16 ((int16)0x7fff) #define MIN_UINT16 ((uint16)0) #define MAX_UINT16 ((uint16)0xffff) #define MIN_INT32 ((int32)0x80000000) #define MAX_INT32 ((int32)0x7fffffff) #define MIN_UINT32 ((uint32)0) #define MAX_UINT32 ((uint32)0xffffffff) #define MIN_INT64 (CONST64(0x8000000000000000)) #define MAX_INT64 (CONST64(0x7fffffffffffffff)) #define MIN_UINT64 (CONST64U(0)) #define MAX_UINT64 (CONST64U(0xffffffffffffffff)) typedef uint8 *TCA; /* Pointer into TC (usually). */ /* * Type big enough to hold an integer between 0..100 */ typedef uint8 Percent; #define AsPercent(v) ((Percent)(v)) typedef uintptr_t VA; typedef uintptr_t VPN; typedef uint64 PA; typedef uint32 PPN; typedef uint64 TPA; typedef uint32 TPPN; typedef uint64 PhysMemOff; typedef uint64 PhysMemSize; typedef uint64 BA; #ifdef VMKERNEL typedef void *BPN; #else typedef uint64 BPN; #endif #define UINT64_2_BPN(u) ((BPN)(u)) #define BPN_2_UINT64(b) ((uint64)(b)) typedef uint32 PageCnt; typedef uint64 PgCnt64; typedef uint32 PageNum; typedef uint64 PgNum64; typedef unsigned MemHandle; typedef unsigned int IoHandle; typedef int32 World_ID; /* !! do not alter the definition of INVALID_WORLD_ID without ensuring * that the values defined in both bora/public/vm_basic_types.h and * lib/vprobe/vm_basic_types.h are the same. Additionally, the definition * of VMK_INVALID_WORLD_ID in vmkapi_world.h also must be defined with * the same value */ #define INVALID_WORLD_ID ((World_ID)0) typedef World_ID User_CartelID; #define INVALID_CARTEL_ID INVALID_WORLD_ID typedef User_CartelID User_SessionID; #define INVALID_SESSION_ID INVALID_CARTEL_ID typedef User_CartelID User_CartelGroupID; #define INVALID_CARTELGROUP_ID INVALID_CARTEL_ID typedef uint32 Worldlet_ID; #define INVALID_WORLDLET_ID ((Worldlet_ID)-1) typedef int8 Reg8; typedef int16 Reg16; typedef int32 Reg32; typedef int64 Reg64; typedef uint8 UReg8; typedef uint16 UReg16; typedef uint32 UReg32; typedef uint64 UReg64; #if defined(__GNUC__) && defined(__SIZEOF_INT128__) typedef int128 Reg128; typedef uint128 UReg128; #endif #if defined(VMM) || defined(COREQUERY) || defined(EXTDECODER) || \ defined (VMKERNEL) || defined (VMKBOOT) typedef Reg64 Reg; typedef UReg64 UReg; #endif typedef uint64 MA; typedef uint32 MPN32; /* * This type should be used for variables that contain sector * position/quantity. */ typedef uint64 SectorType; /* * Linear address */ typedef uintptr_t LA; typedef uintptr_t LPN; #define LA_2_LPN(_la) ((_la) >> PAGE_SHIFT) #define LPN_2_LA(_lpn) ((_lpn) << PAGE_SHIFT) #define LAST_LPN ((((LA) 1) << (8 * sizeof(LA) - PAGE_SHIFT)) - 1) #define LAST_LPN32 ((((LA32)1) << (8 * sizeof(LA32) - PAGE_SHIFT)) - 1) #define LAST_LPN64 ((((LA64)1) << (8 * sizeof(LA64) - PAGE_SHIFT)) - 1) /* Valid bits in a LPN. */ #define LPN_MASK LAST_LPN #define LPN_MASK32 LAST_LPN32 #define LPN_MASK64 LAST_LPN64 /* * On 64 bit platform, address and page number types default * to 64 bit. When we need to represent a 32 bit address, we use * types defined below. * * On 32 bit platform, the following types are the same as the * default types. */ typedef uint32 VA32; typedef uint32 VPN32; typedef uint32 LA32; typedef uint32 LPN32; typedef uint32 PA32; typedef uint32 PPN32; /* * On 64 bit platform, the following types are the same as the * default types. */ typedef uint64 VA64; typedef uint64 VPN64; typedef uint64 LA64; typedef uint64 LPN64; typedef uint64 PA64; typedef uint64 PPN64; typedef uint64 TPPN64; typedef uint64 MA64; typedef uint64 MPN; /* * Remove after PPN->PPN64 conversion is finished. */ #define PPN64_2_PPN(_ppn) ((PPN)_ppn) #define FMTPPN "" /* * IO device DMA virtual address and page number (translated by IOMMU to * MA/MPN). IOPN can be in the inclusive range 0 -> MAX_IOPN. */ typedef uint64 IOA; typedef uint64 IOPN; /* * VA typedefs for user world apps. */ typedef VA32 UserVA32; typedef VA64 UserVA64; typedef UserVA64 UserVAConst; /* Userspace ptr to data that we may only read. */ typedef UserVA32 UserVA32Const; /* Userspace ptr to data that we may only read. */ typedef UserVA64 UserVA64Const; /* Used by 64-bit syscalls until conversion is finished. */ #ifdef VMKERNEL typedef UserVA64 UserVA; #else typedef void * UserVA; #endif #define MAX_PPN_BITS 31 #define MAX_PPN (((PPN)1 << MAX_PPN_BITS) - 1) /* Maximal observable PPN value. */ #define INVALID_PPN ((PPN)0xffffffff) #define INVALID_PPN32 ((PPN32)0xffffffff) #define INVALID_PPN64 ((PPN64)0xffffffffffffffffull) #define APIC_INVALID_PPN ((PPN)0xfffffffe) #define INVALID_BPN ((BPN)0x000000ffffffffffull) #define MPN38_MASK ((1ull << 38) - 1) #define RESERVED_MPN ((MPN)0) #define INVALID_MPN ((MPN)MPN38_MASK) #define MEMREF_MPN ((MPN)MPN38_MASK - 1) #define RELEASED_MPN ((MPN)MPN38_MASK - 2) /* account for special MPNs defined above */ #define MAX_MPN ((MPN)MPN38_MASK - 3) /* 50 bits of address space */ #define INVALID_IOPN ((IOPN)-1) #define MAX_IOPN (INVALID_IOPN - 1) #define INVALID_LPN ((LPN)-1) #define INVALID_VPN ((VPN)-1) #define INVALID_LPN64 ((LPN64)-1) #define INVALID_PAGENUM ((PageNum)-1) /* * Format modifier for printing VA, LA, and VPN. * Use them like this: Log("%#" FMTLA "x\n", laddr) */ #if defined(VMM) || defined(FROBOS64) || vm_x86_64 || vm_arm_64 || defined __APPLE__ # define FMTLA "l" # define FMTVA "l" # define FMTVPN "l" #else # define FMTLA "" # define FMTVA "" # define FMTVPN "" #endif #ifndef EXTERN #define EXTERN extern #endif #define CONST const #ifndef INLINE # ifdef _MSC_VER /* * On UWP(Universal Windows Platform), * Only X86 32bit support '__inline' */ # if defined(VM_WIN_UWP) && !defined(VM_X86_32) # define INLINE # else # define INLINE __inline # endif # else # define INLINE inline # endif #endif /* * Annotation for data that may be exported into a DLL and used by other * apps that load that DLL and import the data. */ #if defined(_WIN32) && defined(VMX86_IMPORT_DLLDATA) # define VMX86_EXTERN_DATA extern __declspec(dllimport) #else // !_WIN32 # define VMX86_EXTERN_DATA extern #endif #ifdef _WIN32 /* under windows, __declspec(thread) is supported since VS 2003 */ #define __thread __declspec(thread) #else /* * under other platforms instead, __thread is supported by gcc since * version 3.3.1 and by clang since version 3.x */ #endif /* * Due to the wonderful "registry redirection" feature introduced in * 64-bit Windows, if you access any key under HKLM\Software in 64-bit * code, you need to open/create/delete that key with * VMKEY_WOW64_32KEY if you want a consistent view with 32-bit code. */ #ifdef _WIN32 #ifdef _WIN64 #define VMW_KEY_WOW64_32KEY KEY_WOW64_32KEY #else #define VMW_KEY_WOW64_32KEY 0x0 #endif #endif /* * At present, we effectively require a compiler that is at least * gcc-3.3 (circa 2003). Enforce this here, various things below * this line depend upon it. * * In practice, most things presently compile with gcc-4.1 or gcc-4.4. * The various linux kernel modules may use older (gcc-3.3) compilers. */ #if defined __GNUC__ && (__GNUC__ < 3 || (__GNUC__ == 3 && __GNUC_MINOR__ < 3)) #error "gcc version is too old to compile assembly, need gcc-3.3 or better" #endif /* * Similarly, we require a compiler that is at least vc80 (vs2005). * Enforce this here. */ #if defined _MSC_VER && _MSC_VER < 1400 #error "cl.exe version is too old, need vc80 or better" #endif /* * Consider the following reasons functions are inlined: * * 1) inlined for performance reasons * 2) inlined because it's a single-use function * * Functions which meet only condition 2 should be marked with this * inline macro; It is not critical to be inlined (but there is a * code-space & runtime savings by doing so), so when other callers * are added the inline-ness should be removed. */ #if defined __GNUC__ /* * Starting at version 3.3, gcc does not always inline functions marked * 'inline' (it depends on their size and other factors). To force gcc * to inline a function, one must use the __always_inline__ attribute. * This attribute should be used sparingly and with care. It is usually * preferable to let gcc make its own inlining decisions */ # define INLINE_ALWAYS INLINE __attribute__((__always_inline__)) #else # define INLINE_ALWAYS INLINE #endif #define INLINE_SINGLE_CALLER INLINE_ALWAYS /* * Used when a hard guarantee of no inlining is needed. Very few * instances need this since the absence of INLINE is a good hint * that gcc will not do inlining. */ #if defined(__GNUC__) #define ABSOLUTELY_NOINLINE __attribute__((__noinline__)) #elif defined(_MSC_VER) #define ABSOLUTELY_NOINLINE __declspec(noinline) #endif /* * Used when a function has no effects except the return value and the * return value depends only on the parameters and/or global variables * Such a function can be subject to common subexpression elimination * and loop optimization just as an arithmetic operator would be. */ #if defined(__GNUC__) && (defined(VMM) || defined (VMKERNEL)) #define SIDE_EFFECT_FREE __attribute__((__pure__)) #else #define SIDE_EFFECT_FREE #endif /* * Used when a function exmaines no input other than its arguments and * has no side effects other than its return value. Stronger than * SIDE_EFFECT_FREE as the function is not allowed to read from global * memory. */ #if defined(__GNUC__) && (defined(VMM) || defined (VMKERNEL)) #define CONST_FUNCTION __attribute__((__const__)) #else #define CONST_FUNCTION #endif /* * Attributes placed on function declarations to tell the compiler * that the function never returns. */ #ifdef _MSC_VER #define NORETURN __declspec(noreturn) #elif defined __GNUC__ #define NORETURN __attribute__((__noreturn__)) #else #define NORETURN #endif /* * Static profiling hints for functions. * A function can be either hot, cold, or neither. * It is an error to specify both hot and cold for the same function. * Note that there is no annotation for "neither." */ #if defined __GNUC__ && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)) #define HOT __attribute__((hot)) #define COLD __attribute__((cold)) #else #define HOT #define COLD #endif /* * Branch prediction hints: * LIKELY(exp) - Expression exp is likely TRUE. * UNLIKELY(exp) - Expression exp is likely FALSE. * Usage example: * if (LIKELY(excCode == EXC_NONE)) { * or * if (UNLIKELY(REAL_MODE(vc))) { * * We know how to predict branches on gcc3 and later (hopefully), * all others we don't so we do nothing. */ #if defined __GNUC__ /* * gcc3 uses __builtin_expect() to inform the compiler of an expected value. * We use this to inform the static branch predictor. The '!!' in LIKELY * will convert any !=0 to a 1. */ #define LIKELY(_exp) __builtin_expect(!!(_exp), 1) #define UNLIKELY(_exp) __builtin_expect((_exp), 0) #else #define LIKELY(_exp) (_exp) #define UNLIKELY(_exp) (_exp) #endif /* * GCC's argument checking for printf-like functions * This is conditional until we have replaced all `"%x", void *' * with `"0x%08x", (uint32) void *'. Note that %p prints different things * on different platforms. Argument checking is enabled for the * vmkernel, which has already been cleansed. * * fmtPos is the position of the format string argument, beginning at 1 * varPos is the position of the variable argument, beginning at 1 */ #if defined(__GNUC__) # define PRINTF_DECL(fmtPos, varPos) __attribute__((__format__(__printf__, fmtPos, varPos))) #else # define PRINTF_DECL(fmtPos, varPos) #endif #if defined(__GNUC__) # define SCANF_DECL(fmtPos, varPos) __attribute__((__format__(__scanf__, fmtPos, varPos))) #else # define SCANF_DECL(fmtPos, varPos) #endif /* * UNUSED_PARAM should surround the parameter name and type declaration, * e.g. "int MyFunction(int var1, UNUSED_PARAM(int var2))" * */ #ifndef UNUSED_PARAM # if defined(__GNUC__) # define UNUSED_PARAM(_parm) _parm __attribute__((__unused__)) # elif defined _MSC_VER # define UNUSED_PARAM(_parm) __pragma(warning(suppress:4100)) _parm # else # define UNUSED_PARAM(_parm) _parm # endif #endif #ifndef UNUSED_TYPE // XXX _Pragma would better but doesn't always work right now. # define UNUSED_TYPE(_parm) UNUSED_PARAM(_parm) #endif #ifndef UNUSED_VARIABLE // XXX is there a better way? # define UNUSED_VARIABLE(_var) (void)_var #endif /* * gcc can warn us if we're ignoring returns */ #if defined(__GNUC__) # define MUST_CHECK_RETURN __attribute__((warn_unused_result)) #else # define MUST_CHECK_RETURN #endif /* * ALIGNED specifies minimum alignment in "n" bytes. */ #ifdef __GNUC__ #define ALIGNED(n) __attribute__((__aligned__(n))) #else #define ALIGNED(n) #endif /* * Encapsulate the syntactic differences between gcc and msvc alignment control. * BOUNDARY must match in the prefix and suffix. */ #ifdef _WIN32 #define ALIGN_PREFIX(BOUNDRY) __declspec(align(BOUNDRY)) #define ALIGN_SUFFIX(BOUNDRY) #else #define ALIGN_PREFIX(BOUNDRY) #define ALIGN_SUFFIX(BOUNDRY) __attribute__((__aligned__(BOUNDRY))) #endif /* * Once upon a time, this was used to silence compiler warnings that * get generated when the compiler thinks that a function returns * when it is marked noreturn. Don't do it. Use NOT_REACHED(). */ #define INFINITE_LOOP() do { } while (1) /* * On FreeBSD (for the tools build), size_t is typedef'd if _BSD_SIZE_T_ * is defined. Use the same logic here so we don't define it twice. [greg] */ #ifdef __FreeBSD__ # ifdef _BSD_SIZE_T_ # undef _BSD_SIZE_T_ # ifdef VM_I386 # ifdef VM_X86_64 typedef uint64 size_t; # else typedef uint32 size_t; # endif # endif /* VM_I386 */ # endif # ifdef _BSD_SSIZE_T_ # undef _BSD_SSIZE_T_ # ifdef VM_I386 # ifdef VM_X86_64 typedef int64 ssize_t; # else typedef int32 ssize_t; # endif # endif /* VM_I386 */ # endif #else # if !defined(_SIZE_T) && !defined(_SIZE_T_DEFINED) # ifdef VM_I386 # define _SIZE_T # ifdef VM_X86_64 typedef uint64 size_t; # else typedef uint32 size_t; # endif # elif defined(VM_ARM_64) # define _SIZE_T typedef uint64 size_t; # elif defined(__arm__) # define _SIZE_T typedef uint32 size_t; # endif # endif # if !defined(FROBOS) && !defined(_SSIZE_T) && !defined(_SSIZE_T_) && \ !defined(ssize_t) && !defined(__ssize_t_defined) && \ !defined(_SSIZE_T_DECLARED) && !defined(_SSIZE_T_DEFINED) && \ !defined(_SSIZE_T_DEFINED_) # ifdef VM_I386 # define _SSIZE_T # define __ssize_t_defined # define _SSIZE_T_DECLARED # define _SSIZE_T_DEFINED_ # ifdef VM_X86_64 typedef int64 ssize_t; # else typedef int32 ssize_t; # endif # elif defined(VM_ARM_64) # define _SSIZE_T # define __ssize_t_defined # define _SSIZE_T_DECLARED # define _SSIZE_T_DEFINED_ typedef int64 ssize_t; # elif defined(__arm__) # define _SSIZE_T # define __ssize_t_defined # define _SSIZE_T_DECLARED # define _SSIZE_T_DEFINED_ typedef int32 ssize_t; # endif # endif #endif /* * Format modifier for printing pid_t. On sun the pid_t is a ulong, but on * Linux it's an int. * Use this like this: printf("The pid is %" FMTPID ".\n", pid); */ #ifdef sun # ifdef VM_X86_64 # define FMTPID "d" # else # define FMTPID "lu" # endif #else # define FMTPID "d" #endif /* * Format modifier for printing uid_t. On Solaris 10 and earlier, uid_t * is a ulong, but on other platforms it's an unsigned int. * Use this like this: printf("The uid is %" FMTUID ".\n", uid); */ #if defined(sun) && !defined(SOL11) # ifdef VM_X86_64 # define FMTUID "u" # else # define FMTUID "lu" # endif #else # define FMTUID "u" #endif /* * Format modifier for printing mode_t. On sun the mode_t is a ulong, but on * Linux it's an int. * Use this like this: printf("The mode is %" FMTMODE ".\n", mode); */ #ifdef sun # ifdef VM_X86_64 # define FMTMODE "o" # else # define FMTMODE "lo" # endif #else # define FMTMODE "o" #endif #ifdef __APPLE__ /* * Format specifier for all these annoying types such as {S,U}Int32 * which are 'long' in 32-bit builds * and 'int' in 64-bit builds. */ # ifdef __LP64__ # define FMTLI "" # else # define FMTLI "l" # endif /* * Format specifier for all these annoying types such as NS[U]Integer * which are 'int' in 32-bit builds * and 'long' in 64-bit builds. */ # ifdef __LP64__ # define FMTIL "l" # else # define FMTIL "" # endif #endif /* * Define type for poll device handles. */ typedef int64 PollDevHandle; /* * Define the utf16_t type. */ #if defined(_WIN32) && defined(_NATIVE_WCHAR_T_DEFINED) typedef wchar_t utf16_t; #else typedef uint16 utf16_t; #endif /* * Define for point and rectangle types. Defined here so they * can be used by other externally facing headers in bora/public. */ typedef struct VMPoint { int x, y; } VMPoint; #if defined _WIN32 && defined USERLEVEL struct tagRECT; typedef struct tagRECT VMRect; #else typedef struct VMRect { int left; int top; int right; int bottom; } VMRect; #endif /* * ranked locks "everywhere" */ typedef uint32 MX_Rank; #endif /* _VM_BASIC_TYPES_H_ */ vmci-only/shared/vmware_pack_begin.h 0000444 0000000 0000000 00000002451 13432725350 016557 0 ustar root root /********************************************************* * Copyright (C) 2002-2016 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 * *********************************************************/ /* * vmware_pack_begin.h -- * * Begin of structure packing. See vmware_pack_init.h for details. * * Note that we do not use the following construct in this include file, * because we want to emit the code every time the file is included --hpreg * * #ifndef foo * # define foo * ... * #endif * */ #include "vmware_pack_init.h" #ifdef _MSC_VER # pragma pack(push, 1) #elif __GNUC__ #else # error Compiler packing... #endif vmci-only/shared/backdoor_types.h 0000444 0000000 0000000 00000006773 13432725350 016137 0 ustar root root /********************************************************* * Copyright (C) 1999-2016 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 * *********************************************************/ /* * backdoor_types.h -- * * Type definitions for backdoor interaction code. */ #ifndef _BACKDOOR_TYPES_H_ #define _BACKDOOR_TYPES_H_ #ifndef VM_I386 #error The backdoor protocol is only supported on x86 architectures. #endif /* * These #defines are intended for defining register structs as part of * existing named unions. If the union should encapsulate the register * (and nothing else), use DECLARE_REG_NAMED_STRUCT defined below. */ #define DECLARE_REG32_STRUCT \ struct { \ uint16 low; \ uint16 high; \ } halfs; \ uint32 word #define DECLARE_REG64_STRUCT \ DECLARE_REG32_STRUCT; \ struct { \ uint32 low; \ uint32 high; \ } words; \ uint64 quad #if defined (VM_X86_64) || defined (VM_ARM_64) #define DECLARE_REG_STRUCT DECLARE_REG64_STRUCT #else #define DECLARE_REG_STRUCT DECLARE_REG32_STRUCT #endif #define DECLARE_REG_NAMED_STRUCT(_r) \ union { DECLARE_REG_STRUCT; } _r /* * Some of the registers are expressed by semantic name, because if they were * expressed as register structs declared above, we could only address them * by fixed size (half-word, word, quad, etc.) instead of by varying size * (size_t, uintptr_t). * * To be cleaner, these registers are expressed ONLY by semantic name, * rather than by a union of the semantic name and a register struct. */ typedef union { struct { DECLARE_REG_NAMED_STRUCT(ax); size_t size; /* Register bx. */ DECLARE_REG_NAMED_STRUCT(cx); DECLARE_REG_NAMED_STRUCT(dx); DECLARE_REG_NAMED_STRUCT(si); DECLARE_REG_NAMED_STRUCT(di); } in; struct { DECLARE_REG_NAMED_STRUCT(ax); DECLARE_REG_NAMED_STRUCT(bx); DECLARE_REG_NAMED_STRUCT(cx); DECLARE_REG_NAMED_STRUCT(dx); DECLARE_REG_NAMED_STRUCT(si); DECLARE_REG_NAMED_STRUCT(di); } out; } Backdoor_proto; typedef union { struct { DECLARE_REG_NAMED_STRUCT(ax); DECLARE_REG_NAMED_STRUCT(bx); size_t size; /* Register cx. */ DECLARE_REG_NAMED_STRUCT(dx); uintptr_t srcAddr; /* Register si. */ uintptr_t dstAddr; /* Register di. */ DECLARE_REG_NAMED_STRUCT(bp); } in; struct { DECLARE_REG_NAMED_STRUCT(ax); DECLARE_REG_NAMED_STRUCT(bx); DECLARE_REG_NAMED_STRUCT(cx); DECLARE_REG_NAMED_STRUCT(dx); DECLARE_REG_NAMED_STRUCT(si); DECLARE_REG_NAMED_STRUCT(di); DECLARE_REG_NAMED_STRUCT(bp); } out; } Backdoor_proto_hb; MY_ASSERTS(BACKDOOR_STRUCT_SIZES, ASSERT_ON_COMPILE(sizeof(Backdoor_proto) == 6 * sizeof(uintptr_t)); ASSERT_ON_COMPILE(sizeof(Backdoor_proto_hb) == 7 * sizeof(uintptr_t)); ) #undef DECLARE_REG_STRUCT #endif /* _BACKDOOR_TYPES_H_ */ vmci-only/shared/compat_workqueue.h 0000444 0000000 0000000 00000014361 13432725347 016517 0 ustar root root /********************************************************* * Copyright (C) 2007 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 * *********************************************************/ #ifndef __COMPAT_WORKQUEUE_H__ # define __COMPAT_WORKQUEUE_H__ #include <linux/kernel.h> #if LINUX_VERSION_CODE > KERNEL_VERSION(2, 5, 41) # include <linux/workqueue.h> #endif /* * * Work queues and delayed work queues. * * Prior to 2.5.41, the notion of work queues did not exist. Taskqueues are * used for work queues and timers are used for delayed work queues. * * After 2.6.20, normal work structs ("work_struct") and delayed work * ("delayed_work") structs were separated so that the work_struct could be * slimmed down. The interface was also changed such that the address of the * work_struct itself is passed in as the argument to the work function. This * requires that one embed the work struct in the larger struct containing the * information necessary to complete the work and use container_of() to obtain * the address of the containing structure. * * Users of these macros should embed a compat_work or compat_delayed_work in * a larger structure, then specify the larger structure as the _data argument * for the initialization functions, specify the work function to take * a compat_work_arg or compat_delayed_work_arg, then use the appropriate * _GET_DATA macro to obtain the reference to the structure passed in as _data. * An example is below. * * * typedef struct WorkData { * int data; * compat_work work; * } WorkData; * * * void * WorkFunc(compat_work_arg data) * { * WorkData *workData = COMPAT_WORK_GET_DATA(data, WorkData, work); * * ... * } * * * { * WorkData *workData = kmalloc(sizeof *workData, GFP_EXAMPLE); * if (!workData) { * return -ENOMEM; * } * * COMPAT_INIT_WORK(&workData->work, WorkFunc, workData); * compat_schedule_work(&workData->work); * } */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 5, 41) /* { */ typedef struct tq_struct compat_work; typedef struct compat_delayed_work { struct tq_struct work; struct timer_list timer; } compat_delayed_work; typedef void * compat_work_arg; typedef void * compat_delayed_work_arg; /* * Delayed work queues need to run at some point in the future in process * context, but task queues don't support delaying the task one is scheduling. * Timers allow us to delay the execution of our work queue until the future, * but timer handlers run in bottom-half context. As such, we use both a timer * and task queue and use the timer handler below to schedule the task in * process context immediately. The timer lets us delay execution, and the * task queue lets us run in process context. * * Note that this is similar to how delayed_work is implemented with work * queues in later kernel versions. */ static inline void __compat_delayed_work_timer(unsigned long arg) { compat_delayed_work *dwork = (compat_delayed_work *)arg; if (dwork) { schedule_task(&dwork->work); } } # define COMPAT_INIT_WORK(_work, _func, _data) \ INIT_LIST_HEAD(&(_work)->list); \ (_work)->sync = 0; \ (_work)->routine = _func; \ (_work)->data = _data # define COMPAT_INIT_DELAYED_WORK(_work, _func, _data) \ COMPAT_INIT_WORK(&(_work)->work, _func, _data); \ init_timer(&(_work)->timer); \ (_work)->timer.expires = 0; \ (_work)->timer.function = __compat_delayed_work_timer; \ (_work)->timer.data = (unsigned long)_work # define compat_schedule_work(_work) \ schedule_task(_work) # define compat_schedule_delayed_work(_work, _delay) \ (_work)->timer.expires = jiffies + _delay; \ add_timer(&(_work)->timer) # define COMPAT_WORK_GET_DATA(_p, _type, _member) \ (_type *)(_p) # define COMPAT_DELAYED_WORK_GET_DATA(_p, _type, _member) \ (_type *)(_p) #elif LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 20) \ && !defined(__VMKLNX__) /* } { */ typedef struct work_struct compat_work; typedef struct work_struct compat_delayed_work; typedef void * compat_work_arg; typedef void * compat_delayed_work_arg; # define COMPAT_INIT_WORK(_work, _func, _data) \ INIT_WORK(_work, _func, _data) # define COMPAT_INIT_DELAYED_WORK(_work, _func, _data) \ INIT_WORK(_work, _func, _data) # define compat_schedule_work(_work) \ schedule_work(_work) # define compat_schedule_delayed_work(_work, _delay) \ schedule_delayed_work(_work, _delay) # define COMPAT_WORK_GET_DATA(_p, _type, _member) \ (_type *)(_p) # define COMPAT_DELAYED_WORK_GET_DATA(_p, _type, _member) \ (_type *)(_p) #else /* } Linux >= 2.6.20 { */ typedef struct work_struct compat_work; typedef struct delayed_work compat_delayed_work; typedef struct work_struct * compat_work_arg; typedef struct work_struct * compat_delayed_work_arg; # define COMPAT_INIT_WORK(_work, _func, _data) \ INIT_WORK(_work, _func) # define COMPAT_INIT_DELAYED_WORK(_work, _func, _data) \ INIT_DELAYED_WORK(_work, _func) # define compat_schedule_work(_work) \ schedule_work(_work) # define compat_schedule_delayed_work(_work, _delay) \ schedule_delayed_work(_work, _delay) # define COMPAT_WORK_GET_DATA(_p, _type, _member) \ container_of(_p, _type, _member) # define COMPAT_DELAYED_WORK_GET_DATA(_p, _type, _member) \ container_of(_p, _type, _member.work) #endif /* } */ #endif /* __COMPAT_WORKQUEUE_H__ */ vmci-only/shared/mul64.h 0000444 0000000 0000000 00000007233 13432725350 014066 0 ustar root root /********************************************************* * Copyright (C) 2003-2014,2017 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 * *********************************************************/ /* * mul64.h * * Integer by fixed point multiplication, with rounding. * * These routines are implemented in assembly language for most * supported platforms. This file has plain C fallback versions. */ #ifndef _MUL64_H_ #define _MUL64_H_ #define INCLUDE_ALLOW_USERLEVEL #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMK_MODULE #define INCLUDE_ALLOW_VMKERNEL #define INCLUDE_ALLOW_DISTRIBUTE #define INCLUDE_ALLOW_VMCORE #include "includeCheck.h" #include "vm_basic_asm.h" #if defined __cplusplus extern "C" { #endif #ifdef MUL64_NO_ASM /* *----------------------------------------------------------------------------- * * Mul64x3264 -- * * Unsigned integer by fixed point multiplication, with rounding: * result = floor(multiplicand * multiplier * 2**(-shift) + 0.5) * * Unsigned 64-bit integer multiplicand. * Unsigned 32-bit fixed point multiplier, represented as * (multiplier, shift), where shift < 64. * * Result: * Unsigned 64-bit integer product. * *----------------------------------------------------------------------------- */ static INLINE uint64 Mul64x3264(uint64 multiplicand, uint32 multiplier, uint32 shift) { uint64 lo, hi, lo2, hi2; unsigned carry; // ASSERT(shift >= 0 && shift < 64); lo = (multiplicand & 0xffffffff) * multiplier; hi = (multiplicand >> 32) * multiplier; lo2 = lo + (hi << 32); carry = lo2 < lo; hi2 = (hi >> 32) + carry; if (shift == 0) { return lo2; } else { return (lo2 >> shift) + (hi2 << (64 - shift)) + ((lo2 >> (shift - 1)) & 1); } } /* *----------------------------------------------------------------------------- * * Muls64x32s64 -- * * Signed integer by fixed point multiplication, with rounding: * result = floor(multiplicand * multiplier * 2**(-shift) + 0.5) * * Signed 64-bit integer multiplicand. * Unsigned 32-bit fixed point multiplier, represented as * (multiplier, shift), where shift < 64. * * Result: * Signed 64-bit integer product. * *----------------------------------------------------------------------------- */ static INLINE int64 Muls64x32s64(int64 multiplicand, uint32 multiplier, uint32 shift) { uint64 lo, hi, lo2, hi2; unsigned carry; // ASSERT(shift >= 0 && shift < 64); hi = ((uint64)multiplicand >> 32) * multiplier; if (multiplicand < 0) { hi -= (uint64)multiplier << 32; } lo = ((uint64)multiplicand & 0xffffffff) * multiplier; lo2 = lo + (hi << 32); carry = lo2 < lo; hi2 = (((int64)hi >> 32) + carry); if (shift == 0) { return lo2; } else { return (lo2 >> shift) + (hi2 << (64 - shift)) + ((lo2 >> (shift - 1)) & 1); } } #endif #if defined __cplusplus } // extern "C" #endif #endif // _MUL64_NOASM_H_ vmci-only/shared/compat_sched.h 0000444 0000000 0000000 00000024236 13432725347 015560 0 ustar root root /********************************************************* * Copyright (C) 2002 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 * *********************************************************/ #ifndef __COMPAT_SCHED_H__ # define __COMPAT_SCHED_H__ #include <linux/sched.h> /* CLONE_KERNEL available in 2.5.35 and higher. */ #ifndef CLONE_KERNEL #define CLONE_KERNEL CLONE_FILES | CLONE_FS | CLONE_SIGHAND #endif /* TASK_COMM_LEN become available in 2.6.11. */ #ifndef TASK_COMM_LEN #define TASK_COMM_LEN 16 #endif /* The capable() API appeared in 2.1.92 --hpreg */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 1, 92) # define capable(_capability) suser() #endif #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 2, 0) # define need_resched() need_resched #elif LINUX_VERSION_CODE < KERNEL_VERSION(2, 5, 3) # define need_resched() (current->need_resched) #endif #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 5, 3) # define cond_resched() (need_resched() ? schedule() : (void) 0) #endif /* Oh well. We need yield... Happy us! */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 20) # ifdef __x86_64__ # define compat_yield() there_is_nothing_like_yield() # else # include <linux/unistd.h> # include <linux/kernel.h> /* * Used by _syscallX macros. Note that this is global variable, so * do not rely on its contents too much. As exit() is only function * we use, and we never check return value from exit(), we have * no problem... */ extern int errno; /* * compat_exit() provides an access to the exit() function. It must * be named compat_exit(), as exit() (with different signature) is * provided by x86-64, arm and other (but not by i386). */ # define __NR_compat_yield __NR_sched_yield static inline _syscall0(int, compat_yield); # endif #else # define compat_yield() yield() #endif /* * Since 2.5.34 there are two methods to enumerate tasks: * for_each_process(p) { ... } which enumerates only tasks and * do_each_thread(g,t) { ... } while_each_thread(g,t) which enumerates * also threads even if they share same pid. */ #ifndef for_each_process # define for_each_process(p) for_each_task(p) #endif #ifndef do_each_thread # define do_each_thread(g, t) for_each_task(g) { t = g; do # define while_each_thread(g, t) while (0) } #endif /* * Lock for signal mask is moving target... */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 5, 40) && defined(CLONE_PID) /* 2.4.x without NPTL patches or early 2.5.x */ #define compat_sigmask_lock sigmask_lock #define compat_dequeue_signal_current(siginfo_ptr) \ dequeue_signal(¤t->blocked, (siginfo_ptr)) #elif LINUX_VERSION_CODE < KERNEL_VERSION(2, 5, 60) && !defined(INIT_SIGHAND) /* RedHat's 2.4.x with first version of NPTL support, or 2.5.40 to 2.5.59 */ #define compat_sigmask_lock sig->siglock #define compat_dequeue_signal_current(siginfo_ptr) \ dequeue_signal(¤t->blocked, (siginfo_ptr)) #else /* RedHat's 2.4.x with second version of NPTL support, or 2.5.60+. */ #define compat_sigmask_lock sighand->siglock #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 5, 0) #define compat_dequeue_signal_current(siginfo_ptr) \ dequeue_signal(¤t->blocked, (siginfo_ptr)) #else #define compat_dequeue_signal_current(siginfo_ptr) \ dequeue_signal(current, ¤t->blocked, (siginfo_ptr)) #endif #endif /* * recalc_sigpending() had task argument in the past */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 5, 29) && defined(CLONE_PID) /* 2.4.x without NPTL patches or early 2.5.x */ #define compat_recalc_sigpending() recalc_sigpending(current) #else /* RedHat's 2.4.x with NPTL support, or 2.5.29+ */ #define compat_recalc_sigpending() recalc_sigpending() #endif /* * reparent_to_init() was introduced in 2.4.8. In 2.5.38 (or possibly * earlier, but later than 2.5.31) a call to it was added into * daemonize(), so compat_daemonize no longer needs to call it. * * In 2.4.x kernels reparent_to_init() forgets to do correct refcounting * on current->user. It is better to count one too many than one too few... */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 4, 8) && LINUX_VERSION_CODE < KERNEL_VERSION(2, 5, 38) #define compat_reparent_to_init() do { \ reparent_to_init(); \ atomic_inc(¤t->user->__count); \ } while (0) #else #define compat_reparent_to_init() do {} while (0) #endif /* * daemonize appeared in 2.2.18. Except 2.2.17-4-RH7.0, which has it too. * Fortunately 2.2.17-4-RH7.0 uses versioned symbols, so we can check * its existence with defined(). */ #if (LINUX_VERSION_CODE < KERNEL_VERSION(2, 2, 18)) && !defined(daemonize) static inline void daemonize(void) { struct fs_struct *fs; exit_mm(current); current->session = 1; current->pgrp = 1; exit_fs(current); fs = init_task.fs; current->fs = fs; atomic_inc(&fs->count); } #endif /* * flush_signals acquires sighand->siglock since 2.5.61... Verify RH's kernels! */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 5, 61) #define compat_flush_signals(task) do { \ spin_lock_irq(&task->compat_sigmask_lock); \ flush_signals(task); \ spin_unlock_irq(&task->compat_sigmask_lock); \ } while (0) #else #define compat_flush_signals(task) flush_signals(task) #endif #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 5, 61) #define compat_allow_signal(signr) do { \ spin_lock_irq(¤t->compat_sigmask_lock); \ sigdelset(¤t->blocked, signr); \ compat_recalc_sigpending(); \ spin_unlock_irq(¤t->compat_sigmask_lock); \ } while (0) #else #define compat_allow_signal(signr) allow_signal(signr) #endif /* * daemonize can set process name since 2.5.61. Prior to 2.5.61, daemonize * didn't block signals on our behalf. */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 5, 61) #define compat_daemonize(x...) \ ({ \ /* Beware! No snprintf here, so verify arguments! */ \ sprintf(current->comm, x); \ \ /* Block all signals. */ \ spin_lock_irq(¤t->compat_sigmask_lock); \ sigfillset(¤t->blocked); \ compat_recalc_sigpending(); \ spin_unlock_irq(¤t->compat_sigmask_lock); \ compat_flush_signals(current); \ \ daemonize(); \ compat_reparent_to_init(); \ }) #else #define compat_daemonize(x...) daemonize(x) #endif /* * try to freeze a process. For kernels 2.6.11 or newer, we know how to choose * the interface. The problem is that the oldest interface, introduced in * 2.5.18, was backported to 2.4.x kernels. So if we're older than 2.6.11, * we'll decide what to do based on whether or not swsusp was configured * for the kernel. For kernels 2.6.20 and newer, we'll also need to include * freezer.h since the try_to_freeze definition was pulled out of sched.h. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 20) #include <linux/freezer.h> #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 13) || defined(VMW_TL10S64_WORKAROUND) #define compat_try_to_freeze() try_to_freeze() #elif LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 11) #define compat_try_to_freeze() try_to_freeze(PF_FREEZE) #elif defined(CONFIG_SOFTWARE_SUSPEND) || defined(CONFIG_SOFTWARE_SUSPEND2) #include "compat_mm.h" #include <linux/errno.h> #include <linux/suspend.h> static inline int compat_try_to_freeze(void) { if (current->flags & PF_FREEZE) { refrigerator(PF_FREEZE); return 1; } else { return 0; } } #else static inline int compat_try_to_freeze(void) { return 0; } #endif /* * As of 2.6.23-rc1, kernel threads are no longer freezable by * default. Instead, kernel threads that need to be frozen must opt-in * by calling set_freezable() as soon as the thread is created. */ #if LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 22) #define compat_set_freezable() do { set_freezable(); } while (0) #else #define compat_set_freezable() do {} while (0) #endif /* * Around 2.6.27 kernel stopped sending signals to kernel * threads being frozen, instead threads have to check * freezing() or use wait_event_freezable(). Unfortunately * wait_event_freezable() completely hides the fact that * thread was frozen from calling code and sometimes we do * want to know that. */ #ifdef PF_FREEZER_NOSIG #define compat_wait_check_freezing() freezing(current) #else #define compat_wait_check_freezing() (0) #endif /* * Since 2.6.27-rc2 kill_proc() is gone... Replacement (GPL-only!) * API is available since 2.6.19. Use them from 2.6.27-rc1 up. */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 27) typedef int compat_pid; #define compat_find_get_pid(pid) (pid) #define compat_put_pid(pid) do { } while (0) #define compat_kill_pid(pid, sig, flag) kill_proc(pid, sig, flag) #else typedef struct pid * compat_pid; #define compat_find_get_pid(pid) find_get_pid(pid) #define compat_put_pid(pid) put_pid(pid) #define compat_kill_pid(pid, sig, flag) kill_pid(pid, sig, flag) #endif #endif /* __COMPAT_SCHED_H__ */ vmci-only/shared/compat_page-flags.h 0000444 0000000 0000000 00000005037 13432725347 016476 0 ustar root root /********************************************************* * Copyright (C) 2007 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 * *********************************************************/ #ifndef __COMPAT_PAGE_FLAGS_H__ # define __COMPAT_PAGE_FLAGS_H__ /* No page-flags.h prior to 2.5.12. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 5, 12) # include <linux/page-flags.h> #endif /* * The pgoff_t type was introduced in 2.5.20, but we'll look for it by * definition since it's more convenient. Note that we want to avoid a * situation where, in the future, a #define is changed to a typedef, * so if pgoff_t is not defined in some future kernel, we won't define it. */ #if !defined(pgoff_t) && LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 19) #define pgoff_t unsigned long #endif /* * set_page_writeback() was introduced in 2.6.6. Prior to that, callers were * using the SetPageWriteback() macro directly, so that's what we'll use. * Prior to 2.5.12, the writeback bit didn't exist, so we don't need to do * anything. */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 5, 12) #define compat_set_page_writeback(page) #elif LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 6) #define compat_set_page_writeback(page) SetPageWriteback(page) #else #define compat_set_page_writeback(page) set_page_writeback(page) #endif /* * end_page_writeback() was introduced in 2.5.12. Prior to that, it looks like * there was no page writeback bit, and everything the function accomplished * was done by unlock_page(), so we'll define it out. * * Note that we could just #define end_page_writeback to nothing and avoid * needing the compat_ prefix, but this is more complete with respect to * compat_set_page_writeback. */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 5, 12) #define compat_end_page_writeback(page) #else #define compat_end_page_writeback(page) end_page_writeback(page) #endif #endif /* __COMPAT_PAGE_FLAGS_H__ */ vmci-only/shared/compat_fs.h 0000444 0000000 0000000 00000024277 13432725347 015107 0 ustar root root /********************************************************* * Copyright (C) 2006 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 * *********************************************************/ #ifndef __COMPAT_FS_H__ # define __COMPAT_FS_H__ #include <linux/fs.h> /* * 2.6.5+ kernels define FS_BINARY_MOUNTDATA. Since it didn't exist and * wasn't used prior, it's safe to define it to zero. */ #ifndef FS_BINARY_MOUNTDATA #define FS_BINARY_MOUNTDATA 0 #endif /* * MAX_LFS_FILESIZE wasn't defined until 2.5.4. */ #ifndef MAX_LFS_FILESIZE # include <linux/pagemap.h> # if BITS_PER_LONG == 32 # define MAX_LFS_FILESIZE (((u64)PAGE_CACHE_SIZE << (BITS_PER_LONG - 1)) - 1) # elif BITS_PER_LONG == 64 # define MAX_LFS_FILESIZE 0x7fffffffffffffffUL # endif #endif /* * sendfile as a VFS op was born in 2.5.30. Unfortunately, it also changed * signatures, first in 2.5.47, then again in 2.5.70, then again in 2.6.8. * Luckily, the 2.6.8+ signature is the same as the 2.5.47 signature. And * as of 2.6.23-rc1 sendfile is gone, replaced by splice_read... * * Let's not support sendfile from 2.5.30 to 2.5.47, because the 2.5.30 * signature is much different and file_send_actor isn't externed. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 23) #define VMW_SENDFILE_NONE #elif LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 8) #define VMW_SENDFILE_NEW #elif LINUX_VERSION_CODE >= KERNEL_VERSION(2, 5, 70) #define VMW_SENDFILE_OLD #elif LINUX_VERSION_CODE >= KERNEL_VERSION(2, 5, 47) #define VMW_SENDFILE_NEW #else #define VMW_SENDFILE_NONE #endif /* * splice_read is there since 2.6.17, but let's avoid 2.6.17-rcX kernels... * After all nobody is using splice system call until 2.6.23 using it to * implement sendfile. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 18) #define VMW_SPLICE_READ 1 #endif /* * Filesystems wishing to use generic page cache read/write routines are * supposed to implement aio_read and aio_write (calling into * generic_file_aio_read() and generic_file_aio_write() if necessary). * * The VFS exports do_sync_read() and do_sync_write() as the "new" * generic_file_read() and generic_file_write(), but filesystems need not * actually implement read and write- the VFS will automatically call * do_sync_write() and do_sync_read() when applications invoke the standard * read() and write() system calls. * * In 2.6.19, generic_file_read() and generic_file_write() were removed, * necessitating this change. AIO dates as far back as 2.5.42, but the API has * changed over time, so for simplicity, we'll only enable it from 2.6.19 and * on. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 19) # define VMW_USE_AIO #endif /* * The alloc_inode and destroy_inode VFS ops didn't exist prior to 2.4.21. * Without these functions, file systems can't embed inodes. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 4, 21) # define VMW_EMBED_INODE #endif /* * iget() was removed from the VFS as of 2.6.25-rc1. The replacement for iget() * is iget_locked() which was added in 2.5.17. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 5, 17) # define VMW_USE_IGET_LOCKED #endif /* * parent_ino was born in 2.5.5. For older kernels, let's use 2.5.5 * implementation. It uses the dcache lock which is OK because per-dentry * locking appeared after 2.5.5. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 5, 5) #define compat_parent_ino(dentry) parent_ino(dentry) #else #define compat_parent_ino(dentry) \ ({ \ ino_t res; \ spin_lock(&dcache_lock); \ res = dentry->d_parent->d_inode->i_ino; \ spin_unlock(&dcache_lock); \ res; \ }) #endif /* * putname changed to __putname in 2.6.6. */ #define compat___getname() __getname() #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 6) #define compat___putname(name) putname(name) #else #define compat___putname(name) __putname(name) #endif /* * inc_nlink, drop_nlink, and clear_nlink were added in 2.6.19. */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 19) #define compat_inc_nlink(inode) ((inode)->i_nlink++) #define compat_drop_nlink(inode) ((inode)->i_nlink--) #define compat_clear_nlink(inode) ((inode)->i_nlink = 0) #else #define compat_inc_nlink(inode) inc_nlink(inode) #define compat_drop_nlink(inode) drop_nlink(inode) #define compat_clear_nlink(inode) clear_nlink(inode) #endif /* * i_size_write and i_size_read were introduced in 2.6.0-test1 * (though we'll look for them as of 2.6.1). They employ slightly different * locking in order to guarantee atomicity, depending on the length of a long, * whether the kernel is SMP, or whether the kernel is preemptible. Prior to * i_size_write and i_size_read, there was no such locking, so that's the * behavior we'll emulate. */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 1) #define compat_i_size_read(inode) ((inode)->i_size) #define compat_i_size_write(inode, size) ((inode)->i_size = size) #else #define compat_i_size_read(inode) i_size_read(inode) #define compat_i_size_write(inode, size) i_size_write(inode, size) #endif /* * filemap_fdatawrite was introduced in 2.5.12. Prior to that, modules used * filemap_fdatasync instead. In 2.4.18, both filemap_fdatawrite and * filemap_fdatawait began returning status codes. Prior to that, they were * void functions, so we'll just have them return 0. */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 18) #define compat_filemap_fdatawrite(mapping) \ ({ \ int result = 0; \ filemap_fdatasync(mapping); \ result; \ }) #define compat_filemap_fdatawait(mapping) \ ({ \ int result = 0; \ filemap_fdatawait(mapping); \ result; \ }) #elif LINUX_VERSION_CODE < KERNEL_VERSION(2, 5, 12) #define compat_filemap_fdatawrite(mapping) filemap_fdatasync(mapping) #define compat_filemap_fdatawait(mapping) filemap_fdatawait(mapping) #else #define compat_filemap_fdatawrite(mapping) filemap_fdatawrite(mapping) #define compat_filemap_fdatawait(mapping) filemap_fdatawait(mapping) #endif /* * filemap_write_and_wait was introduced in 2.6.6 and exported for module use * in 2.6.16. It's really just a simple wrapper around filemap_fdatawrite and * and filemap_fdatawait, which initiates a flush of all dirty pages, then * waits for the pages to flush. The implementation here is a simplified form * of the one found in 2.6.20-rc3. * * Unfortunately, it just isn't possible to implement this prior to 2.4.5, when * neither filemap_fdatawait nor filemap_fdatasync were exported for module * use. So we'll define it out and hope for the best. */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 5) #define compat_filemap_write_and_wait(mapping) #elif LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 16) #define compat_filemap_write_and_wait(mapping) \ ({ \ int result = 0; \ if (mapping->nrpages) { \ result = compat_filemap_fdatawrite(mapping); \ if (result != -EIO) { \ int result2 = compat_filemap_fdatawait(mapping); \ if (!result) { \ result = result2; \ } \ } \ } \ result; \ }) #else #define compat_filemap_write_and_wait(mapping) filemap_write_and_wait(mapping) #endif /* * invalidate_remote_inode was introduced in 2.6.0-test5. Prior to that, * filesystems wishing to invalidate pages belonging to an inode called * invalidate_inode_pages. */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0) #define compat_invalidate_remote_inode(inode) invalidate_inode_pages(inode) #else #define compat_invalidate_remote_inode(inode) invalidate_remote_inode(inode) #endif #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 35) #define VMW_FSYNC_OLD #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 3, 0) typedef umode_t compat_umode_t; #else typedef int compat_umode_t; #endif #if LINUX_VERSION_CODE < KERNEL_VERSION(3, 4, 0) #define d_make_root(inode) ({ \ struct dentry * ____res = d_alloc_root(inode); \ if (!____res) { \ iput(inode); \ } \ ____res; \ }) #endif #endif /* __COMPAT_FS_H__ */ vmci-only/shared/driverLog.c 0000444 0000000 0000000 00000011117 13432725347 015051 0 ustar root root /********************************************************* * Copyright (C) 2007-2014 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 * *********************************************************/ /* * driverLog.c -- * * Common logging functions for Linux kernel modules. */ #include "driver-config.h" #include "compat_kernel.h" #include "compat_sched.h" #include <asm/current.h> #include "driverLog.h" #define LINUXLOG_BUFFER_SIZE 1024 static const char *driverLogPrefix = ""; /* * vsnprintf was born in 2.4.10. Fall back on vsprintf if we're * an older kernel. */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 10) # define vsnprintf(str, size, fmt, args) vsprintf(str, fmt, args) #endif /* *---------------------------------------------------------------------------- * * DriverLog_Init -- * * Initializes the Linux logging. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------------- */ void DriverLog_Init(const char *prefix) // IN { driverLogPrefix = prefix ? prefix : ""; } /* *---------------------------------------------------------------------- * * DriverLogPrint -- * * Log error message from a Linux module. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ static void DriverLogPrint(const char *level, // IN: KERN_* constant const char *fmt, // IN: error format string va_list args) // IN: arguments for format string { static char staticBuf[LINUXLOG_BUFFER_SIZE]; char stackBuf[128]; va_list args2; const char *buf; /* * By default, use a small buffer on the stack (thread safe). If it is too * small, fall back to a larger static buffer (not thread safe). */ va_copy(args2, args); if (vsnprintf(stackBuf, sizeof stackBuf, fmt, args2) < sizeof stackBuf) { buf = stackBuf; } else { vsnprintf(staticBuf, sizeof staticBuf, fmt, args); buf = staticBuf; } va_end(args2); printk("%s%s[%d]: %s", level, driverLogPrefix, current->pid, buf); } /* *---------------------------------------------------------------------- * * Warning -- * * Warning messages from kernel module: logged into kernel log * as warnings. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ void Warning(const char *fmt, ...) // IN: warning format string { va_list args; va_start(args, fmt); DriverLogPrint(KERN_WARNING, fmt, args); va_end(args); } /* *---------------------------------------------------------------------- * * Log -- * * Log messages from kernel module: logged into kernel log * as debug information. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ void Log(const char *fmt, ...) // IN: log format string { va_list args; /* * Use the kernel log with at least a KERN_DEBUG level * so it doesn't garbage the screen at (re)boot time on RedHat 6.0. */ va_start(args, fmt); DriverLogPrint(KERN_DEBUG, fmt, args); va_end(args); } /* *---------------------------------------------------------------------- * * Panic -- * * ASSERTION failures and Panics from kernel module get here. * Message is logged to the kernel log and on console. * * Results: * None. * * Side effects: * Never returns * *---------------------------------------------------------------------- */ void Panic(const char *fmt, ...) // IN: panic format string { va_list args; va_start(args, fmt); DriverLogPrint(KERN_EMERG, fmt, args); va_end(args); #ifdef BUG BUG(); #else /* Should die with %cs unwritable, or at least with page fault. */ asm volatile("movb $0, %cs:(0)"); #endif while (1); } vmci-only/shared/compat_autoconf.h 0000444 0000000 0000000 00000002641 13432725347 016304 0 ustar root root /********************************************************* * Copyright (C) 2009 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 * *********************************************************/ #ifndef __COMPAT_AUTOCONF_H__ # define __COMPAT_AUTOCONF_H__ #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMCORE #define INCLUDE_ALLOW_DISTRIBUTE #define INCLUDE_ALLOW_VMKDRIVERS #include "includeCheck.h" #ifndef LINUX_VERSION_CODE # error "Include compat_version.h before compat_autoconf.h" #endif /* autoconf.h moved from linux/autoconf.h to generated/autoconf.h in 2.6.33-rc1. */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 33) # include <linux/autoconf.h> #else # include <generated/autoconf.h> #endif #endif /* __COMPAT_AUTOCONF_H__ */ vmci-only/shared/compat_skbuff.h 0000444 0000000 0000000 00000016131 13432725347 015745 0 ustar root root /********************************************************* * Copyright (C) 2007 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 * *********************************************************/ #ifndef __COMPAT_SKBUFF_H__ # define __COMPAT_SKBUFF_H__ #include <linux/skbuff.h> /* * When transition from mac/nh/h to skb_* accessors was made, also SKB_WITH_OVERHEAD * was introduced. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 22) || \ (LINUX_VERSION_CODE == KERNEL_VERSION(2, 6, 21) && defined(SKB_WITH_OVERHEAD)) #define compat_skb_mac_header(skb) skb_mac_header(skb) #define compat_skb_network_header(skb) skb_network_header(skb) #define compat_skb_network_offset(skb) skb_network_offset(skb) #define compat_skb_transport_header(skb) skb_transport_header(skb) #define compat_skb_transport_offset(skb) skb_transport_offset(skb) #define compat_skb_network_header_len(skb) skb_network_header_len(skb) #define compat_skb_tail_pointer(skb) skb_tail_pointer(skb) #define compat_skb_end_pointer(skb) skb_end_pointer(skb) #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 22) # define compat_skb_ip_header(skb) ip_hdr(skb) # define compat_skb_ipv6_header(skb) ipv6_hdr(skb) # define compat_skb_tcp_header(skb) tcp_hdr(skb) #else # define compat_skb_ip_header(skb) ((struct iphdr *)skb_network_header(skb)) # define compat_skb_ipv6_header(skb) ((struct ipv6hdr *)skb_network_header(skb)) # define compat_skb_tcp_header(skb) ((struct tcphdr *)skb_transport_header(skb)) #endif #define compat_skb_reset_mac_header(skb) skb_reset_mac_header(skb) #define compat_skb_reset_network_header(skb) skb_reset_network_header(skb) #define compat_skb_reset_transport_header(skb) skb_reset_transport_header(skb) #define compat_skb_set_network_header(skb, off) skb_set_network_header(skb, off) #define compat_skb_set_transport_header(skb, off) skb_set_transport_header(skb, off) #else #define compat_skb_mac_header(skb) (skb)->mac.raw #define compat_skb_network_header(skb) (skb)->nh.raw #define compat_skb_network_offset(skb) ((skb)->nh.raw - (skb)->data) #define compat_skb_transport_header(skb) (skb)->h.raw #define compat_skb_transport_offset(skb) ((skb)->h.raw - (skb)->data) #define compat_skb_network_header_len(skb) ((skb)->h.raw - (skb)->nh.raw) #define compat_skb_tail_pointer(skb) (skb)->tail #define compat_skb_end_pointer(skb) (skb)->end #define compat_skb_ip_header(skb) (skb)->nh.iph #define compat_skb_ipv6_header(skb) (skb)->nh.ipv6h #define compat_skb_tcp_header(skb) (skb)->h.th #define compat_skb_reset_mac_header(skb) ((skb)->mac.raw = (skb)->data) #define compat_skb_reset_network_header(skb) ((skb)->nh.raw = (skb)->data) #define compat_skb_reset_transport_header(skb) ((skb)->h.raw = (skb)->data) #define compat_skb_set_network_header(skb, off) ((skb)->nh.raw = (skb)->data + (off)) #define compat_skb_set_transport_header(skb, off) ((skb)->h.raw = (skb)->data + (off)) #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 18) || defined(VMW_SKB_LINEARIZE_2618) # define compat_skb_linearize(skb) skb_linearize((skb)) #else # if LINUX_VERSION_CODE == KERNEL_VERSION(2, 6, 0) # define compat_skb_linearize(skb) __skb_linearize((skb), GFP_ATOMIC) # elif LINUX_VERSION_CODE >= KERNEL_VERSION(2, 4, 4) # define compat_skb_linearize(skb) skb_linearize((skb), GFP_ATOMIC) # else static inline int compat_skb_linearize(struct sk_buff *skb) { return 0; } # endif #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 20) #define compat_skb_csum_offset(skb) (skb)->csum_offset #else #define compat_skb_csum_offset(skb) (skb)->csum #endif /* * Note that compat_skb_csum_start() has semantic different from kernel's csum_start: * kernel's skb->csum_start is offset between start of checksummed area and start of * complete skb buffer, while our compat_skb_csum_start(skb) is offset from start * of packet itself. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 22) #define compat_skb_csum_start(skb) ((skb)->csum_start - skb_headroom(skb)) #else #define compat_skb_csum_start(skb) compat_skb_transport_offset(skb) #endif #if defined(NETIF_F_GSO) /* 2.6.18 and upwards */ #define compat_skb_mss(skb) (skb_shinfo(skb)->gso_size) #else #define compat_skb_mss(skb) (skb_shinfo(skb)->tso_size) #endif /* used by both received pkts and outgoing ones */ #define VM_CHECKSUM_UNNECESSARY CHECKSUM_UNNECESSARY /* csum status of received pkts */ #if defined(CHECKSUM_COMPLETE) # define VM_RX_CHECKSUM_PARTIAL CHECKSUM_COMPLETE #elif LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 19) && defined(CHECKSUM_HW) # define VM_RX_CHECKSUM_PARTIAL CHECKSUM_HW #else # define VM_RX_CHECKSUM_PARTIAL CHECKSUM_PARTIAL #endif /* csum status of outgoing pkts */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 19) && defined(CHECKSUM_HW) # define VM_TX_CHECKSUM_PARTIAL CHECKSUM_HW #else # define VM_TX_CHECKSUM_PARTIAL CHECKSUM_PARTIAL #endif #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,1,0)) # define compat_kfree_skb(skb, type) kfree_skb(skb, type) # define compat_dev_kfree_skb(skb, type) dev_kfree_skb(skb, type) # define compat_dev_kfree_skb_any(skb, type) dev_kfree_skb(skb, type) # define compat_dev_kfree_skb_irq(skb, type) dev_kfree_skb(skb, type) #else # define compat_kfree_skb(skb, type) kfree_skb(skb) # define compat_dev_kfree_skb(skb, type) dev_kfree_skb(skb) # if (LINUX_VERSION_CODE < KERNEL_VERSION(2,3,43)) # define compat_dev_kfree_skb_any(skb, type) dev_kfree_skb(skb) # define compat_dev_kfree_skb_irq(skb, type) dev_kfree_skb(skb) # else # define compat_dev_kfree_skb_any(skb, type) dev_kfree_skb_any(skb) # define compat_dev_kfree_skb_irq(skb, type) dev_kfree_skb_irq(skb) # endif #endif #ifndef NET_IP_ALIGN # define COMPAT_NET_IP_ALIGN 2 #else # define COMPAT_NET_IP_ALIGN NET_IP_ALIGN #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 4, 4) # define compat_skb_headlen(skb) skb_headlen(skb) # define compat_pskb_may_pull(skb, len) pskb_may_pull(skb, len) # define compat_skb_is_nonlinear(skb) skb_is_nonlinear(skb) #else # define compat_skb_headlen(skb) (skb)->len # define compat_pskb_may_pull(skb, len) 1 # define compat_skb_is_nonlinear(skb) 0 #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 12) # define compat_skb_header_cloned(skb) skb_header_cloned(skb) #else # define compat_skb_header_cloned(skb) 0 #endif #endif /* __COMPAT_SKBUFF_H__ */ vmci-only/shared/compat_semaphore.h 0000444 0000000 0000000 00000003142 13432725347 016446 0 ustar root root /********************************************************* * Copyright (C) 2002 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 * *********************************************************/ #ifndef __COMPAT_SEMAPHORE_H__ # define __COMPAT_SEMAPHORE_H__ /* <= 2.6.25 have asm only, 2.6.26 has both, and 2.6.27-rc2+ has linux only. */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 27) # include <asm/semaphore.h> #else # include <linux/semaphore.h> #endif /* * The init_MUTEX_LOCKED() API appeared in 2.2.18, and is also in * 2.2.17-21mdk --hpreg */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 2, 18) #ifndef init_MUTEX_LOCKED #define init_MUTEX_LOCKED(_sem) *(_sem) = MUTEX_LOCKED #endif #ifndef DECLARE_MUTEX #define DECLARE_MUTEX(name) struct semaphore name = MUTEX #endif #ifndef DECLARE_MUTEX_LOCKED #define DECLARE_MUTEX_LOCKED(name) struct semaphore name = MUTEX_LOCKED #endif #endif #endif /* __COMPAT_SEMAPHORE_H__ */ vmci-only/shared/vmware_pack_end.h 0000444 0000000 0000000 00000002475 13432725350 016247 0 ustar root root /********************************************************* * Copyright (C) 2002-2016 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 * *********************************************************/ /* * vmware_pack_end.h -- * * End of structure packing. See vmware_pack_init.h for details. * * Note that we do not use the following construct in this include file, * because we want to emit the code every time the file is included --hpreg * * #ifndef foo * # define foo * ... * #endif * */ #include "vmware_pack_init.h" #ifdef _MSC_VER # pragma pack(pop) #elif __GNUC__ __attribute__((__packed__)) #else # error Compiler packing... #endif vmci-only/shared/compat_uaccess.h 0000444 0000000 0000000 00000006062 13432725347 016115 0 ustar root root /********************************************************* * Copyright (C) 2002 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 * *********************************************************/ #ifndef __COMPAT_UACCESS_H__ # define __COMPAT_UACCESS_H__ /* User space access functions moved in 2.1.7 to asm/uaccess.h --hpreg */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 1, 7) # include <asm/uaccess.h> #else # include <asm/segment.h> #endif /* get_user() API modified in 2.1.4 to take 2 arguments --hpreg */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 1, 4) # define compat_get_user get_user #else /* * We assign 0 to the variable in case of failure to prevent "`_var' might be * used uninitialized in this function" compiler warnings. I think it is OK, * because the hardware-based version in newer kernels probably has the same * semantics and does not guarantee that the value of _var will not be * modified, should the access fail --hpreg */ # define compat_get_user(_var, _uvAddr) ({ \ int _status; \ \ _status = verify_area(VERIFY_READ, _uvAddr, sizeof(*(_uvAddr))); \ if (_status == 0) { \ (_var) = get_user(_uvAddr); \ } else { \ (_var) = 0; \ } \ _status; \ }) #endif /* * The copy_from_user() API appeared in 2.1.4 * * The emulation is not perfect here, but it is conservative: on failure, we * always return the total size, instead of the potentially smaller faulty * size --hpreg * * Since 2.5.55 copy_from_user() is no longer macro. */ #if !defined(copy_from_user) && LINUX_VERSION_CODE < KERNEL_VERSION(2, 2, 0) # define copy_from_user(_to, _from, _size) ( \ verify_area(VERIFY_READ, _from, _size) \ ? (_size) \ : (memcpy_fromfs(_to, _from, _size), 0) \ ) # define copy_to_user(_to, _from, _size) ( \ verify_area(VERIFY_WRITE, _to, _size) \ ? (_size) \ : (memcpy_tofs(_to, _from, _size), 0) \ ) #endif #endif /* __COMPAT_UACCESS_H__ */ vmci-only/shared/compat_spinlock.h 0000444 0000000 0000000 00000003377 13432725347 016317 0 ustar root root /********************************************************* * Copyright (C) 2005 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 * *********************************************************/ #ifndef __COMPAT_SPINLOCK_H__ # define __COMPAT_SPINLOCK_H__ #include <linux/spinlock.h> /* * Preempt support was added during 2.5.x development cycle, and later * it was backported to 2.4.x. In 2.4.x backport these definitions * live in linux/spinlock.h, that's why we put them here (in 2.6.x they * are defined in linux/preempt.h which is included by linux/spinlock.h). */ #ifdef CONFIG_PREEMPT #define compat_preempt_disable() preempt_disable() #define compat_preempt_enable() preempt_enable() #else #define compat_preempt_disable() do { } while (0) #define compat_preempt_enable() do { } while (0) #endif /* Some older kernels - 2.6.10 and earlier - lack DEFINE_SPINLOCK */ #ifndef DEFINE_SPINLOCK #define DEFINE_SPINLOCK(x) spinlock_t x = SPIN_LOCK_UNLOCKED #endif /* Same goes for DEFINE_RWLOCK */ #ifndef DEFINE_RWLOCK #define DEFINE_RWLOCK(x) rwlock_t x = RW_LOCK_UNLOCKED #endif #endif /* __COMPAT_SPINLOCK_H__ */ vmci-only/shared/driverLog.h 0000444 0000000 0000000 00000002237 13432725347 015061 0 ustar root root /********************************************************* * Copyright (C) 2007-2014 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 * *********************************************************/ /* * driverLog.h -- * * Logging functions for Linux kernel modules. */ #ifndef __DRIVERLOG_H__ #define __DRIVERLOG_H__ /* * The definitions of Warning(), Log(), and Panic() come from vm_assert.h for * consistency. */ #include "vm_assert.h" void DriverLog_Init(const char *prefix); #endif /* __DRIVERLOG_H__ */ vmci-only/shared/x86cpuid.h 0000644 0000000 0000000 00000327332 13432725350 014600 0 ustar root root /********************************************************* * Copyright (C) 1998-2018 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 * *********************************************************/ #ifndef _X86CPUID_H_ #define _X86CPUID_H_ /* http://www.sandpile.org/ia32/cpuid.htm */ #define INCLUDE_ALLOW_USERLEVEL #define INCLUDE_ALLOW_VMX #define INCLUDE_ALLOW_VMKERNEL #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_DISTRIBUTE #define INCLUDE_ALLOW_VMK_MODULE #define INCLUDE_ALLOW_VMCORE #define INCLUDE_ALLOW_VMMON #include "includeCheck.h" #include "vm_basic_types.h" #include "community_source.h" #include "x86vendor.h" #include "vm_assert.h" #if defined __cplusplus extern "C" { #endif /* * The linux kernel's ptrace.h stupidly defines the bare * EAX/EBX/ECX/EDX, which wrecks havoc with our preprocessor tricks. */ #undef EAX #undef EBX #undef ECX #undef EDX typedef struct CPUIDRegs { uint32 eax, ebx, ecx, edx; } CPUIDRegs; typedef union CPUIDRegsUnion { uint32 array[4]; CPUIDRegs regs; } CPUIDRegsUnion; /* * Results of calling cpuid(eax, ecx) on all host logical CPU. */ #ifdef _MSC_VER // TODO: Move this under the push #pragma warning (disable :4200) // non-std extension: zero-sized array in struct #pragma warning (push) #pragma warning (disable :4100) // unreferenced parameters #endif typedef #include "vmware_pack_begin.h" struct CPUIDReply { /* * Unique host logical CPU identifier. It does not change across queries, so * we use it to correlate the replies of multiple queries. */ uint64 tag; // OUT CPUIDRegs regs; // OUT } #include "vmware_pack_end.h" CPUIDReply; typedef #include "vmware_pack_begin.h" struct CPUIDQuery { uint32 eax; // IN uint32 ecx; // IN uint32 numLogicalCPUs; // IN/OUT CPUIDReply logicalCPUs[0]; // OUT } #include "vmware_pack_end.h" CPUIDQuery; /* * CPUID levels the monitor caches. * * The first parameter defines whether the level has its default masks * generated from the values in this file. Any level which is marked as FALSE * here *must* have all monitor support types set to NA. A static assert in * lib/cpuidcompat/cpuidcompat.c will check this. * * The second parameter is the "short name" of the level. It's mainly used for * token concatenation in various macros. * * The third parameter is the actual numeric value of that level (the EAX input * value). * * The fourth parameter is a "subleaf count", where 0 means that ecx is * ignored, otherwise is the count of sub-leaves. * * The fifth parameter is the first hardware version that is *aware* of the * CPUID level (0 = existed since dawn of time), even though we may not expose * this level or parts of it to guest. */ #define CPUID_CACHED_LEVELS \ CPUIDLEVEL(TRUE, 0, 0, 0, 0) \ CPUIDLEVEL(TRUE, 1, 1, 0, 0) \ CPUIDLEVEL(FALSE, 2, 2, 0, 0) \ CPUIDLEVEL(FALSE, 4, 4, 7, 0) \ CPUIDLEVEL(FALSE, 5, 5, 0, 0) \ CPUIDLEVEL(TRUE, 6, 6, 0, 0) \ CPUIDLEVEL(TRUE, 7, 7, 1, 0) \ CPUIDLEVEL(FALSE, A, 0xA, 0, 0) \ CPUIDLEVEL(FALSE, B, 0xB, 2, 0) \ CPUIDLEVEL(TRUE, D, 0xD, 10, 0) \ CPUIDLEVEL(TRUE, F, 0xF, 2, 13) \ CPUIDLEVEL(TRUE, 10, 0x10, 2, 13) \ CPUIDLEVEL(TRUE, 12, 0x12, 4, 13) \ CPUIDLEVEL(TRUE, 14, 0x14, 2, 13) \ CPUIDLEVEL(TRUE, 15, 0x15, 0, 13) \ CPUIDLEVEL(TRUE, 16, 0x16, 0, 13) \ CPUIDLEVEL(TRUE, 17, 0x17, 4, 14) \ CPUIDLEVEL(FALSE, 400, 0x40000000, 0, 0) \ CPUIDLEVEL(FALSE, 401, 0x40000001, 0, 0) \ CPUIDLEVEL(FALSE, 402, 0x40000002, 0, 0) \ CPUIDLEVEL(FALSE, 403, 0x40000003, 0, 0) \ CPUIDLEVEL(FALSE, 404, 0x40000004, 0, 0) \ CPUIDLEVEL(FALSE, 405, 0x40000005, 0, 0) \ CPUIDLEVEL(FALSE, 406, 0x40000006, 0, 0) \ CPUIDLEVEL(FALSE, 410, 0x40000010, 0, 0) \ CPUIDLEVEL(FALSE, 80, 0x80000000, 0, 0) \ CPUIDLEVEL(TRUE, 81, 0x80000001, 0, 0) \ CPUIDLEVEL(FALSE, 82, 0x80000002, 0, 0) \ CPUIDLEVEL(FALSE, 83, 0x80000003, 0, 0) \ CPUIDLEVEL(FALSE, 84, 0x80000004, 0, 0) \ CPUIDLEVEL(FALSE, 85, 0x80000005, 0, 0) \ CPUIDLEVEL(FALSE, 86, 0x80000006, 0, 0) \ CPUIDLEVEL(FALSE, 87, 0x80000007, 0, 0) \ CPUIDLEVEL(TRUE, 88, 0x80000008, 0, 0) \ CPUIDLEVEL(TRUE, 8A, 0x8000000A, 0, 0) \ CPUIDLEVEL(FALSE, 819, 0x80000019, 0, 0) \ CPUIDLEVEL(FALSE, 81A, 0x8000001A, 0, 0) \ CPUIDLEVEL(FALSE, 81B, 0x8000001B, 0, 0) \ CPUIDLEVEL(FALSE, 81C, 0x8000001C, 0, 0) \ CPUIDLEVEL(FALSE, 81D, 0x8000001D, 5, 0) \ CPUIDLEVEL(FALSE, 81E, 0x8000001E, 0, 0) \ CPUIDLEVEL(TRUE, 81F, 0x8000001F, 0, 14) #define CPUID_ALL_LEVELS CPUID_CACHED_LEVELS /* Define cached CPUID levels in the form: CPUID_LEVEL_<ShortName> */ typedef enum { #define CPUIDLEVEL(t, s, v, c, h) CPUID_LEVEL_##s, CPUID_CACHED_LEVELS #undef CPUIDLEVEL CPUID_NUM_CACHED_LEVELS } CpuidCachedLevel; /* Enum to translate between shorthand name and actual CPUID level value. */ enum { #define CPUIDLEVEL(t, s, v, c, h) CPUID_LEVEL_VAL_##s = v, CPUID_ALL_LEVELS #undef CPUIDLEVEL }; /* Named feature leaves */ #define CPUID_FEATURE_INFORMATION 0x01 #define CPUID_PROCESSOR_TOPOLOGY 4 #define CPUID_MWAIT_FEATURES 5 #define CPUID_XSAVE_FEATURES 0xd #define CPUID_SGX_FEATURES 0x12 #define CPUID_PT_FEATURES 0x14 #define CPUID_HYPERVISOR_LEVEL_0 0x40000000 #define CPUID_SVM_FEATURES 0x8000000a /* * CPUID result registers */ #define CPUID_REGS \ CPUIDREG(EAX, eax) \ CPUIDREG(EBX, ebx) \ CPUIDREG(ECX, ecx) \ CPUIDREG(EDX, edx) typedef enum { #define CPUIDREG(uc, lc) CPUID_REG_##uc, CPUID_REGS #undef CPUIDREG CPUID_NUM_REGS } CpuidReg; #define CPUID_INTEL_VENDOR_STRING "GenuntelineI" #define CPUID_AMD_VENDOR_STRING "AuthcAMDenti" #define CPUID_CYRIX_VENDOR_STRING "CyriteadxIns" #define CPUID_VIA_VENDOR_STRING "CentaulsaurH" #define CPUID_HYGON_VENDOR_STRING "HygouinenGen" #define CPUID_HYPERV_HYPERVISOR_VENDOR_STRING "Microsoft Hv" #define CPUID_KVM_HYPERVISOR_VENDOR_STRING "KVMKVMKVM\0\0\0" #define CPUID_VMWARE_HYPERVISOR_VENDOR_STRING "VMwareVMware" #define CPUID_XEN_HYPERVISOR_VENDOR_STRING "XenVMMXenVMM" #define CPUID_INTEL_VENDOR_STRING_FIXED "GenuineIntel" #define CPUID_AMD_VENDOR_STRING_FIXED "AuthenticAMD" #define CPUID_CYRIX_VENDOR_STRING_FIXED "CyrixInstead" #define CPUID_VIA_VENDOR_STRING_FIXED "CentaurHauls" #define CPUID_HYGON_VENDOR_STRING_FIXED "HygonGenuine" /* * FIELD can be defined to process the CPUID information provided in the * following CPUID_FIELD_DATA macro. * * The first parameter is the CPUID level of the feature (must be defined in * CPUID_ALL_LEVELS, above). * * The second parameter is the CPUID sub-level (subleaf) of the feature. Please * make sure here the number is consistent with the "subleaf count" in * CPUIDLEVEL macro. I.e., if a feature is being added to a _new_ subleaf, * update the subleaf count above as well. * * The third parameter is the result register. * * The fourth and fifth parameters are the bit position of the field and the * width, respectively. * * The sixth is the name of the field. * * The seventh parameter specifies the monitor support characteristics for * this field. The value must be a valid CpuidFieldSupported value (omitting * CPUID_FIELD_SUPPORT_ for convenience). The meaning of those values are * described below. * * The eighth parameter specifies the first virtual hardware version that * implements the field (if 7th field is YES or ANY), or 0 (if 7th field is * NO or NA). The field's hardware version must match the version in * defaultMasks (cpuidcompat.c) if defined there, and must be less than or * equal to the version of the cpuid leaf it's in. * * The ninth parameter describes whether the feature is capable of being used * by usermode code (TRUE), or just CPL0 kernel code (FALSE). * * FLAG is defined identically to FIELD, but its accessors are more appropriate * for 1-bit flags, and compile-time asserts enforce that the size is 1 bit * wide. */ /* * CpuidFieldSupported is made up of the following values: * * NO: A feature/field that IS NOT SUPPORTED by the monitor. Even * if the host supports this feature, we will never expose it to * the guest. * * YES: A feature/field that IS SUPPORTED by the monitor. If the * host supports this feature, we will expose it to the guest. If * not, then we will not set the feature. * * ANY: A feature/field that IS ALWAYS SUPPORTED by the monitor. * Even if the host does not support the feature, the monitor can * expose the feature to the guest. As with "YES", the guest cpuid * value defaults to the host/evc cpuid value. But usually the * guest cpuid value is recomputed at power on, ignoring the default * value. * * * NA: Only legal for levels not masked/tested by default (see * above for this definition). Such fields must always be marked * as NA. * * These distinctions, when combined with the feature's CPL3 * properties can be translated into a common CPUID mask string as * follows: * * NO + CPL3 --> "R" (Reserved). We don't support the feature, * but we can't properly hide this from applications when using * direct execution or HV with apps that do try/catch/fail, so we * must still perform compatibility checks. * * NO + !CPL3 --> "0" (Masked). We can hide this from the guest. * * YES --> "H" (Host). We support the feature, so show it to the * guest if the host has the feature. * * ANY/NA --> "X" (Ignore). By default, don't perform checks for * this feature bit. Per-GOS masks may choose to set this bit in * the guest. (e.g. the APIC feature bit is always set to 1.) * * See lib/cpuidcompat/cpuidcompat.c for any possible overrides to * these defaults. */ typedef enum { CPUID_FIELD_SUPPORTED_NO, CPUID_FIELD_SUPPORTED_YES, CPUID_FIELD_SUPPORTED_ANY, CPUID_FIELD_SUPPORTED_NA, CPUID_NUM_FIELD_SUPPORTEDS } CpuidFieldSupported; /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_0 \ FIELD( 0, 0, EAX, 0, 32, NUMLEVELS, ANY, 4, FALSE) \ FIELD( 0, 0, EBX, 0, 32, VENDOR1, YES, 4, TRUE) \ FIELD( 0, 0, ECX, 0, 32, VENDOR3, YES, 4, TRUE) \ FIELD( 0, 0, EDX, 0, 32, VENDOR2, YES, 4, TRUE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_1 \ FIELD( 1, 0, EAX, 0, 4, STEPPING, ANY, 4, FALSE) \ FIELD( 1, 0, EAX, 4, 4, MODEL, ANY, 4, FALSE) \ FIELD( 1, 0, EAX, 8, 4, FAMILY, YES, 4, FALSE) \ FIELD( 1, 0, EAX, 12, 2, TYPE, ANY, 4, FALSE) \ FIELD( 1, 0, EAX, 16, 4, EXTENDED_MODEL, ANY, 4, FALSE) \ FIELD( 1, 0, EAX, 20, 8, EXTENDED_FAMILY, YES, 4, FALSE) \ FIELD( 1, 0, EBX, 0, 8, BRAND_ID, ANY, 4, FALSE) \ FIELD( 1, 0, EBX, 8, 8, CLFL_SIZE, ANY, 4, FALSE) \ FIELD( 1, 0, EBX, 16, 8, LCPU_COUNT, ANY, 4, FALSE) \ FIELD( 1, 0, EBX, 24, 8, APICID, ANY, 4, FALSE) \ FLAG( 1, 0, ECX, 0, 1, SSE3, YES, 4, TRUE) \ FLAG( 1, 0, ECX, 1, 1, PCLMULQDQ, YES, 7, TRUE) \ FLAG( 1, 0, ECX, 2, 1, DTES64, NO, 0, FALSE) \ FLAG( 1, 0, ECX, 3, 1, MWAIT, YES, 4, FALSE) \ FLAG( 1, 0, ECX, 4, 1, DSCPL, NO, 0, FALSE) \ FLAG( 1, 0, ECX, 5, 1, VMX, YES, 4, FALSE) \ FLAG( 1, 0, ECX, 6, 1, SMX, YES, 15, FALSE) \ FLAG( 1, 0, ECX, 7, 1, EIST, NO, 0, FALSE) \ FLAG( 1, 0, ECX, 8, 1, TM2, NO, 0, FALSE) \ FLAG( 1, 0, ECX, 9, 1, SSSE3, YES, 4, TRUE) \ FLAG( 1, 0, ECX, 10, 1, CNXTID, NO, 0, FALSE) \ FLAG( 1, 0, ECX, 11, 1, SDBG, NO, 0, FALSE) \ FLAG( 1, 0, ECX, 12, 1, FMA, YES, 8, TRUE) \ FLAG( 1, 0, ECX, 13, 1, CMPXCHG16B, YES, 4, TRUE) \ FLAG( 1, 0, ECX, 14, 1, xTPR, NO, 0, FALSE) \ FLAG( 1, 0, ECX, 15, 1, PDCM, NO, 0, FALSE) \ FLAG( 1, 0, ECX, 17, 1, PCID, YES, 8, FALSE) \ FLAG( 1, 0, ECX, 18, 1, DCA, NO, 0, FALSE) \ FLAG( 1, 0, ECX, 19, 1, SSE41, YES, 4, TRUE) \ FLAG( 1, 0, ECX, 20, 1, SSE42, YES, 4, TRUE) \ FLAG( 1, 0, ECX, 21, 1, x2APIC, ANY, 9, FALSE) \ FLAG( 1, 0, ECX, 22, 1, MOVBE, YES, 7, TRUE) \ FLAG( 1, 0, ECX, 23, 1, POPCNT, YES, 4, TRUE) \ FLAG( 1, 0, ECX, 24, 1, TSC_DEADLINE, ANY, 11, FALSE) \ FLAG( 1, 0, ECX, 25, 1, AES, YES, 7, TRUE) \ FLAG( 1, 0, ECX, 26, 1, XSAVE, YES, 8, FALSE) \ FLAG( 1, 0, ECX, 27, 1, OSXSAVE, ANY, 8, FALSE) \ FLAG( 1, 0, ECX, 28, 1, AVX, YES, 8, FALSE) \ FLAG( 1, 0, ECX, 29, 1, F16C, YES, 9, TRUE) \ FLAG( 1, 0, ECX, 30, 1, RDRAND, YES, 9, TRUE) \ FLAG( 1, 0, ECX, 31, 1, HYPERVISOR, ANY, 4, TRUE) \ FLAG( 1, 0, EDX, 0, 1, FPU, YES, 4, TRUE) \ FLAG( 1, 0, EDX, 1, 1, VME, YES, 4, FALSE) \ FLAG( 1, 0, EDX, 2, 1, DE, YES, 4, FALSE) \ FLAG( 1, 0, EDX, 3, 1, PSE, YES, 4, FALSE) \ FLAG( 1, 0, EDX, 4, 1, TSC, YES, 4, TRUE) \ FLAG( 1, 0, EDX, 5, 1, MSR, YES, 4, FALSE) \ FLAG( 1, 0, EDX, 6, 1, PAE, YES, 4, FALSE) \ FLAG( 1, 0, EDX, 7, 1, MCE, YES, 4, FALSE) \ FLAG( 1, 0, EDX, 8, 1, CX8, YES, 4, TRUE) \ FLAG( 1, 0, EDX, 9, 1, APIC, ANY, 4, FALSE) \ FLAG( 1, 0, EDX, 11, 1, SEP, YES, 4, TRUE) \ FLAG( 1, 0, EDX, 12, 1, MTRR, YES, 4, FALSE) \ FLAG( 1, 0, EDX, 13, 1, PGE, YES, 4, FALSE) \ FLAG( 1, 0, EDX, 14, 1, MCA, YES, 4, FALSE) \ FLAG( 1, 0, EDX, 15, 1, CMOV, YES, 4, TRUE) \ FLAG( 1, 0, EDX, 16, 1, PAT, YES, 4, FALSE) \ FLAG( 1, 0, EDX, 17, 1, PSE36, YES, 4, FALSE) \ FLAG( 1, 0, EDX, 18, 1, PSN, YES, 4, FALSE) \ FLAG( 1, 0, EDX, 19, 1, CLFSH, YES, 4, TRUE) \ FLAG( 1, 0, EDX, 21, 1, DS, YES, 4, FALSE) \ FLAG( 1, 0, EDX, 22, 1, ACPI, ANY, 4, FALSE) \ FLAG( 1, 0, EDX, 23, 1, MMX, YES, 4, TRUE) \ FLAG( 1, 0, EDX, 24, 1, FXSR, YES, 4, TRUE) \ FLAG( 1, 0, EDX, 25, 1, SSE, YES, 4, TRUE) \ FLAG( 1, 0, EDX, 26, 1, SSE2, YES, 4, TRUE) \ FLAG( 1, 0, EDX, 27, 1, SS, YES, 4, FALSE) \ FLAG( 1, 0, EDX, 28, 1, HTT, ANY, 7, FALSE) \ FLAG( 1, 0, EDX, 29, 1, TM, NO, 0, FALSE) \ FLAG( 1, 0, EDX, 30, 1, IA64, NO, 0, FALSE) \ FLAG( 1, 0, EDX, 31, 1, PBE, NO, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_2 \ FIELD( 2, 0, EAX, 0, 8, LEAF2_COUNT, NA, 0, FALSE) \ FIELD( 2, 0, EAX, 8, 8, LEAF2_CACHE1, NA, 0, FALSE) \ FIELD( 2, 0, EAX, 16, 8, LEAF2_CACHE2, NA, 0, FALSE) \ FIELD( 2, 0, EAX, 24, 8, LEAF2_CACHE3, NA, 0, FALSE) \ FIELD( 2, 0, EBX, 0, 8, LEAF2_CACHE4, NA, 0, FALSE) \ FIELD( 2, 0, EBX, 8, 8, LEAF2_CACHE5, NA, 0, FALSE) \ FIELD( 2, 0, EBX, 16, 8, LEAF2_CACHE6, NA, 0, FALSE) \ FIELD( 2, 0, EBX, 24, 8, LEAF2_CACHE7, NA, 0, FALSE) \ FIELD( 2, 0, ECX, 0, 8, LEAF2_CACHE8, NA, 0, FALSE) \ FIELD( 2, 0, ECX, 8, 8, LEAF2_CACHE9, NA, 0, FALSE) \ FIELD( 2, 0, ECX, 16, 8, LEAF2_CACHE10, NA, 0, FALSE) \ FIELD( 2, 0, ECX, 24, 8, LEAF2_CACHE11, NA, 0, FALSE) \ FIELD( 2, 0, EDX, 0, 8, LEAF2_CACHE12, NA, 0, FALSE) \ FIELD( 2, 0, EDX, 8, 8, LEAF2_CACHE13, NA, 0, FALSE) \ FIELD( 2, 0, EDX, 16, 8, LEAF2_CACHE14, NA, 0, FALSE) \ FIELD( 2, 0, EDX, 24, 8, LEAF2_CACHE15, NA, 0, FALSE) \ /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_4 \ FIELD( 4, 0, EAX, 0, 5, LEAF4_CACHE_TYPE, NA, 0, FALSE) \ FIELD( 4, 0, EAX, 5, 3, LEAF4_CACHE_LEVEL, NA, 0, FALSE) \ FLAG( 4, 0, EAX, 8, 1, LEAF4_CACHE_SELF_INIT, NA, 0, FALSE) \ FLAG( 4, 0, EAX, 9, 1, LEAF4_CACHE_FULLY_ASSOC, NA, 0, FALSE) \ FIELD( 4, 0, EAX, 14, 12, LEAF4_CACHE_NUMHT_SHARING, NA, 0, FALSE) \ FIELD( 4, 0, EAX, 26, 6, LEAF4_CORE_COUNT, NA, 0, FALSE) \ FIELD( 4, 0, EBX, 0, 12, LEAF4_CACHE_LINE, NA, 0, FALSE) \ FIELD( 4, 0, EBX, 12, 10, LEAF4_CACHE_PART, NA, 0, FALSE) \ FIELD( 4, 0, EBX, 22, 10, LEAF4_CACHE_WAYS, NA, 0, FALSE) \ FIELD( 4, 0, ECX, 0, 32, LEAF4_CACHE_SETS, NA, 0, FALSE) \ FLAG( 4, 0, EDX, 0, 1, LEAF4_CACHE_WBINVD_NOT_GUARANTEED, NA, 0, FALSE) \ FLAG( 4, 0, EDX, 1, 1, LEAF4_CACHE_IS_INCLUSIVE, NA, 0, FALSE) \ FLAG( 4, 0, EDX, 2, 1, LEAF4_CACHE_COMPLEX_INDEXING, NA, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_5 \ FIELD( 5, 0, EAX, 0, 16, MWAIT_MIN_SIZE, NA, 0, FALSE) \ FIELD( 5, 0, EBX, 0, 16, MWAIT_MAX_SIZE, NA, 0, FALSE) \ FLAG( 5, 0, ECX, 0, 1, MWAIT_EXTENSIONS, NA, 0, FALSE) \ FLAG( 5, 0, ECX, 1, 1, MWAIT_INTR_BREAK, NA, 0, FALSE) \ FIELD( 5, 0, EDX, 0, 4, MWAIT_C0_SUBSTATE, NA, 0, FALSE) \ FIELD( 5, 0, EDX, 4, 4, MWAIT_C1_SUBSTATE, NA, 0, FALSE) \ FIELD( 5, 0, EDX, 8, 4, MWAIT_C2_SUBSTATE, NA, 0, FALSE) \ FIELD( 5, 0, EDX, 12, 4, MWAIT_C3_SUBSTATE, NA, 0, FALSE) \ FIELD( 5, 0, EDX, 16, 4, MWAIT_C4_SUBSTATE, NA, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_6 \ FLAG( 6, 0, EAX, 0, 1, THERMAL_SENSOR, NO, 0, FALSE) \ FLAG( 6, 0, EAX, 1, 1, TURBO_MODE, NO, 0, FALSE) \ FLAG( 6, 0, EAX, 2, 1, APIC_INVARIANT, ANY, 13, FALSE) \ FLAG( 6, 0, EAX, 4, 1, PLN, NO, 0, FALSE) \ FLAG( 6, 0, EAX, 5, 1, ECMD, NO, 0, FALSE) \ FLAG( 6, 0, EAX, 6, 1, PTM, NO, 0, FALSE) \ FLAG( 6, 0, EAX, 7, 1, HWP, NO, 0, FALSE) \ FLAG( 6, 0, EAX, 8, 1, HWP_NOTIFICATION, NO, 0, FALSE) \ FLAG( 6, 0, EAX, 9, 1, HWP_ACTIVITY_WINDOW, NO, 0, FALSE) \ FLAG( 6, 0, EAX, 10, 1, HWP_ENERGY_PERFORMANCE_PREFERENCE, NO, 0, FALSE) \ FLAG( 6, 0, EAX, 11, 1, HWP_PACKAGE_LEVEL_REQUEST, NO, 0, FALSE) \ FLAG( 6, 0, EAX, 13, 1, HDC, NO, 0, FALSE) \ FIELD( 6, 0, EBX, 0, 4, NUM_INTR_THRESHOLDS, NO, 0, FALSE) \ FLAG( 6, 0, ECX, 0, 1, HW_COORD_FEEDBACK, NO, 0, FALSE) \ FLAG( 6, 0, ECX, 1, 1, ACNT2, ANY, 13, FALSE) \ FLAG( 6, 0, ECX, 3, 1, ENERGY_PERF_BIAS, NO, 0, FALSE) #define CPUID_7_EDX_28 \ FLAG( 7, 0, EDX, 28, 1, LEVEL7EDX_RSVD1, NO, 0, FALSE) #define CPUID_7_EDX_31 \ FLAG( 7, 0, EDX, 31, 1, LEVEL7EDX_RSVD2, NO, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_7 \ FLAG( 7, 0, EBX, 0, 1, FSGSBASE, YES, 9, FALSE) \ FLAG( 7, 0, EBX, 1, 1, TSC_ADJUST, ANY, 11, FALSE) \ FLAG( 7, 0, EBX, 2, 1, SGX, YES, 16, FALSE) \ FLAG( 7, 0, EBX, 3, 1, BMI1, YES, 9, TRUE) \ FLAG( 7, 0, EBX, 4, 1, HLE, YES, 11, TRUE) \ FLAG( 7, 0, EBX, 5, 1, AVX2, YES, 11, TRUE) \ FLAG( 7, 0, EBX, 6, 1, FDP_EXCPTN_ONLY, ANY, 13, TRUE) \ FLAG( 7, 0, EBX, 7, 1, SMEP, YES, 9, FALSE) \ FLAG( 7, 0, EBX, 8, 1, BMI2, YES, 11, TRUE) \ FLAG( 7, 0, EBX, 9, 1, ENFSTRG, YES, 9, FALSE) \ FLAG( 7, 0, EBX, 10, 1, INVPCID, YES, 11, FALSE) \ FLAG( 7, 0, EBX, 11, 1, RTM, YES, 11, TRUE) \ FLAG( 7, 0, EBX, 12, 1, PQM, NO, 0, FALSE) \ FLAG( 7, 0, EBX, 13, 1, FP_SEGMENT_ZERO, ANY, 11, TRUE) \ FLAG( 7, 0, EBX, 14, 1, MPX, YES, 13, TRUE) \ FLAG( 7, 0, EBX, 15, 1, PQE, NO, 0, FALSE) \ FLAG( 7, 0, EBX, 16, 1, AVX512F, YES, 13, TRUE) \ FLAG( 7, 0, EBX, 17, 1, AVX512DQ, YES, 13, TRUE) \ FLAG( 7, 0, EBX, 18, 1, RDSEED, YES, 11, TRUE) \ FLAG( 7, 0, EBX, 19, 1, ADX, YES, 11, TRUE) \ FLAG( 7, 0, EBX, 20, 1, SMAP, YES, 11, FALSE) \ FLAG( 7, 0, EBX, 21, 1, AVX512IFMA, YES, 16, TRUE) \ FLAG( 7, 0, EBX, 23, 1, CLFLUSHOPT, YES, 13, TRUE) \ FLAG( 7, 0, EBX, 24, 1, CLWB, YES, 13, TRUE) \ FLAG( 7, 0, EBX, 25, 1, PT, YES, 16, FALSE) \ FLAG( 7, 0, EBX, 26, 1, AVX512PF, YES, 13, TRUE) \ FLAG( 7, 0, EBX, 27, 1, AVX512ER, YES, 13, TRUE) \ FLAG( 7, 0, EBX, 28, 1, AVX512CD, YES, 13, TRUE) \ FLAG( 7, 0, EBX, 29, 1, SHA, YES, 14, TRUE) \ FLAG( 7, 0, EBX, 30, 1, AVX512BW, YES, 13, TRUE) \ FLAG( 7, 0, EBX, 31, 1, AVX512VL, YES, 13, TRUE) \ FLAG( 7, 0, ECX, 0, 1, PREFETCHWT1, YES, 13, TRUE) \ FLAG( 7, 0, ECX, 1, 1, AVX512VBMI, YES, 16, TRUE) \ FLAG( 7, 0, ECX, 2, 1, UMIP, NO, 0, FALSE) \ FLAG( 7, 0, ECX, 3, 1, PKU, YES, 13, TRUE) \ FLAG( 7, 0, ECX, 4, 1, OSPKE, ANY, 13, TRUE) \ FLAG( 7, 0, ECX, 6, 1, AVX512VBMI2, NO, 0, TRUE) \ FLAG( 7, 0, ECX, 8, 1, GFNI, NO, 0, TRUE) \ FLAG( 7, 0, ECX, 9, 1, VAES, NO, 0, TRUE) \ FLAG( 7, 0, ECX, 10, 1, VPCLMULQDQ, NO, 0, TRUE) \ FLAG( 7, 0, ECX, 11, 1, AVX512VNNI, NO, 0, TRUE) \ FLAG( 7, 0, ECX, 12, 1, AVX512BITALG, NO, 0, TRUE) \ FLAG( 7, 0, ECX, 14, 1, AVX512VPOPCNTDQ, YES, 15, TRUE) \ FLAG( 7, 0, ECX, 16, 1, VA57, NO, 0, TRUE) \ FIELD( 7, 0, ECX, 17, 5, MAWA, NO, 0, TRUE) \ FLAG( 7, 0, ECX, 22, 1, RDPID, NO, 0, TRUE) \ FLAG( 7, 0, ECX, 30, 1, SGX_LC, YES, 16, FALSE) \ FLAG( 7, 0, EDX, 2, 1, AVX512QVNNIW, YES, 15, TRUE) \ FLAG( 7, 0, EDX, 3, 1, AVX512QFMAPS, YES, 15, TRUE) \ FLAG( 7, 0, EDX, 26, 1, IBRSIBPB, ANY, 9, FALSE) \ FLAG( 7, 0, EDX, 27, 1, STIBP, YES, 9, FALSE) \ CPUID_7_EDX_28 \ FLAG( 7, 0, EDX, 29, 1, ARCH_CAPABILITIES, ANY, 9, FALSE) \ CPUID_7_EDX_31 /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_A \ FIELD( A, 0, EAX, 0, 8, PMC_VERSION, NA, 0, FALSE) \ FIELD( A, 0, EAX, 8, 8, PMC_NUM_GEN, NA, 0, FALSE) \ FIELD( A, 0, EAX, 16, 8, PMC_WIDTH_GEN, NA, 0, FALSE) \ FIELD( A, 0, EAX, 24, 8, PMC_EBX_LENGTH, NA, 0, FALSE) \ FLAG( A, 0, EBX, 0, 1, PMC_CORE_CYCLES, NA, 0, FALSE) \ FLAG( A, 0, EBX, 1, 1, PMC_INSTR_RETIRED, NA, 0, FALSE) \ FLAG( A, 0, EBX, 2, 1, PMC_REF_CYCLES, NA, 0, FALSE) \ FLAG( A, 0, EBX, 3, 1, PMC_LAST_LVL_CREF, NA, 0, FALSE) \ FLAG( A, 0, EBX, 4, 1, PMC_LAST_LVL_CMISS, NA, 0, FALSE) \ FLAG( A, 0, EBX, 5, 1, PMC_BR_INST_RETIRED, NA, 0, FALSE) \ FLAG( A, 0, EBX, 6, 1, PMC_BR_MISS_RETIRED, NA, 0, FALSE) \ FIELD( A, 0, EDX, 0, 5, PMC_NUM_FIXED, NA, 0, FALSE) \ FIELD( A, 0, EDX, 5, 8, PMC_WIDTH_FIXED, NA, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_B \ FIELD( B, 0, EAX, 0, 5, TOPOLOGY_MASK_WIDTH, NA, 0, FALSE) \ FIELD( B, 0, EBX, 0, 16, TOPOLOGY_CPUS_SHARING_LEVEL, NA, 0, FALSE) \ FIELD( B, 0, ECX, 0, 8, TOPOLOGY_LEVEL_NUMBER, NA, 0, FALSE) \ FIELD( B, 0, ECX, 8, 8, TOPOLOGY_LEVEL_TYPE, NA, 0, FALSE) \ FIELD( B, 0, EDX, 0, 32, TOPOLOGY_X2APIC_ID, NA, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_D \ FLAG( D, 0, EAX, 0, 1, XCR0_MASTER_LEGACY_FP, YES, 8, FALSE) \ FLAG( D, 0, EAX, 1, 1, XCR0_MASTER_SSE, YES, 8, FALSE) \ FLAG( D, 0, EAX, 2, 1, XCR0_MASTER_YMM_H, YES, 8, FALSE) \ FLAG( D, 0, EAX, 3, 1, XCR0_MASTER_BNDREGS, YES, 13, FALSE) \ FLAG( D, 0, EAX, 4, 1, XCR0_MASTER_BNDCSR, YES, 13, FALSE) \ FLAG( D, 0, EAX, 5, 1, XCR0_MASTER_OPMASK, YES, 13, FALSE) \ FLAG( D, 0, EAX, 6, 1, XCR0_MASTER_ZMM_H, YES, 13, FALSE) \ FLAG( D, 0, EAX, 7, 1, XCR0_MASTER_HI16_ZMM, YES, 13, FALSE) \ FLAG( D, 0, EAX, 8, 1, XCR0_MASTER_XSS, NO, 0, FALSE) \ FLAG( D, 0, EAX, 9, 1, XCR0_MASTER_PKRU, YES, 13, FALSE) \ FIELD( D, 0, EAX, 10,22, XCR0_MASTER_LOWER, NO, 0, FALSE) \ FIELD( D, 0, EBX, 0, 32, XSAVE_ENABLED_SIZE, ANY, 8, FALSE) \ FIELD( D, 0, ECX, 0, 32, XSAVE_MAX_SIZE, YES, 8, FALSE) \ FIELD( D, 0, EDX, 0, 29, XCR0_MASTER_UPPER, NO, 0, FALSE) \ FLAG( D, 0, EDX, 30, 1, XCR0_MASTER_LWP, NO, 0, FALSE) \ FLAG( D, 0, EDX, 31, 1, XCR0_MASTER_EXTENDED_XSAVE, NO, 0, FALSE) \ FLAG( D, 1, EAX, 0, 1, XSAVEOPT, YES, 11, FALSE) \ FLAG( D, 1, EAX, 1, 1, XSAVEC, YES, 13, FALSE) \ FLAG( D, 1, EAX, 2, 1, XGETBV_ECX1, NO, 0, FALSE) \ FLAG( D, 1, EAX, 3, 1, XSAVES, YES, 13, FALSE) \ FIELD( D, 1, EBX, 0, 32, XSAVES_ENABLED_SIZE, ANY, 13, FALSE) \ FIELD( D, 1, ECX, 0, 7, XSS_XCR0_USED0, NO, 0, FALSE) \ FLAG( D, 1, ECX, 8, 1, XSS_PT, NO, 0, FALSE) \ FIELD( D, 1, ECX, 9, 1, XSS_XCR0_USED1, NO, 0, FALSE) \ FIELD( D, 1, ECX, 10,22, XSS_RSVD0, NO, 0, FALSE) \ FIELD( D, 1, EDX, 0, 32, XSS_RSVD1, NO, 0, FALSE) \ FIELD( D, 2, EAX, 0, 32, XSAVE_YMM_SIZE, YES, 9, FALSE) \ FIELD( D, 2, EBX, 0, 32, XSAVE_YMM_OFFSET, YES, 9, FALSE) \ FLAG( D, 2, ECX, 0, 1, XSAVE_YMM_SUP_BY_XSS, NO, 0, FALSE) \ FLAG( D, 2, ECX, 1, 1, XSAVE_YMM_ALIGN, YES, 13, FALSE) \ FIELD( D, 2, ECX, 2, 30, XSAVE_YMM_RSVD1, NO, 0, FALSE) \ FIELD( D, 2, EDX, 0, 32, XSAVE_YMM_RSVD2, NO, 0, FALSE) \ FIELD( D, 3, EAX, 0, 32, XSAVE_BNDREGS_SIZE, YES, 13, FALSE) \ FIELD( D, 3, EBX, 0, 32, XSAVE_BNDREGS_OFFSET, YES, 13, FALSE) \ FLAG( D, 3, ECX, 0, 1, XSAVE_BNDREGS_SUP_BY_XSS, NO, 0, FALSE) \ FLAG( D, 3, ECX, 1, 1, XSAVE_BNDREGS_ALIGN, YES, 13, FALSE) \ FIELD( D, 3, ECX, 2, 30, XSAVE_BNDREGS_RSVD1, NO, 0, FALSE) \ FIELD( D, 3, EDX, 0, 32, XSAVE_BNDREGS_RSVD2, NO, 0, FALSE) \ FIELD( D, 4, EAX, 0, 32, XSAVE_BNDCSR_SIZE, YES, 13, FALSE) \ FIELD( D, 4, EBX, 0, 32, XSAVE_BNDCSR_OFFSET, YES, 13, FALSE) \ FLAG( D, 4, ECX, 0, 1, XSAVE_BNDCSR_SUP_BY_XSS, NO, 0, FALSE) \ FLAG( D, 4, ECX, 1, 1, XSAVE_BNDCSR_ALIGN, YES, 13, FALSE) \ FIELD( D, 4, ECX, 2, 30, XSAVE_BNDCSR_RSVD1, NO, 0, FALSE) \ FIELD( D, 4, EDX, 0, 32, XSAVE_BNDCSR_RSVD2, NO, 0, FALSE) \ FIELD( D, 5, EAX, 0, 32, XSAVE_OPMASK_SIZE, YES, 13, FALSE) \ FIELD( D, 5, EBX, 0, 32, XSAVE_OPMASK_OFFSET, YES, 13, FALSE) \ FLAG( D, 5, ECX, 0, 1, XSAVE_OPMASK_SUP_BY_XSS, NO, 0, FALSE) \ FLAG( D, 5, ECX, 1, 1, XSAVE_OPMASK_ALIGN, YES, 13, FALSE) \ FIELD( D, 5, ECX, 2, 30, XSAVE_OPMASK_RSVD1, NO, 0, FALSE) \ FIELD( D, 5, EDX, 0, 32, XSAVE_OPMASK_RSVD2, NO, 0, FALSE) \ FIELD( D, 6, EAX, 0, 32, XSAVE_ZMM_H_SIZE, YES, 13, FALSE) \ FIELD( D, 6, EBX, 0, 32, XSAVE_ZMM_H_OFFSET, YES, 13, FALSE) \ FLAG( D, 6, ECX, 0, 1, XSAVE_ZMM_H_SUP_BY_XSS, NO, 0, FALSE) \ FLAG( D, 6, ECX, 1, 1, XSAVE_ZMM_H_ALIGN, YES, 13, FALSE) \ FIELD( D, 6, ECX, 2, 30, XSAVE_ZMM_H_RSVD1, NO, 0, FALSE) \ FIELD( D, 6, EDX, 0, 32, XSAVE_ZMM_H_RSVD2, NO, 0, FALSE) \ FIELD( D, 7, EAX, 0, 32, XSAVE_HI16_ZMM_SIZE, YES, 13, FALSE) \ FIELD( D, 7, EBX, 0, 32, XSAVE_HI16_ZMM_OFFSET, YES, 13, FALSE) \ FLAG( D, 7, ECX, 0, 1, XSAVE_HI16_ZMM_SUP_BY_XSS, NO, 0, FALSE) \ FLAG( D, 7, ECX, 1, 1, XSAVE_HI16_ZMM_ALIGN, YES, 13, FALSE) \ FIELD( D, 7, ECX, 2, 30, XSAVE_HI16_ZMM_RSVD1, NO, 0, FALSE) \ FIELD( D, 7, EDX, 0, 32, XSAVE_HI16_ZMM_RSVD2, NO, 0, FALSE) \ FIELD( D, 8, EAX, 0, 32, XSAVE_PT_STATE_SIZE, NO, 0, FALSE) \ FIELD( D, 8, EBX, 0, 32, XSAVE_PT_STATE_OFFSET, NO, 0, FALSE) \ FLAG( D, 8, ECX, 0, 1, XSAVE_PT_STATE_SUP_BY_XSS, NO, 0, FALSE) \ FLAG( D, 8, ECX, 1, 1, XSAVE_PT_STATE_ALIGN, NO, 0, FALSE) \ FIELD( D, 8, ECX, 2, 30, XSAVE_PT_STATE_RSVD1, NO, 0, FALSE) \ FIELD( D, 8, EDX, 0, 32, XSAVE_PT_STATE_RSVD2, NO, 0, FALSE) \ FIELD( D, 9, EAX, 0, 32, XSAVE_PKRU_SIZE, YES, 13, FALSE) \ FIELD( D, 9, EBX, 0, 32, XSAVE_PKRU_OFFSET, YES, 13, FALSE) \ FLAG( D, 9, ECX, 0, 1, XSAVE_PKRU_SUP_BY_XSS, NO, 0, FALSE) \ FLAG( D, 9, ECX, 1, 1, XSAVE_PKRU_ALIGN, YES, 13, FALSE) \ FIELD( D, 9, ECX, 2, 30, XSAVE_PKRU_RSVD1, NO, 0, FALSE) \ FIELD( D, 9, EDX, 0, 32, XSAVE_PKRU_RSVD2, NO, 0, FALSE) \ FIELD( D, 62, EAX, 0, 32, XSAVE_LWP_SIZE, NO, 0, FALSE) \ FIELD( D, 62, EBX, 0, 32, XSAVE_LWP_OFFSET, NO, 0, FALSE) \ FIELD( D, 62, ECX, 0, 32, XSAVE_LWP_RSVD1, NO, 0, FALSE) \ FIELD( D, 62, EDX, 0, 32, XSAVE_LWP_RSVD2, NO, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_F \ FIELD( F, 0, EBX, 0, 32, PQM_MAX_RMID, NO, 0, FALSE) \ FLAG( F, 0, EDX, 1, 1, PQM_CMT_SUPPORT, NO, 0, FALSE) \ FIELD( F, 1, EBX, 0, 32, PQM_CMT_CONV, NO, 0, FALSE) \ FIELD( F, 1, ECX, 0, 32, PQM_CMT_NUM_RMID, NO, 0, FALSE) \ FLAG( F, 1, EDX, 0, 1, PQM_CMT_OCCUPANCY, NO, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_10 \ FLAG( 10, 0, EBX, 1, 1, L3_QOS_ENFORCEMENT, NO, 0, FALSE) \ FIELD( 10, 1, EAX, 0, 4, RESID_CAPACITY_MASK_LENGTH, NO, 0, FALSE) \ FIELD( 10, 1, EBX, 0, 32, ISOLATION_UNIT_MAP, NO, 0, FALSE) \ FLAG( 10, 1, ECX, 1, 1, INFREQUENT_COS_UPDATE, NO, 0, FALSE) \ FLAG( 10, 1, ECX, 2, 1, CODE_AND_DATA_PRIORITIZATION, NO, 0, FALSE) \ FIELD( 10, 1, EDX, 0, 16, MAX_COS_NUMBER, NO, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_12 \ FLAG( 12, 0, EAX, 0, 1, SGX1, YES, 16, FALSE) \ FLAG( 12, 0, EAX, 1, 1, SGX2, NO, 0, FALSE) \ FLAG( 12, 0, EBX, 0, 1, SGX_MISCSELECT_EXINFO, YES, 16, FALSE) \ FIELD( 12, 0, EBX, 1, 31, SGX_MISCSELECT_RSVD, NO, 0, FALSE) \ FIELD( 12, 0, EDX, 0, 8, MAX_ENCLAVE_SIZE_NOT64, YES, 16, FALSE) \ FIELD( 12, 0, EDX, 8, 8, MAX_ENCLAVE_SIZE_64, YES, 16, FALSE) \ FIELD( 12, 1, EAX, 0, 32, SECS_ATTRIBUTES0, YES, 16, FALSE) \ FIELD( 12, 1, EBX, 0, 32, SECS_ATTRIBUTES1, YES, 16, FALSE) \ FIELD( 12, 1, ECX, 0, 32, SECS_ATTRIBUTES2, YES, 16, FALSE) \ FIELD( 12, 1, EDX, 0, 32, SECS_ATTRIBUTES3, YES, 16, FALSE) \ FIELD( 12, 2, EAX, 0, 15, EPC00_VALID, YES, 16, FALSE) \ FIELD( 12, 2, EAX, 12, 20, EPC00_BASE_LOW, YES, 16, FALSE) \ FIELD( 12, 2, EBX, 0, 20, EPC00_BASE_HIGH, YES, 16, FALSE) \ FIELD( 12, 2, ECX, 0, 15, EPC00_PROTECTED, YES, 16, FALSE) \ FIELD( 12, 2, ECX, 12, 20, EPC00_SIZE_LOW, YES, 16, FALSE) \ FIELD( 12, 2, EDX, 0, 20, EPC00_SIZE_HIGH, YES, 16, FALSE) \ FIELD( 12, 3, EAX, 0, 4, EPC01_VALID, NO, 0, FALSE) \ FIELD( 12, 3, EAX, 12, 20, EPC01_BASE_LOW, NO, 0, FALSE) \ FIELD( 12, 3, EBX, 0, 20, EPC01_BASE_HIGH, NO, 0, FALSE) \ FIELD( 12, 3, ECX, 0, 4, EPC01_PROTECTED, NO, 0, FALSE) \ FIELD( 12, 3, ECX, 12, 20, EPC01_SIZE_LOW, NO, 0, FALSE) \ FIELD( 12, 3, EDX, 0, 20, EPC01_SIZE_HIGH, NO, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_14 \ FIELD( 14, 0, EAX, 0, 32, MAX_PT_SUB_LEAF, YES, 16, FALSE) \ FLAG( 14, 0, EBX, 0, 1, CR3FTR_AND_MATCHMSR_AVAILABLE, YES, 16, FALSE) \ FLAG( 14, 0, EBX, 1, 1, PSB_AND_CYCLE_ACCURATE_MODE, YES, 16, FALSE) \ FLAG( 14, 0, EBX, 2, 1, IP_TRACESTOP_FTR_PTMSR_PERSIST, YES, 16, FALSE) \ FLAG( 14, 0, EBX, 3, 1, MTC_PKT_GENERATION_SUPPORTED, YES, 16, FALSE) \ FLAG( 14, 0, ECX, 0, 1, TOPA_OUTPUT_SUPPORTED, YES, 16, FALSE) \ FLAG( 14, 0, ECX, 1, 1, TOPA_ALLOW_MULTIPLE_ENTRIES, YES, 16, FALSE) \ FLAG( 14, 0, ECX, 2, 1, SINGLE_RANGE_OUTPUT_SCHEME, YES, 16, FALSE) \ FLAG( 14, 0, ECX, 3, 1, TRACE_TRANSPORT_SUBSYSTEM, NO, 0, FALSE) \ FLAG( 14, 0, ECX, 31, 1, LIP_PRESENT_FOR_IP_PAYLOADS, YES, 16, FALSE) \ FIELD( 14, 1, EAX, 0, 2, NUM_ADDR_RANGE_FOR_FILTERING, YES, 16, FALSE) \ FIELD( 14, 1, EAX, 16, 16, SUPPORTED_MTC_ENCODINGS, YES, 16, FALSE) \ FIELD( 14, 1, EBX, 0, 16, SUPPORTED_CYCLE_THRESHOLD_ENCODINGS, YES,16,FALSE) \ FIELD( 14, 1, EBX, 16, 16, SUPPORTED_PSB_FREQ_ENCODINGS, YES, 16, FALSE) \ /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_15 \ FIELD( 15, 0, EAX, 0, 32, DENOM_TSC_TO_CORE_CRYSTAL_CLK, NO, 0, FALSE) \ FIELD( 15, 0, EBX, 0, 32, NUMER_TSC_TO_CORE_CRYSTAL_CLK, NO, 0, FALSE) \ /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_16 \ FIELD( 16, 0, EAX, 0, 16, PROC_BASE_FREQ, NO, 0, FALSE) \ FIELD( 16, 0, EBX, 0, 16, PROC_MIN_FREQ, NO, 0, FALSE) \ FIELD( 16, 0, ECX, 0, 16, BUS_FREQ, NO, 0, FALSE) \ /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_17 \ FIELD( 17, 0, EAX, 0, 31, MAX_SOCID_INDEX, NO, 0, FALSE) \ FIELD( 17, 0, EBX, 0, 16, SOC_VENDOR_ID, NO, 0, FALSE) \ FIELD( 17, 0, EBX, 16, 1, SOC_INDUSTRY_STD, NO, 0, FALSE) \ FIELD( 17, 0, ECX, 0, 31, SOC_PROJECT_ID, NO, 0, FALSE) \ FIELD( 17, 0, EDX, 0, 31, SOC_STEPPING_ID, NO, 0, FALSE) \ FIELD( 17, 1, EAX, 0, 32, SOC_VENDOR_BRAND_STRING_1_0, NO, 0, FALSE) \ FIELD( 17, 1, EBX, 0, 32, SOC_VENDOR_BRAND_STRING_1_1, NO, 0, FALSE) \ FIELD( 17, 1, ECX, 0, 32, SOC_VENDOR_BRAND_STRING_1_2, NO, 0, FALSE) \ FIELD( 17, 1, EDX, 0, 32, SOC_VENDOR_BRAND_STRING_1_3, NO, 0, FALSE) \ FIELD( 17, 2, EAX, 0, 32, SOC_VENDOR_BRAND_STRING_2_0, NO, 0, FALSE) \ FIELD( 17, 2, EBX, 0, 32, SOC_VENDOR_BRAND_STRING_2_1, NO, 0, FALSE) \ FIELD( 17, 2, ECX, 0, 32, SOC_VENDOR_BRAND_STRING_2_2, NO, 0, FALSE) \ FIELD( 17, 2, EDX, 0, 32, SOC_VENDOR_BRAND_STRING_2_3, NO, 0, FALSE) \ FIELD( 17, 3, EAX, 0, 32, SOC_VENDOR_BRAND_STRING_3_0, NO, 0, FALSE) \ FIELD( 17, 3, EBX, 0, 32, SOC_VENDOR_BRAND_STRING_3_1, NO, 0, FALSE) \ FIELD( 17, 3, ECX, 0, 32, SOC_VENDOR_BRAND_STRING_3_2, NO, 0, FALSE) \ FIELD( 17, 3, EDX, 0, 32, SOC_VENDOR_BRAND_STRING_3_3, NO, 0, FALSE) \ /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_400 \ FIELD(400, 0, EAX, 0, 32, MAX_HYP_LEVEL, NA, 0, FALSE) \ FIELD(400, 0, EBX, 0, 32, HYPERVISOR_VENDOR0, NA, 0, FALSE) \ FIELD(400, 0, ECX, 0, 32, HYPERVISOR_VENDOR1, NA, 0, FALSE) \ FIELD(400, 0, EDX, 0, 32, HYPERVISOR_VENDOR2, NA, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_401 \ FIELD(401, 0, EAX, 0, 32, HV_INTERFACE_SIGNATURE, NA, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_402 \ FIELD(402, 0, EAX, 0, 32, BUILD_NUMBER, NA, 0, FALSE) \ FIELD(402, 0, EBX, 0, 16, MINOR_VERSION, NA, 0, FALSE) \ FIELD(402, 0, EBX, 16, 16, MAJOR_VERSION, NA, 0, FALSE) \ FIELD(402, 0, ECX, 0, 32, SERVICE_PACK, NA, 0, FALSE) \ FIELD(402, 0, EDX, 0, 24, SERVICE_NUMBER, NA, 0, FALSE) \ FIELD(402, 0, EDX, 24, 8, SERVICE_BRANCH, NA, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_403 \ FLAG( 403, 0, EAX, 0, 1, VP_RUNTIME_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EAX, 1, 1, REF_COUNTER_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EAX, 2, 1, BASIC_SYNIC_MSRS_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EAX, 3, 1, SYNTH_TIMER_MSRS_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EAX, 4, 1, APIC_ACCESS_MSRS_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EAX, 5, 1, HYPERCALL_MSRS_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EAX, 6, 1, VP_INDEX_MSR_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EAX, 7, 1, VIRT_RESET_MSR_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EAX, 8, 1, STATS_PAGES_MSRS_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EAX, 9, 1, REF_TSC_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EAX, 10, 1, GUEST_IDLE_MSR_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EAX, 11, 1, FREQUENCY_MSRS_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EAX, 12, 1, SYNTH_DEBUG_MSRS_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EBX, 0, 1, CREATE_PARTITIONS_FLAG, NA, 0, FALSE) \ FLAG( 403, 0, EBX, 1, 1, ACCESS_PARTITION_ID_FLAG, NA, 0, FALSE) \ FLAG( 403, 0, EBX, 2, 1, ACCESS_MEMORY_POOL_FLAG, NA, 0, FALSE) \ FLAG( 403, 0, EBX, 3, 1, ADJUST_MESSAGE_BUFFERS_FLAG, NA, 0, FALSE) \ FLAG( 403, 0, EBX, 4, 1, POST_MESSAGES_FLAG, NA, 0, FALSE) \ FLAG( 403, 0, EBX, 5, 1, SIGNAL_EVENTS_FLAG, NA, 0, FALSE) \ FLAG( 403, 0, EBX, 6, 1, CREATE_PORT_FLAG, NA, 0, FALSE) \ FLAG( 403, 0, EBX, 7, 1, CONNECT_PORT_FLAG, NA, 0, FALSE) \ FLAG( 403, 0, EBX, 8, 1, ACCESS_STATS_FLAG, NA, 0, FALSE) \ FLAG( 403, 0, EBX, 11, 1, DEBUGGING_FLAG, NA, 0, FALSE) \ FLAG( 403, 0, EBX, 12, 1, CPU_MANAGEMENT_FLAG, NA, 0, FALSE) \ FLAG( 403, 0, EBX, 13, 1, CONFIGURE_PROFILER_FLAG, NA, 0, FALSE) \ FLAG( 403, 0, EBX, 14, 1, ENABLE_EXPANDED_STACKWALKING_FLAG, NA, 0, FALSE) \ FIELD(403, 0, ECX, 0, 4, MAX_POWER_STATE, NA, 0, FALSE) \ FLAG( 403, 0, ECX, 4, 1, HPET_NEEDED_FOR_C3, NA, 0, FALSE) \ FLAG( 403, 0, EDX, 0, 1, MWAIT_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EDX, 1, 1, GUEST_DEBUGGING_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EDX, 2, 1, PERFORMANCE_MONITOR_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EDX, 3, 1, CPU_DYN_PARTITIONING_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EDX, 4, 1, XMM_REGISTERS_FOR_HYPERCALL_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EDX, 5, 1, GUEST_IDLE_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EDX, 6, 1, HYPERVISOR_SLEEP_STATE_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EDX, 7, 1, NUMA_DISTANCE_QUERY_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EDX, 8, 1, TIMER_FREQUENCY_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EDX, 9, 1, SYNTH_MACHINE_CHECK_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EDX, 10, 1, GUEST_CRASH_MSRS_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EDX, 11, 1, DEBUG_MSRS_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EDX, 12, 1, NPIEP1_AVAIL, NA, 0, FALSE) \ FLAG( 403, 0, EDX, 13, 1, DISABLE_HYPERVISOR_AVAIL, NA, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_404 \ FLAG( 404, 0, EAX, 0, 1, USE_HYPERCALL_TO_SWITCH_ADDR_SPACE,NA, 0, FALSE) \ FLAG( 404, 0, EAX, 1, 1, USE_HYPERCALL_TO_FLUSH_TLB, NA, 0, FALSE) \ FLAG( 404, 0, EAX, 2, 1, USE_HYPERCALL_FOR_TLB_SHOOTDOWN, NA, 0, FALSE) \ FLAG( 404, 0, EAX, 3, 1, USE_MSRS_FOR_EOI_ICR_TPR, NA, 0, FALSE) \ FLAG( 404, 0, EAX, 4, 1, USE_MSR_FOR_RESET, NA, 0, FALSE) \ FLAG( 404, 0, EAX, 5, 1, USE_RELAXED_TIMING, NA, 0, FALSE) \ FLAG( 404, 0, EAX, 6, 1, USE_DMA_REMAPPING, NA, 0, FALSE) \ FLAG( 404, 0, EAX, 7, 1, USE_INTERRUPT_REMAPPING, NA, 0, FALSE) \ FLAG( 404, 0, EAX, 8, 1, USE_X2APIC, NA, 0, FALSE) \ FLAG( 404, 0, EAX, 9, 1, DEPRECATE_AUTOEOI, NA, 0, FALSE) \ FIELD(404, 0, EBX, 0, 32, SPINLOCK_RETRIES, NA, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_405 \ FIELD(405, 0, EAX, 0, 32, MAX_VCPU, NA, 0, FALSE) \ FIELD(405, 0, EBX, 0, 32, MAX_LCPU, NA, 0, FALSE) \ FIELD(405, 0, ECX, 0, 32, MAX_REMAPPABLE_VECTORS, NA, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_406 \ FLAG( 406, 0, EAX, 0, 1, APIC_OVERLAY_ASSIST, NA, 0, FALSE) \ FLAG( 406, 0, EAX, 1, 1, MSR_BITMAPS, NA, 0, FALSE) \ FLAG( 406, 0, EAX, 2, 1, ARCH_PMCS, NA, 0, FALSE) \ FLAG( 406, 0, EAX, 3, 1, SLAT, NA, 0, FALSE) \ FLAG( 406, 0, EAX, 4, 1, DMA_REMAPPING, NA, 0, FALSE) \ FLAG( 406, 0, EAX, 5, 1, INTERRUPT_REMAPPING, NA, 0, FALSE) \ FLAG( 406, 0, EAX, 6, 1, MEMORY_PATROL_SCRUBBER, NA, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_410 \ FIELD(410, 0, EAX, 0, 32, TSC_HZ, NA, 0, FALSE) \ FIELD(410, 0, EBX, 0, 32, APICBUS_HZ, NA, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_80 \ FIELD( 80, 0, EAX, 0, 32, NUM_EXT_LEVELS, NA, 0, FALSE) \ FIELD( 80, 0, EBX, 0, 32, LEAF80_VENDOR1, NA, 0, FALSE) \ FIELD( 80, 0, ECX, 0, 32, LEAF80_VENDOR3, NA, 0, FALSE) \ FIELD( 80, 0, EDX, 0, 32, LEAF80_VENDOR2, NA, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_81 \ FIELD( 81, 0, EAX, 0, 32, UNKNOWN81EAX, ANY, 4, FALSE) \ FIELD( 81, 0, EAX, 0, 4, LEAF81_STEPPING, ANY, 4, FALSE) \ FIELD( 81, 0, EAX, 4, 4, LEAF81_MODEL, ANY, 4, FALSE) \ FIELD( 81, 0, EAX, 8, 4, LEAF81_FAMILY, ANY, 4, FALSE) \ FIELD( 81, 0, EAX, 12, 2, LEAF81_TYPE, ANY, 4, FALSE) \ FIELD( 81, 0, EAX, 16, 4, LEAF81_EXTENDED_MODEL, ANY, 4, FALSE) \ FIELD( 81, 0, EAX, 20, 8, LEAF81_EXTENDED_FAMILY, ANY, 4, FALSE) \ FIELD( 81, 0, EBX, 0, 32, UNKNOWN81EBX, ANY, 4, FALSE) \ FIELD( 81, 0, EBX, 0, 16, LEAF81_BRAND_ID, ANY, 4, FALSE) \ FIELD( 81, 0, EBX, 16, 16, UNDEF, ANY, 4, FALSE) \ FLAG( 81, 0, ECX, 0, 1, LAHF64, YES, 4, TRUE) \ FLAG( 81, 0, ECX, 1, 1, CMPLEGACY, ANY, 9, FALSE) \ FLAG( 81, 0, ECX, 2, 1, SVM, YES, 7, FALSE) \ FLAG( 81, 0, ECX, 3, 1, EXTAPICSPC, YES, 4, FALSE) \ FLAG( 81, 0, ECX, 4, 1, CR8AVAIL, YES, 4, FALSE) \ FLAG( 81, 0, ECX, 5, 1, ABM, YES, 7, TRUE) \ FLAG( 81, 0, ECX, 6, 1, SSE4A, YES, 4, TRUE) \ FLAG( 81, 0, ECX, 7, 1, MISALIGNED_SSE, YES, 4, TRUE) \ FLAG( 81, 0, ECX, 8, 1, 3DNPREFETCH, YES, 4, TRUE) \ FLAG( 81, 0, ECX, 9, 1, OSVW, ANY, 8, FALSE) \ FLAG( 81, 0, ECX, 10, 1, IBS, NO, 0, FALSE) \ FLAG( 81, 0, ECX, 11, 1, XOP, YES, 8, TRUE) \ FLAG( 81, 0, ECX, 12, 1, SKINIT, NO, 0, FALSE) \ FLAG( 81, 0, ECX, 13, 1, WATCHDOG, NO, 0, FALSE) \ FLAG( 81, 0, ECX, 15, 1, LWP, NO, 0, FALSE) \ FLAG( 81, 0, ECX, 16, 1, FMA4, YES, 8, TRUE) \ FLAG( 81, 0, ECX, 17, 1, TCE, NO, 0, FALSE) \ FLAG( 81, 0, ECX, 19, 1, NODEID_MSR, NO, 0, FALSE) \ FLAG( 81, 0, ECX, 21, 1, TBM, YES, 9, TRUE) \ FLAG( 81, 0, ECX, 22, 1, TOPOLOGY, NO, 0, FALSE) \ FLAG( 81, 0, ECX, 23, 1, PERFCORE, ANY, 4, TRUE) \ FLAG( 81, 0, ECX, 24, 1, PERFNB, NO, 0, FALSE) \ FLAG( 81, 0, ECX, 26, 1, DATABK, NO, 0, FALSE) \ FLAG( 81, 0, ECX, 27, 1, PERFTSC, NO, 0, FALSE) \ FLAG( 81, 0, ECX, 28, 1, PERFL3, NO, 0, FALSE) \ FLAG( 81, 0, ECX, 29, 1, MWAITX, NO, 0, FALSE) \ FLAG( 81, 0, EDX, 0, 1, LEAF81_FPU, YES, 4, TRUE) \ FLAG( 81, 0, EDX, 1, 1, LEAF81_VME, YES, 4, FALSE) \ FLAG( 81, 0, EDX, 2, 1, LEAF81_DE, YES, 4, FALSE) \ FLAG( 81, 0, EDX, 3, 1, LEAF81_PSE, YES, 4, FALSE) \ FLAG( 81, 0, EDX, 4, 1, LEAF81_TSC, YES, 4, TRUE) \ FLAG( 81, 0, EDX, 5, 1, LEAF81_MSR, YES, 4, FALSE) \ FLAG( 81, 0, EDX, 6, 1, LEAF81_PAE, YES, 4, FALSE) \ FLAG( 81, 0, EDX, 7, 1, LEAF81_MCE, YES, 4, FALSE) \ FLAG( 81, 0, EDX, 8, 1, LEAF81_CX8, YES, 4, TRUE) \ FLAG( 81, 0, EDX, 9, 1, LEAF81_APIC, ANY, 4, FALSE) \ FLAG( 81, 0, EDX, 11, 1, SYSC, ANY, 4, TRUE) \ FLAG( 81, 0, EDX, 12, 1, LEAF81_MTRR, YES, 4, FALSE) \ FLAG( 81, 0, EDX, 13, 1, LEAF81_PGE, YES, 4, FALSE) \ FLAG( 81, 0, EDX, 14, 1, LEAF81_MCA, YES, 4, FALSE) \ FLAG( 81, 0, EDX, 15, 1, LEAF81_CMOV, YES, 4, TRUE) \ FLAG( 81, 0, EDX, 16, 1, LEAF81_PAT, YES, 4, FALSE) \ FLAG( 81, 0, EDX, 17, 1, LEAF81_PSE36, YES, 4, FALSE) \ FLAG( 81, 0, EDX, 20, 1, NX, YES, 4, FALSE) \ FLAG( 81, 0, EDX, 22, 1, MMXEXT, YES, 4, TRUE) \ FLAG( 81, 0, EDX, 23, 1, LEAF81_MMX, YES, 4, TRUE) \ FLAG( 81, 0, EDX, 24, 1, LEAF81_FXSR, YES, 4, TRUE) \ FLAG( 81, 0, EDX, 25, 1, FFXSR, YES, 4, FALSE) \ FLAG( 81, 0, EDX, 26, 1, PDPE1GB, YES, 7, FALSE) \ FLAG( 81, 0, EDX, 27, 1, RDTSCP, YES, 4, TRUE) \ FLAG( 81, 0, EDX, 29, 1, LM, YES, 4, FALSE) \ FLAG( 81, 0, EDX, 30, 1, 3DNOWPLUS, YES, 4, TRUE) \ FLAG( 81, 0, EDX, 31, 1, 3DNOW, YES, 4, TRUE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_82 \ FIELD( 82, 0, EAX, 0, 32, LEAF82_BRAND_STRING_EAX, NA, 0, FALSE) \ FIELD( 82, 0, EBX, 0, 32, LEAF82_BRAND_STRING_EBX, NA, 0, FALSE) \ FIELD( 82, 0, ECX, 0, 32, LEAF82_BRAND_STRING_ECX, NA, 0, FALSE) \ FIELD( 82, 0, EDX, 0, 32, LEAF82_BRAND_STRING_EDX, NA, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_83 \ FIELD( 83, 0, EAX, 0, 32, LEAF83_BRAND_STRING_EAX, NA, 0, FALSE) \ FIELD( 83, 0, EBX, 0, 32, LEAF83_BRAND_STRING_EBX, NA, 0, FALSE) \ FIELD( 83, 0, ECX, 0, 32, LEAF83_BRAND_STRING_ECX, NA, 0, FALSE) \ FIELD( 83, 0, EDX, 0, 32, LEAF83_BRAND_STRING_EDX, NA, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_84 \ FIELD( 84, 0, EAX, 0, 32, LEAF84_BRAND_STRING_EAX, NA, 0, FALSE) \ FIELD( 84, 0, EBX, 0, 32, LEAF84_BRAND_STRING_EBX, NA, 0, FALSE) \ FIELD( 84, 0, ECX, 0, 32, LEAF84_BRAND_STRING_ECX, NA, 0, FALSE) \ FIELD( 84, 0, EDX, 0, 32, LEAF84_BRAND_STRING_EDX, NA, 0, FALSE) /* LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_85 \ FIELD( 85, 0, EAX, 0, 8, ITLB_ENTRIES_2M4M_PGS, NA, 0, FALSE) \ FIELD( 85, 0, EAX, 8, 8, ITLB_ASSOC_2M4M_PGS, NA, 0, FALSE) \ FIELD( 85, 0, EAX, 16, 8, DTLB_ENTRIES_2M4M_PGS, NA, 0, FALSE) \ FIELD( 85, 0, EAX, 24, 8, DTLB_ASSOC_2M4M_PGS, NA, 0, FALSE) \ FIELD( 85, 0, EBX, 0, 8, ITLB_ENTRIES_4K_PGS, NA, 0, FALSE) \ FIELD( 85, 0, EBX, 8, 8, ITLB_ASSOC_4K_PGS, NA, 0, FALSE) \ FIELD( 85, 0, EBX, 16, 8, DTLB_ENTRIES_4K_PGS, NA, 0, FALSE) \ FIELD( 85, 0, EBX, 24, 8, DTLB_ASSOC_4K_PGS, NA, 0, FALSE) \ FIELD( 85, 0, ECX, 0, 8, L1_DCACHE_LINE_SIZE, NA, 0, FALSE) \ FIELD( 85, 0, ECX, 8, 8, L1_DCACHE_LINES_PER_TAG, NA, 0, FALSE) \ FIELD( 85, 0, ECX, 16, 8, L1_DCACHE_ASSOC, NA, 0, FALSE) \ FIELD( 85, 0, ECX, 24, 8, L1_DCACHE_SIZE, NA, 0, FALSE) \ FIELD( 85, 0, EDX, 0, 8, L1_ICACHE_LINE_SIZE, NA, 0, FALSE) \ FIELD( 85, 0, EDX, 8, 8, L1_ICACHE_LINES_PER_TAG, NA, 0, FALSE) \ FIELD( 85, 0, EDX, 16, 8, L1_ICACHE_ASSOC, NA, 0, FALSE) \ FIELD( 85, 0, EDX, 24, 8, L1_ICACHE_SIZE, NA, 0, FALSE) /* LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_86 \ FIELD( 86, 0, EAX, 0, 12, L2_ITLB_ENTRIES_2M4M_PGS, NA, 0, FALSE) \ FIELD( 86, 0, EAX, 12, 4, L2_ITLB_ASSOC_2M4M_PGS, NA, 0, FALSE) \ FIELD( 86, 0, EAX, 16, 12, L2_DTLB_ENTRIES_2M4M_PGS, NA, 0, FALSE) \ FIELD( 86, 0, EAX, 28, 4, L2_DTLB_ASSOC_2M4M_PGS, NA, 0, FALSE) \ FIELD( 86, 0, EBX, 0, 12, L2_ITLB_ENTRIES_4K_PGS, NA, 0, FALSE) \ FIELD( 86, 0, EBX, 12, 4, L2_ITLB_ASSOC_4K_PGS, NA, 0, FALSE) \ FIELD( 86, 0, EBX, 16, 12, L2_DTLB_ENTRIES_4K_PGS, NA, 0, FALSE) \ FIELD( 86, 0, EBX, 28, 4, L2_DTLB_ASSOC_4K_PGS, NA, 0, FALSE) \ FIELD( 86, 0, ECX, 0, 8, L2CACHE_LINE, NA, 0, FALSE) \ FIELD( 86, 0, ECX, 8, 4, L2CACHE_LINE_PER_TAG, NA, 0, FALSE) \ FIELD( 86, 0, ECX, 12, 4, L2CACHE_WAYS, NA, 0, FALSE) \ FIELD( 86, 0, ECX, 16, 16, L2CACHE_SIZE, NA, 0, FALSE) \ FIELD( 86, 0, EDX, 0, 8, L3CACHE_LINE, NA, 0, FALSE) \ FIELD( 86, 0, EDX, 8, 4, L3CACHE_LINE_PER_TAG, NA, 0, FALSE) \ FIELD( 86, 0, EDX, 12, 4, L3CACHE_WAYS, NA, 0, FALSE) \ FIELD( 86, 0, EDX, 18, 14, L3CACHE_SIZE, NA, 0, FALSE) /* LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_87 \ FLAG( 87, 0, EBX, 0, 1, MCA_OVERFLOW_RECOV, NA, 0, FALSE) \ FLAG( 87, 0, EBX, 1, 1, SUCCOR, NA, 0, FALSE) \ FLAG( 87, 0, EBX, 2, 1, HWA, NA, 0, FALSE) \ FLAG( 87, 0, EBX, 3, 1, SCALABLE_MCA, NA, 0, FALSE) \ FLAG( 87, 0, EBX, 4, 1, PFEH_SUPPORT_PRESENT, NA, 0, FALSE) \ FLAG( 87, 0, EDX, 0, 1, TS, NA, 0, FALSE) \ FLAG( 87, 0, EDX, 1, 1, FID, NA, 0, FALSE) \ FLAG( 87, 0, EDX, 2, 1, VID, NA, 0, FALSE) \ FLAG( 87, 0, EDX, 3, 1, TTP, NA, 0, FALSE) \ FLAG( 87, 0, EDX, 4, 1, LEAF87_TM, NA, 0, FALSE) \ FLAG( 87, 0, EDX, 5, 1, STC, NA, 0, FALSE) \ FLAG( 87, 0, EDX, 6, 1, 100MHZSTEPS, NA, 0, FALSE) \ FLAG( 87, 0, EDX, 7, 1, HWPSTATE, NA, 0, FALSE) \ FLAG( 87, 0, EDX, 8, 1, TSC_INVARIANT, NA, 0, FALSE) \ FLAG( 87, 0, EDX, 9, 1, CORE_PERF_BOOST, NA, 0, FALSE) #define CPUID_88_EBX_14 \ FLAG( 88, 0, EBX, 14, 1, LEAF88_RSVD1, NO, 0, FALSE) #define CPUID_88_EBX_15 \ FLAG( 88, 0, EBX, 15, 1, LEAF88_RSVD2, NO, 0, FALSE) #define CPUID_88_EBX_16 \ FLAG( 88, 0, EBX, 16, 1, LEAF88_RSVD3, NO, 0, FALSE) #define CPUID_88_EBX_17 \ FLAG( 88, 0, EBX, 17, 1, LEAF88_RSVD4, NO, 0, FALSE) #define CPUID_88_EBX_18 \ FLAG( 88, 0, EBX, 18, 1, LEAF88_RSVD5, NO, 0, FALSE) /* LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_88 \ FIELD( 88, 0, EAX, 0, 8, PHYS_BITS, YES, 4, FALSE) \ FIELD( 88, 0, EAX, 8, 8, VIRT_BITS, YES, 4, FALSE) \ FIELD( 88, 0, EAX, 16, 8, GUEST_PHYS_ADDR_SZ, YES, 8, FALSE) \ FLAG( 88, 0, EBX, 0, 1, CLZERO, YES, 14, TRUE) \ FLAG( 88, 0, EBX, 1, 1, IRPERF, NO, 0, FALSE) \ FLAG( 88, 0, EBX, 2, 1, XSAVE_ERR_PTR, NO, 0, FALSE) \ FLAG( 88, 0, EBX, 12, 1, LEAF88_IBPB, ANY, 9, FALSE) \ CPUID_88_EBX_14 \ CPUID_88_EBX_15 \ CPUID_88_EBX_16 \ CPUID_88_EBX_17 \ CPUID_88_EBX_18 \ FIELD( 88, 0, ECX, 0, 8, LEAF88_CORE_COUNT, YES, 4, FALSE) \ FIELD( 88, 0, ECX, 12, 4, APICID_COREID_SIZE, YES, 7, FALSE) \ FIELD( 88, 0, ECX, 16, 2, PERFTSC_SIZE, NO, 0, FALSE) #define CPUID_8A_EDX_11 \ FLAG( 8A, 0, EDX, 11, 1, SVMEDX_RSVD1, NO, 0, FALSE) #define CPUID_8A_EDX_14 \ FLAG( 8A, 0, EDX, 14, 1, SVMEDX_RSVD2, NO, 0, FALSE) /* LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_8A \ FIELD( 8A, 0, EAX, 0, 8, SVM_REVISION, YES, 4, FALSE) \ FLAG( 8A, 0, EAX, 8, 1, SVM_HYPERVISOR, NO, 0, FALSE) \ FIELD( 8A, 0, EAX, 9, 23, SVMEAX_RSVD, NO, 0, FALSE) \ FIELD( 8A, 0, EBX, 0, 32, SVM_NUM_ASIDS, YES, 7, FALSE) \ FIELD( 8A, 0, ECX, 0, 32, SVMECX_RSVD, NO, 0, FALSE) \ FLAG( 8A, 0, EDX, 0, 1, SVM_NPT, YES, 7, FALSE) \ FLAG( 8A, 0, EDX, 1, 1, SVM_LBR, NO, 0, FALSE) \ FLAG( 8A, 0, EDX, 2, 1, SVM_LOCK, ANY, 7, FALSE) \ FLAG( 8A, 0, EDX, 3, 1, SVM_NRIP, YES, 7, FALSE) \ FLAG( 8A, 0, EDX, 4, 1, SVM_TSC_RATE_MSR, NO, 0, FALSE) \ FLAG( 8A, 0, EDX, 5, 1, SVM_VMCB_CLEAN, YES, 7, FALSE) \ FLAG( 8A, 0, EDX, 6, 1, SVM_FLUSH_BY_ASID, YES, 7, FALSE) \ FLAG( 8A, 0, EDX, 7, 1, SVM_DECODE_ASSISTS, YES, 7, FALSE) \ FIELD( 8A, 0, EDX, 8, 2, SVMEDX_RSVD0, NO, 0, FALSE) \ FLAG( 8A, 0, EDX, 10, 1, SVM_PAUSE_FILTER, NO, 0, FALSE) \ CPUID_8A_EDX_11 \ FLAG( 8A, 0, EDX, 12, 1, SVM_PAUSE_THRESHOLD, NO, 0, FALSE) \ FLAG( 8A, 0, EDX, 13, 1, SVM_AVIC, NO, 0, FALSE) \ CPUID_8A_EDX_14 \ FLAG( 8A, 0, EDX, 15, 1, SVM_V_VMSAVE_VMLOAD, NO, 0, FALSE) \ FLAG( 8A, 0, EDX, 16, 1, SVM_VGIF, NO, 0, FALSE) \ FIELD( 8A, 0, EDX, 17, 15, SVMEDX_RSVD, NO, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_819 \ FIELD(819, 0, EAX, 0, 12, L1_ITLB_ENTRIES_1G_PGS, NA, 0, FALSE) \ FIELD(819, 0, EAX, 12, 4, L1_ITLB_ASSOC_1G_PGS, NA, 0, FALSE) \ FIELD(819, 0, EAX, 16, 12, L1_DTLB_ENTRIES_1G_PGS, NA, 0, FALSE) \ FIELD(819, 0, EAX, 28, 4, L1_DTLB_ASSOC_1G_PGS, NA, 0, FALSE) \ FIELD(819, 0, EBX, 0, 12, L2_ITLB_ENTRIES_1G_PGS, NA, 0, FALSE) \ FIELD(819, 0, EBX, 12, 4, L2_ITLB_ASSOC_1G_PGS, NA, 0, FALSE) \ FIELD(819, 0, EBX, 16, 12, L2_DTLB_ENTRIES_1G_PGS, NA, 0, FALSE) \ FIELD(819, 0, EBX, 28, 4, L2_DTLB_ASSOC_1G_PGS, NA, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_81A \ FLAG( 81A, 0, EAX, 0, 1, FP128, NA, 0, FALSE) \ FLAG( 81A, 0, EAX, 1, 1, MOVU, NA, 0, FALSE) \ FLAG( 81A, 0, EAX, 2, 1, FP256, NA, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_81B \ FLAG( 81B, 0, EAX, 0, 1, IBS_FFV, NA, 0, FALSE) \ FLAG( 81B, 0, EAX, 1, 1, IBS_FETCHSAM, NA, 0, FALSE) \ FLAG( 81B, 0, EAX, 2, 1, IBS_OPSAM, NA, 0, FALSE) \ FLAG( 81B, 0, EAX, 3, 1, RW_OPCOUNT, NA, 0, FALSE) \ FLAG( 81B, 0, EAX, 4, 1, OPCOUNT, NA, 0, FALSE) \ FLAG( 81B, 0, EAX, 5, 1, BRANCH_TARGET_ADDR, NA, 0, FALSE) \ FLAG( 81B, 0, EAX, 6, 1, OPCOUNT_EXT, NA, 0, FALSE) \ FLAG( 81B, 0, EAX, 7, 1, RIP_INVALID_CHECK, NA, 0, FALSE) \ FLAG( 81B, 0, EAX, 8, 1, OP_BRN_FUSE, NA, 0, FALSE) \ FLAG( 81B, 0, EAX, 9, 1, IBS_FETCH_CTL_EXTD, NA, 0, FALSE) \ FLAG( 81B, 0, EAX, 10, 1, IBS_OP_DATA4, NA, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_81C \ FLAG( 81C, 0, EAX, 0, 1, LWP_AVAIL, NA, 0, FALSE) \ FLAG( 81C, 0, EAX, 1, 1, LWP_VAL_AVAIL, NA, 0, FALSE) \ FLAG( 81C, 0, EAX, 2, 1, LWP_IRE_AVAIL, NA, 0, FALSE) \ FLAG( 81C, 0, EAX, 3, 1, LWP_BRE_AVAIL, NA, 0, FALSE) \ FLAG( 81C, 0, EAX, 4, 1, LWP_DME_AVAIL, NA, 0, FALSE) \ FLAG( 81C, 0, EAX, 5, 1, LWP_CNH_AVAIL, NA, 0, FALSE) \ FLAG( 81C, 0, EAX, 6, 1, LWP_RNH_AVAIL, NA, 0, FALSE) \ FLAG( 81C, 0, EAX, 29, 1, LWP_CONT_AVAIL, NA, 0, FALSE) \ FLAG( 81C, 0, EAX, 30, 1, LWP_PTSC_AVAIL, NA, 0, FALSE) \ FLAG( 81C, 0, EAX, 31, 1, LWP_INT_AVAIL, NA, 0, FALSE) \ FIELD(81C, 0, EBX, 0, 8, LWP_CB_SIZE, NA, 0, FALSE) \ FIELD(81C, 0, EBX, 8, 8, LWP_EVENT_SIZE, NA, 0, FALSE) \ FIELD(81C, 0, EBX, 16, 8, LWP_MAX_EVENTS, NA, 0, FALSE) \ FIELD(81C, 0, EBX, 24, 8, LWP_EVENT_OFFSET, NA, 0, FALSE) \ FIELD(81C, 0, ECX, 0, 4, LWP_LATENCY_MAX, NA, 0, FALSE) \ FLAG( 81C, 0, ECX, 5, 1, LWP_DATA_ADDR_VALID, NA, 0, FALSE) \ FIELD(81C, 0, ECX, 6, 3, LWP_LATENCY_ROUND, NA, 0, FALSE) \ FIELD(81C, 0, ECX, 9, 7, LWP_VERSION, NA, 0, FALSE) \ FIELD(81C, 0, ECX, 16, 8, LWP_MIN_BUF_SIZE, NA, 0, FALSE) \ FLAG( 81C, 0, ECX, 28, 1, LWP_BRANCH_PRED, NA, 0, FALSE) \ FLAG( 81C, 0, ECX, 29, 1, LWP_IP_FILTERING, NA, 0, FALSE) \ FLAG( 81C, 0, ECX, 30, 1, LWP_CACHE_LEVEL, NA, 0, FALSE) \ FLAG( 81C, 0, ECX, 31, 1, LWP_CACHE_LATENCY, NA, 0, FALSE) \ FLAG( 81C, 0, EDX, 0, 1, LWP_SUPPORTED, NA, 0, FALSE) \ FLAG( 81C, 0, EDX, 1, 1, LWP_VAL_SUPPORTED, NA, 0, FALSE) \ FLAG( 81C, 0, EDX, 2, 1, LWP_IRE_SUPPORTED, NA, 0, FALSE) \ FLAG( 81C, 0, EDX, 3, 1, LWP_BRE_SUPPORTED, NA, 0, FALSE) \ FLAG( 81C, 0, EDX, 4, 1, LWP_DME_SUPPORTED, NA, 0, FALSE) \ FLAG( 81C, 0, EDX, 5, 1, LWP_CNH_SUPPORTED, NA, 0, FALSE) \ FLAG( 81C, 0, EDX, 6, 1, LWP_RNH_SUPPORTED, NA, 0, FALSE) \ FLAG( 81C, 0, EDX, 29, 1, LWP_CONT_SUPPORTED, NA, 0, FALSE) \ FLAG( 81C, 0, EDX, 30, 1, LWP_PTSC_SUPPORTED, NA, 0, FALSE) \ FLAG( 81C, 0, EDX, 31, 1, LWP_INT_SUPPORTED, NA, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_81D \ FIELD(81D, 0, EAX, 0, 5, LEAF81D_CACHE_TYPE, NA, 0, FALSE) \ FIELD(81D, 0, EAX, 5, 3, LEAF81D_CACHE_LEVEL, NA, 0, FALSE) \ FLAG( 81D, 0, EAX, 8, 1, LEAF81D_CACHE_SELF_INIT, NA, 0, FALSE) \ FLAG( 81D, 0, EAX, 9, 1, LEAF81D_CACHE_FULLY_ASSOC, NA, 0, FALSE) \ FIELD(81D, 0, EAX, 14, 12, LEAF81D_NUM_SHARING_CACHE, NA, 0, FALSE) \ FIELD(81D, 0, EBX, 0, 12, LEAF81D_CACHE_LINE_SIZE, NA, 0, FALSE) \ FIELD(81D, 0, EBX, 12, 10, LEAF81D_CACHE_PHYS_PARTITIONS, NA, 0, FALSE) \ FIELD(81D, 0, EBX, 22, 10, LEAF81D_CACHE_WAYS, NA, 0, FALSE) \ FIELD(81D, 0, ECX, 0, 32, LEAF81D_CACHE_NUM_SETS, NA, 0, FALSE) \ FLAG( 81D, 0, EDX, 0, 1, LEAF81D_CACHE_WBINVD, NA, 0, FALSE) \ FLAG( 81D, 0, EDX, 1, 1, LEAF81D_CACHE_INCLUSIVE, NA, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_81E \ FIELD(81E, 0, EAX, 0, 32, EXTENDED_APICID, NA, 0, FALSE) \ FIELD(81E, 0, EBX, 0, 8, COMPUTE_UNIT_ID, NA, 0, FALSE) \ FIELD(81E, 0, EBX, 8, 2, CORES_PER_COMPUTE_UNIT, NA, 0, FALSE) \ FIELD(81E, 0, ECX, 0, 8, NODEID_VAL, NA, 0, FALSE) \ FIELD(81E, 0, ECX, 8, 3, NODES_PER_PKG, NA, 0, FALSE) /* LEVEL, SUB-LEVEL, REG, POS, SIZE, NAME, MON SUPP, HWV, CPL3 */ #define CPUID_FIELD_DATA_LEVEL_81F \ FLAG( 81F, 0, EAX, 0, 1, SME, NO, 0, FALSE) \ FLAG( 81F, 0, EAX, 1, 1, SEV, NO, 0, FALSE) \ FLAG( 81F, 0, EAX, 2, 1, PAGE_FLUSH_MSR, NO, 0, FALSE) \ FLAG( 81F, 0, EAX, 3, 1, SEV_ES, NO, 0, FALSE) \ FIELD(81F, 0, EBX, 0, 5, SME_PAGE_TABLE_BIT_NUM, NO, 0, FALSE) \ FIELD(81F, 0, EBX, 6, 6, SME_PHYS_ADDR_SPACE_REDUCTION, NO, 0, FALSE) \ FIELD(81F, 0, ECX, 0, 32, NUM_ENCRYPTED_GUESTS, NO, 0, FALSE) \ FIELD(81F, 0, EDX, 0, 32, SEV_MIN_ASID, NO, 0, FALSE) #define INTEL_CPUID_FIELD_DATA #define AMD_CPUID_FIELD_DATA #define CPUID_FIELD_DATA \ CPUID_FIELD_DATA_LEVEL_0 \ CPUID_FIELD_DATA_LEVEL_1 \ CPUID_FIELD_DATA_LEVEL_2 \ CPUID_FIELD_DATA_LEVEL_4 \ CPUID_FIELD_DATA_LEVEL_5 \ CPUID_FIELD_DATA_LEVEL_6 \ CPUID_FIELD_DATA_LEVEL_7 \ CPUID_FIELD_DATA_LEVEL_A \ CPUID_FIELD_DATA_LEVEL_B \ CPUID_FIELD_DATA_LEVEL_D \ CPUID_FIELD_DATA_LEVEL_F \ CPUID_FIELD_DATA_LEVEL_10 \ CPUID_FIELD_DATA_LEVEL_12 \ CPUID_FIELD_DATA_LEVEL_14 \ CPUID_FIELD_DATA_LEVEL_15 \ CPUID_FIELD_DATA_LEVEL_16 \ CPUID_FIELD_DATA_LEVEL_17 \ CPUID_FIELD_DATA_LEVEL_400 \ CPUID_FIELD_DATA_LEVEL_401 \ CPUID_FIELD_DATA_LEVEL_402 \ CPUID_FIELD_DATA_LEVEL_403 \ CPUID_FIELD_DATA_LEVEL_404 \ CPUID_FIELD_DATA_LEVEL_405 \ CPUID_FIELD_DATA_LEVEL_406 \ CPUID_FIELD_DATA_LEVEL_410 \ CPUID_FIELD_DATA_LEVEL_80 \ CPUID_FIELD_DATA_LEVEL_81 \ CPUID_FIELD_DATA_LEVEL_82 \ CPUID_FIELD_DATA_LEVEL_83 \ CPUID_FIELD_DATA_LEVEL_84 \ CPUID_FIELD_DATA_LEVEL_85 \ CPUID_FIELD_DATA_LEVEL_86 \ CPUID_FIELD_DATA_LEVEL_87 \ CPUID_FIELD_DATA_LEVEL_88 \ CPUID_FIELD_DATA_LEVEL_8A \ CPUID_FIELD_DATA_LEVEL_819 \ CPUID_FIELD_DATA_LEVEL_81A \ CPUID_FIELD_DATA_LEVEL_81B \ CPUID_FIELD_DATA_LEVEL_81C \ CPUID_FIELD_DATA_LEVEL_81D \ CPUID_FIELD_DATA_LEVEL_81E \ CPUID_FIELD_DATA_LEVEL_81F \ INTEL_CPUID_FIELD_DATA \ AMD_CPUID_FIELD_DATA /* * Define all field and flag values as an enum. The result is a full * set of values taken from the table above in the form: * * CPUID_<name>_MASK == mask for feature/field * CPUID_<name>_SHIFT == offset of field * * e.g. - CPUID_VIRT_BITS_MASK = 0xff00 * - CPUID_VIRT_BITS_SHIFT = 8 */ #define VMW_BIT_MASK(shift) (0xffffffffu >> (32 - shift)) #define FIELD(lvl, ecxIn, reg, bitpos, size, name, s, hwv, c3) \ CPUID_##name##_SHIFT = bitpos, \ CPUID_##name##_MASK = VMW_BIT_MASK(size) << bitpos, \ CPUID_INTERNAL_SHIFT_##name = bitpos, \ CPUID_INTERNAL_MASK_##name = VMW_BIT_MASK(size) << bitpos, \ CPUID_INTERNAL_REG_##name = CPUID_REG_##reg, \ CPUID_INTERNAL_EAXIN_##name = CPUID_LEVEL_VAL_##lvl, \ CPUID_INTERNAL_ECXIN_##name = ecxIn, \ CPUID_INTERNAL_HWV_##name = hwv, #define FLAG FIELD enum { /* Define data for every CPUID field we have */ CPUID_FIELD_DATA }; #undef VMW_BIT_MASK #undef FIELD #undef FLAG /* * CPUID_MASK -- * CPUID_SHIFT -- * CPUID_ISSET -- * CPUID_GET -- * CPUID_SET -- * CPUID_CLEAR -- * CPUID_SETTO -- * * Accessor macros for all CPUID consts/fields/flags. Level and reg are not * required, but are used to force compile-time asserts which help verify that * the flag is being used on the right CPUID input and result register. * * Note: ASSERT_ON_COMPILE is duplicated rather than factored into its own * macro, because token concatenation does not work as expected if an input is * #defined (e.g. APIC) when macros are nested. Also, compound statements * within parenthes is a GCC extension, so we must use runtime asserts with * other compilers. */ #if defined(__GNUC__) && !defined(__clang__) #define CPUID_MASK(eaxIn, reg, flag) \ ({ \ ASSERT_ON_COMPILE(eaxIn == CPUID_INTERNAL_EAXIN_##flag && \ CPUID_REG_##reg == (CpuidReg)CPUID_INTERNAL_REG_##flag); \ CPUID_INTERNAL_MASK_##flag; \ }) #define CPUID_SHIFT(eaxIn, reg, flag) \ ({ \ ASSERT_ON_COMPILE(eaxIn == CPUID_INTERNAL_EAXIN_##flag && \ CPUID_REG_##reg == (CpuidReg)CPUID_INTERNAL_REG_##flag); \ CPUID_INTERNAL_SHIFT_##flag; \ }) #define CPUID_ISSET(eaxIn, reg, flag, data) \ ({ \ ASSERT_ON_COMPILE(eaxIn == CPUID_INTERNAL_EAXIN_##flag && \ CPUID_REG_##reg == (CpuidReg)CPUID_INTERNAL_REG_##flag); \ (((data) & CPUID_INTERNAL_MASK_##flag) != 0); \ }) #define CPUID_GET(eaxIn, reg, field, data) \ ({ \ ASSERT_ON_COMPILE(eaxIn == CPUID_INTERNAL_EAXIN_##field && \ CPUID_REG_##reg == (CpuidReg)CPUID_INTERNAL_REG_##field); \ (((uint32)(data) & CPUID_INTERNAL_MASK_##field) >> \ CPUID_INTERNAL_SHIFT_##field); \ }) #else /* * CPUIDCheck -- * * Return val after verifying parameters. */ static INLINE uint32 CPUIDCheck(int32 eaxIn, int32 eaxInCheck, CpuidReg reg, CpuidReg regCheck, uint32 val) { ASSERT(eaxIn == eaxInCheck && reg == regCheck); return val; } #define CPUID_MASK(eaxIn, reg, flag) \ CPUIDCheck(eaxIn, CPUID_INTERNAL_EAXIN_##flag, \ CPUID_REG_##reg, (CpuidReg)CPUID_INTERNAL_REG_##flag, \ CPUID_INTERNAL_MASK_##flag) #define CPUID_SHIFT(eaxIn, reg, flag) \ CPUIDCheck(eaxIn, CPUID_INTERNAL_EAXIN_##flag, \ CPUID_REG_##reg, (CpuidReg)CPUID_INTERNAL_REG_##flag, \ CPUID_INTERNAL_SHIFT_##flag) #define CPUID_ISSET(eaxIn, reg, flag, data) \ (CPUIDCheck(eaxIn, CPUID_INTERNAL_EAXIN_##flag, \ CPUID_REG_##reg, (CpuidReg)CPUID_INTERNAL_REG_##flag, \ CPUID_INTERNAL_MASK_##flag & (data)) != 0) #define CPUID_GET(eaxIn, reg, field, data) \ CPUIDCheck(eaxIn, CPUID_INTERNAL_EAXIN_##field, \ CPUID_REG_##reg, (CpuidReg)CPUID_INTERNAL_REG_##field, \ ((uint32)(data) & CPUID_INTERNAL_MASK_##field) >> \ CPUID_INTERNAL_SHIFT_##field) #endif #define CPUID_SET(eaxIn, reg, flag, dataPtr) \ do { \ ASSERT_ON_COMPILE( \ (uint32)eaxIn == (uint32)CPUID_INTERNAL_EAXIN_##flag && \ CPUID_REG_##reg == (CpuidReg)CPUID_INTERNAL_REG_##flag); \ *(dataPtr) |= CPUID_INTERNAL_MASK_##flag; \ } while (0) #define CPUID_CLEAR(eaxIn, reg, flag, dataPtr) \ do { \ ASSERT_ON_COMPILE( \ (uint32)eaxIn == (uint32)CPUID_INTERNAL_EAXIN_##flag && \ CPUID_REG_##reg == (CpuidReg)CPUID_INTERNAL_REG_##flag); \ *(dataPtr) &= ~CPUID_INTERNAL_MASK_##flag; \ } while (0) #define CPUID_SETTO(eaxIn, reg, field, dataPtr, val) \ do { \ uint32 _v = val; \ uint32 *_d = dataPtr; \ ASSERT_ON_COMPILE( \ (uint32)eaxIn == (uint32)CPUID_INTERNAL_EAXIN_##field && \ CPUID_REG_##reg == (CpuidReg)CPUID_INTERNAL_REG_##field); \ *_d = (*_d & ~CPUID_INTERNAL_MASK_##field) | \ (_v << CPUID_INTERNAL_SHIFT_##field); \ ASSERT(_v == (*_d & CPUID_INTERNAL_MASK_##field) >> \ CPUID_INTERNAL_SHIFT_##field); \ } while (0) #define CPUID_SETTO_SAFE(eaxIn, reg, field, dataPtr, val) \ do { \ uint32 _v = val & \ (CPUID_INTERNAL_MASK_##field >> CPUID_INTERNAL_SHIFT_##field); \ uint32 *_d = dataPtr; \ ASSERT_ON_COMPILE( \ (uint32)eaxIn == (uint32)CPUID_INTERNAL_EAXIN_##field && \ CPUID_REG_##reg == (CpuidReg)CPUID_INTERNAL_REG_##field); \ *_d = (*_d & ~CPUID_INTERNAL_MASK_##field) | \ (_v << CPUID_INTERNAL_SHIFT_##field); \ } while (0) /* * Definitions of various fields' values and more complicated * macros/functions for reading cpuid fields. */ #define CPUID_FAMILY_EXTENDED 15 /* Effective Intel CPU Families */ #define CPUID_FAMILY_486 4 #define CPUID_FAMILY_P5 5 #define CPUID_FAMILY_P6 6 #define CPUID_FAMILY_P4 15 /* Effective AMD CPU Families */ #define CPUID_FAMILY_5x86 0x4 #define CPUID_FAMILY_K5 0x5 #define CPUID_FAMILY_K6 0x5 #define CPUID_FAMILY_K7 0x6 #define CPUID_FAMILY_K8 0xf #define CPUID_FAMILY_K8L 0x10 #define CPUID_FAMILY_K8MOBILE 0x11 #define CPUID_FAMILY_LLANO 0x12 #define CPUID_FAMILY_BOBCAT 0x14 #define CPUID_FAMILY_BULLDOZER 0x15 // BD PD SR EX #define CPUID_FAMILY_KYOTO 0x16 // Note: Jaguar microarch #define CPUID_FAMILY_ZEN 0x17 /* Effective VIA CPU Families */ #define CPUID_FAMILY_C7 6 /* Effective Hygon CPU Families. */ #define CPUID_FAMILY_DHYANA 0x18 /* Intel model information */ #define CPUID_MODEL_PPRO 1 #define CPUID_MODEL_PII_03 3 #define CPUID_MODEL_PII_05 5 #define CPUID_MODEL_CELERON_06 6 #define CPUID_MODEL_PM_09 9 #define CPUID_MODEL_PM_0D 13 #define CPUID_MODEL_PM_0E 14 // Yonah / Sossaman #define CPUID_MODEL_CORE_0F 15 // Conroe / Merom #define CPUID_MODEL_CORE_17 0x17 // Penryn #define CPUID_MODEL_NEHALEM_1A 0x1a // Nehalem / Gainestown #define CPUID_MODEL_ATOM_1C 0x1c // Silverthorne / Diamondville #define CPUID_MODEL_CORE_1D 0x1d // Dunnington #define CPUID_MODEL_NEHALEM_1E 0x1e // Lynnfield #define CPUID_MODEL_NEHALEM_1F 0x1f // Havendale #define CPUID_MODEL_NEHALEM_25 0x25 // Westmere / Clarkdale #define CPUID_MODEL_ATOM_26 0x26 // Lincroft #define CPUID_MODEL_ATOM_27 0x27 // Saltwell #define CPUID_MODEL_SANDYBRIDGE_2A 0x2a // Sandybridge (desktop/mobile) #define CPUID_MODEL_NEHALEM_2C 0x2c // Westmere-EP #define CPUID_MODEL_SANDYBRIDGE_2D 0x2d // Sandybridge-EP #define CPUID_MODEL_NEHALEM_2E 0x2e // Nehalem-EX #define CPUID_MODEL_NEHALEM_2F 0x2f // Westmere-EX #define CPUID_MODEL_ATOM_35 0x35 // Cloverview #define CPUID_MODEL_ATOM_36 0x36 // Cedarview #define CPUID_MODEL_ATOM_37 0x37 // Bay Trail #define CPUID_MODEL_SANDYBRIDGE_3A 0x3a // Ivy Bridge #define CPUID_MODEL_HASWELL_3C 0x3c // Haswell DT #define CPUID_MODEL_BROADWELL_3D 0x3d // Broadwell-Ult #define CPUID_MODEL_SANDYBRIDGE_3E 0x3e // Ivy Bridge-EP #define CPUID_MODEL_HASWELL_3F 0x3f // Haswell EP/EN/EX #define CPUID_MODEL_HASWELL_45 0x45 // Haswell Ultrathin #define CPUID_MODEL_HASWELL_46 0x46 // Haswell (Crystal Well) #define CPUID_MODEL_BROADWELL_47 0x47 // Broadwell (Denlow) #define CPUID_MODEL_ATOM_4A 0x4a // Future Silvermont #define CPUID_MODEL_ATOM_4C 0x4c // Airmont #define CPUID_MODEL_ATOM_4D 0x4d // Avoton #define CPUID_MODEL_SKYLAKE_4E 0x4e // Skylake-Y / Kabylake U/Y ES #define CPUID_MODEL_BROADWELL_4F 0x4f // Broadwell EP/EN/EX #define CPUID_MODEL_SKYLAKE_55 0x55 // Skylake EP/EN/EX #define CPUID_MODEL_BROADWELL_56 0x56 // Broadwell DE #define CPUID_MODEL_KNL_57 0x57 // Knights Landing #define CPUID_MODEL_ATOM_5A 0x5a // Future Silvermont #define CPUID_MODEL_ATOM_5D 0x5d // Future Silvermont #define CPUID_MODEL_SKYLAKE_5E 0x5e // Skylake-S / Kabylake S/H ES #define CPUID_MODEL_ATOM_5F 0x5f // Denverton #define CPUID_MODEL_KNM_85 0x85 // Knights Mill #define CPUID_MODEL_KABYLAKE_8E 0x8e // Kabylake U/Y QS #define CPUID_MODEL_KABYLAKE_9E 0x9e // Kabylake S/H QS /* Intel stepping information */ #define CPUID_STEPPING_KABYLAKE_ES 0x8 // Kabylake S/H/U/Y ES #define CPUID_STEPPING_COFFEELAKE_A 0xA // Coffeelake U/S/H #define CPUID_STEPPING_COFFEELAKE_B 0xB // Coffeelake S/H #define CPUID_MODEL_PIII_07 7 #define CPUID_MODEL_PIII_08 8 #define CPUID_MODEL_PIII_0A 10 /* AMD model information */ #define CPUID_MODEL_BARCELONA_02 0x02 // Barcelona (Opteron & Phenom) #define CPUID_MODEL_SHANGHAI_04 0x04 // Shanghai RB #define CPUID_MODEL_SHANGHAI_05 0x05 // Shanghai BL #define CPUID_MODEL_SHANGHAI_06 0x06 // Shanghai DA #define CPUID_MODEL_ISTANBUL_MAGNY_08 0x08 // Istanbul (6 core) & Magny-cours (12) HY #define CPUID_MODEL_ISTANBUL_MAGNY_09 0x09 // HY - G34 package #define CPUID_MODEL_PHAROAH_HOUND_0A 0x0A // Pharoah Hound #define CPUID_MODEL_PILEDRIVER_1F 0x1F // Max piledriver model defined in BKDG #define CPUID_MODEL_PILEDRIVER_10 0x10 // family == CPUID_FAMILY_BULLDOZER #define CPUID_MODEL_PILEDRIVER_02 0x02 // family == CPUID_FAMILY_BULLDOZER #define CPUID_MODEL_OPTERON_REVF_41 0x41 // family == CPUID_FAMILY_K8 #define CPUID_MODEL_KYOTO_00 0x00 // family == CPUID_FAMILY_KYOTO #define CPUID_MODEL_STEAMROLLER_3F 0x3F // Max Steamroller model defined in BKDG #define CPUID_MODEL_STEAMROLLER_30 0x30 // family == CPUID_FAMILY_BULLDOZER #define CPUID_MODEL_EXCAVATOR_60 0x60 // family == CPUID_FAMILY_BULLDOZER #define CPUID_MODEL_EXCAVATOR_6F 0x6F // Max Excavator model defined in BKDG #define CPUID_MODEL_ZEN_00 0x00 // family == CPUID_FAMILY_ZEN #define CPUID_MODEL_ZEN_1F 0x1F // Max Zen model defined in BKDG /* VIA model information */ #define CPUID_MODEL_NANO 15 // Isaiah /* Hygon model information. */ #define CPUID_MODEL_DHYANA_A 0 // Dhyana A /* *---------------------------------------------------------------------- * * CPUID_IsVendor{AMD,Intel,VIA,Hygon} -- * * Determines if the vendor string in cpuid id0 is from * {AMD,Intel,VIA,Hygon}. * * Results: * True iff vendor string is CPUID_{AMD,INTEL,VIA,HYGON}_VENDOR_STRING * * Side effects: * None. * *---------------------------------------------------------------------- */ static INLINE Bool CPUID_IsRawVendor(CPUIDRegs *id0, const char* vendor) { // hard to get strcmp() in some environments, so do it in the raw return (id0->ebx == *(const uint32 *) (vendor + 0) && id0->ecx == *(const uint32 *) (vendor + 4) && id0->edx == *(const uint32 *) (vendor + 8)); } static INLINE Bool CPUID_IsVendorAMD(CPUIDRegs *id0) { return CPUID_IsRawVendor(id0, CPUID_AMD_VENDOR_STRING); } static INLINE Bool CPUID_IsVendorIntel(CPUIDRegs *id0) { return CPUID_IsRawVendor(id0, CPUID_INTEL_VENDOR_STRING); } static INLINE Bool CPUID_IsVendorVIA(CPUIDRegs *id0) { return CPUID_IsRawVendor(id0, CPUID_VIA_VENDOR_STRING); } static INLINE Bool CPUID_IsVendorHygon(CPUIDRegs *id0) { return CPUID_IsRawVendor(id0, CPUID_HYGON_VENDOR_STRING); } static INLINE uint32 CPUID_EFFECTIVE_FAMILY(uint32 v) /* %eax from CPUID with %eax=1. */ { uint32 f = CPUID_GET(1, EAX, FAMILY, v); return f != CPUID_FAMILY_EXTENDED ? f : f + CPUID_GET(1, EAX, EXTENDED_FAMILY, v); } /* Normally only used when FAMILY==CPUID_FAMILY_EXTENDED, but Intel is * now using the extended model field for FAMILY==CPUID_FAMILY_P6 to * refer to the newer Core2 CPUs */ static INLINE uint32 CPUID_EFFECTIVE_MODEL(uint32 v) /* %eax from CPUID with %eax=1. */ { uint32 m = CPUID_GET(1, EAX, MODEL, v); uint32 em = CPUID_GET(1, EAX, EXTENDED_MODEL, v); return m + (em << 4); } static INLINE uint32 CPUID_EFFECTIVE_STEPPING(uint32 v) /* %eax from CPUID with %eax=1. */ { return CPUID_GET(1, EAX, STEPPING, v); } /* * Notice that CPUID families for Intel and AMD overlap. The following macros * should only be used AFTER the manufacturer has been established (through * the use of CPUID standard function 0). */ static INLINE Bool CPUID_FAMILY_IS_486(uint32 eax) { return CPUID_EFFECTIVE_FAMILY(eax) == CPUID_FAMILY_486; } static INLINE Bool CPUID_FAMILY_IS_P5(uint32 eax) { return CPUID_EFFECTIVE_FAMILY(eax) == CPUID_FAMILY_P5; } static INLINE Bool CPUID_FAMILY_IS_P6(uint32 eax) { return CPUID_EFFECTIVE_FAMILY(eax) == CPUID_FAMILY_P6; } static INLINE Bool CPUID_FAMILY_IS_PENTIUM4(uint32 eax) { return CPUID_EFFECTIVE_FAMILY(eax) == CPUID_FAMILY_P4; } /* * Intel Pentium M processors are Yonah/Sossaman or an older P-M */ static INLINE Bool CPUID_UARCH_IS_PENTIUM_M(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is Intel. */ return CPUID_FAMILY_IS_P6(v) && (CPUID_EFFECTIVE_MODEL(v) == CPUID_MODEL_PM_09 || CPUID_EFFECTIVE_MODEL(v) == CPUID_MODEL_PM_0D || CPUID_EFFECTIVE_MODEL(v) == CPUID_MODEL_PM_0E); } /* * Intel Core processors are Merom, Conroe, Woodcrest, Clovertown, * Penryn, Dunnington, Kentsfield, Yorktown, Harpertown, ........ */ static INLINE Bool CPUID_UARCH_IS_CORE(uint32 v) // IN: %eax from CPUID with %eax=1. { uint32 model = CPUID_EFFECTIVE_MODEL(v); /* Assumes the CPU manufacturer is Intel. */ return CPUID_FAMILY_IS_P6(v) && model >= CPUID_MODEL_CORE_0F && (model < CPUID_MODEL_NEHALEM_1A || model == CPUID_MODEL_CORE_1D); } /* * Intel Nehalem processors are: Nehalem, Gainestown, Lynnfield, Clarkdale. */ static INLINE Bool CPUID_UARCH_IS_NEHALEM(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is Intel. */ uint32 effectiveModel = CPUID_EFFECTIVE_MODEL(v); return CPUID_FAMILY_IS_P6(v) && (effectiveModel == CPUID_MODEL_NEHALEM_1A || effectiveModel == CPUID_MODEL_NEHALEM_1E || effectiveModel == CPUID_MODEL_NEHALEM_1F || effectiveModel == CPUID_MODEL_NEHALEM_25 || effectiveModel == CPUID_MODEL_NEHALEM_2C || effectiveModel == CPUID_MODEL_NEHALEM_2E || effectiveModel == CPUID_MODEL_NEHALEM_2F); } static INLINE Bool CPUID_UARCH_IS_SANDYBRIDGE(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is Intel. */ uint32 effectiveModel = CPUID_EFFECTIVE_MODEL(v); return CPUID_FAMILY_IS_P6(v) && (effectiveModel == CPUID_MODEL_SANDYBRIDGE_2A || effectiveModel == CPUID_MODEL_SANDYBRIDGE_2D || effectiveModel == CPUID_MODEL_SANDYBRIDGE_3E || effectiveModel == CPUID_MODEL_SANDYBRIDGE_3A); } static INLINE Bool CPUID_MODEL_IS_BROADWELL(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is Intel. */ uint32 effectiveModel = CPUID_EFFECTIVE_MODEL(v); return CPUID_FAMILY_IS_P6(v) && (effectiveModel == CPUID_MODEL_BROADWELL_3D || effectiveModel == CPUID_MODEL_BROADWELL_47 || effectiveModel == CPUID_MODEL_BROADWELL_4F || effectiveModel == CPUID_MODEL_BROADWELL_56); } static INLINE Bool CPUID_MODEL_IS_HASWELL(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is Intel. */ uint32 effectiveModel = CPUID_EFFECTIVE_MODEL(v); return CPUID_FAMILY_IS_P6(v) && (effectiveModel == CPUID_MODEL_HASWELL_3C || effectiveModel == CPUID_MODEL_HASWELL_3F || effectiveModel == CPUID_MODEL_HASWELL_45 || effectiveModel == CPUID_MODEL_HASWELL_46); } static INLINE Bool CPUID_MODEL_IS_SKYLAKE(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is Intel. */ return CPUID_FAMILY_IS_P6(v) && ((CPUID_EFFECTIVE_MODEL(v) == CPUID_MODEL_SKYLAKE_5E && CPUID_EFFECTIVE_STEPPING(v) != CPUID_STEPPING_KABYLAKE_ES) || CPUID_EFFECTIVE_MODEL(v) == CPUID_MODEL_SKYLAKE_55 || (CPUID_EFFECTIVE_MODEL(v) == CPUID_MODEL_SKYLAKE_4E && CPUID_EFFECTIVE_STEPPING(v) != CPUID_STEPPING_KABYLAKE_ES)); } static INLINE Bool CPUID_MODEL_IS_COFFEELAKE(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is Intel. */ return CPUID_FAMILY_IS_P6(v) && ((CPUID_EFFECTIVE_MODEL(v) == CPUID_MODEL_KABYLAKE_9E && (CPUID_EFFECTIVE_STEPPING(v) == CPUID_STEPPING_COFFEELAKE_A || CPUID_EFFECTIVE_STEPPING(v) == CPUID_STEPPING_COFFEELAKE_B)) || (CPUID_EFFECTIVE_MODEL(v) == CPUID_MODEL_KABYLAKE_8E && CPUID_EFFECTIVE_STEPPING(v) == CPUID_STEPPING_COFFEELAKE_A)); } static INLINE Bool CPUID_MODEL_IS_KABYLAKE(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is Intel. */ return CPUID_FAMILY_IS_P6(v) && !CPUID_MODEL_IS_COFFEELAKE(v) && (CPUID_EFFECTIVE_MODEL(v) == CPUID_MODEL_KABYLAKE_9E || CPUID_EFFECTIVE_MODEL(v) == CPUID_MODEL_KABYLAKE_8E || (CPUID_EFFECTIVE_MODEL(v) == CPUID_MODEL_SKYLAKE_5E && CPUID_EFFECTIVE_STEPPING(v) == CPUID_STEPPING_KABYLAKE_ES) || (CPUID_EFFECTIVE_MODEL(v) == CPUID_MODEL_SKYLAKE_4E && CPUID_EFFECTIVE_STEPPING(v) == CPUID_STEPPING_KABYLAKE_ES)); } static INLINE Bool CPUID_UARCH_IS_SKYLAKE(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is Intel. */ return CPUID_FAMILY_IS_P6(v) && (CPUID_MODEL_IS_COFFEELAKE(v) || CPUID_MODEL_IS_KABYLAKE(v) || CPUID_MODEL_IS_SKYLAKE(v)); } static INLINE Bool CPUID_UARCH_IS_HASWELL(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is Intel. */ return CPUID_FAMILY_IS_P6(v) && (CPUID_MODEL_IS_BROADWELL(v) || CPUID_MODEL_IS_HASWELL(v)); } static INLINE Bool CPUID_MODEL_IS_CENTERTON(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is Intel. */ return CPUID_FAMILY_IS_P6(v) && CPUID_EFFECTIVE_MODEL(v) == CPUID_MODEL_ATOM_1C; } static INLINE Bool CPUID_MODEL_IS_AVOTON(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is Intel. */ return CPUID_FAMILY_IS_P6(v) && CPUID_EFFECTIVE_MODEL(v) == CPUID_MODEL_ATOM_4D; } static INLINE Bool CPUID_MODEL_IS_BAYTRAIL(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is Intel. */ return CPUID_FAMILY_IS_P6(v) && CPUID_EFFECTIVE_MODEL(v) == CPUID_MODEL_ATOM_37; } static INLINE Bool CPUID_UARCH_IS_SILVERMONT(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is Intel. */ return CPUID_FAMILY_IS_P6(v) && (CPUID_MODEL_IS_AVOTON(v) || CPUID_MODEL_IS_BAYTRAIL(v)); } static INLINE Bool CPUID_MODEL_IS_DENVERTON(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is Intel. */ return CPUID_FAMILY_IS_P6(v) && CPUID_EFFECTIVE_MODEL(v) == CPUID_MODEL_ATOM_5F; } static INLINE Bool CPUID_MODEL_IS_WESTMERE(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is Intel. */ uint32 effectiveModel = CPUID_EFFECTIVE_MODEL(v); return CPUID_FAMILY_IS_P6(v) && (effectiveModel == CPUID_MODEL_NEHALEM_25 || // Clarkdale effectiveModel == CPUID_MODEL_NEHALEM_2C || // Westmere-EP effectiveModel == CPUID_MODEL_NEHALEM_2F); // Westmere-EX } static INLINE Bool CPUID_MODEL_IS_SANDYBRIDGE(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is Intel. */ uint32 effectiveModel = CPUID_EFFECTIVE_MODEL(v); return CPUID_FAMILY_IS_P6(v) && (effectiveModel == CPUID_MODEL_SANDYBRIDGE_2A || effectiveModel == CPUID_MODEL_SANDYBRIDGE_2D); } static INLINE Bool CPUID_MODEL_IS_IVYBRIDGE(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is Intel. */ uint32 effectiveModel = CPUID_EFFECTIVE_MODEL(v); return CPUID_FAMILY_IS_P6(v) && ( effectiveModel == CPUID_MODEL_SANDYBRIDGE_3E || effectiveModel == CPUID_MODEL_SANDYBRIDGE_3A); } static INLINE Bool CPUID_MODEL_IS_KNIGHTS_LANDING(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is Intel. */ return CPUID_FAMILY_IS_P6(v) && CPUID_EFFECTIVE_MODEL(v) == CPUID_MODEL_KNL_57; } static INLINE Bool CPUID_MODEL_IS_KNIGHTS_MILL(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is Intel. */ return CPUID_FAMILY_IS_P6(v) && CPUID_EFFECTIVE_MODEL(v) == CPUID_MODEL_KNM_85; } static INLINE Bool CPUID_FAMILY_IS_K7(uint32 eax) { return CPUID_EFFECTIVE_FAMILY(eax) == CPUID_FAMILY_K7; } static INLINE Bool CPUID_FAMILY_IS_K8(uint32 eax) { return CPUID_EFFECTIVE_FAMILY(eax) == CPUID_FAMILY_K8; } /* *---------------------------------------------------------------------- * * CPUID_FAMILY_IS_K8EXT -- * * Return TRUE for family K8 with effective model >= 0x10. * *---------------------------------------------------------------------- */ static INLINE Bool CPUID_FAMILY_IS_K8EXT(uint32 eax) { return CPUID_FAMILY_IS_K8(eax) && CPUID_GET(1, EAX, EXTENDED_MODEL, eax) != 0; } static INLINE Bool CPUID_FAMILY_IS_K8L(uint32 eax) { return CPUID_EFFECTIVE_FAMILY(eax) == CPUID_FAMILY_K8L || CPUID_EFFECTIVE_FAMILY(eax) == CPUID_FAMILY_LLANO; } static INLINE Bool CPUID_FAMILY_IS_LLANO(uint32 eax) { return CPUID_EFFECTIVE_FAMILY(eax) == CPUID_FAMILY_LLANO; } static INLINE Bool CPUID_FAMILY_IS_K8MOBILE(uint32 eax) { /* Essentially a K8 (not K8L) part, but with mobile features. */ return CPUID_EFFECTIVE_FAMILY(eax) == CPUID_FAMILY_K8MOBILE; } static INLINE Bool CPUID_FAMILY_IS_K8STAR(uint32 eax) { /* * Read function name as "K8*", as in wildcard. * Matches K8 or K8L or K8MOBILE */ return CPUID_FAMILY_IS_K8(eax) || CPUID_FAMILY_IS_K8L(eax) || CPUID_FAMILY_IS_K8MOBILE(eax); } static INLINE Bool CPUID_FAMILY_IS_BOBCAT(uint32 eax) { return CPUID_EFFECTIVE_FAMILY(eax) == CPUID_FAMILY_BOBCAT; } static INLINE Bool CPUID_FAMILY_IS_BULLDOZER(uint32 eax) { return CPUID_EFFECTIVE_FAMILY(eax) == CPUID_FAMILY_BULLDOZER; } static INLINE Bool CPUID_FAMILY_IS_KYOTO(uint32 eax) { return CPUID_EFFECTIVE_FAMILY(eax) == CPUID_FAMILY_KYOTO; } static INLINE Bool CPUID_FAMILY_IS_ZEN(uint32 eax) { return CPUID_EFFECTIVE_FAMILY(eax) == CPUID_FAMILY_ZEN; } /* * AMD Barcelona (of either Opteron or Phenom kind). */ static INLINE Bool CPUID_MODEL_IS_BARCELONA(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is AMD. */ return CPUID_EFFECTIVE_FAMILY(v) == CPUID_FAMILY_K8L && CPUID_EFFECTIVE_MODEL(v) == CPUID_MODEL_BARCELONA_02; } static INLINE Bool CPUID_MODEL_IS_SHANGHAI(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is AMD. */ return CPUID_EFFECTIVE_FAMILY(v) == CPUID_FAMILY_K8L && (CPUID_MODEL_SHANGHAI_04 <= CPUID_EFFECTIVE_MODEL(v) && CPUID_EFFECTIVE_MODEL(v) <= CPUID_MODEL_SHANGHAI_06); } static INLINE Bool CPUID_MODEL_IS_ISTANBUL_MAGNY(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is AMD. */ return CPUID_EFFECTIVE_FAMILY(v) == CPUID_FAMILY_K8L && (CPUID_MODEL_ISTANBUL_MAGNY_08 <= CPUID_EFFECTIVE_MODEL(v) && CPUID_EFFECTIVE_MODEL(v) <= CPUID_MODEL_ISTANBUL_MAGNY_09); } static INLINE Bool CPUID_MODEL_IS_PHAROAH_HOUND(uint32 v) // IN: %eax from CPUID with %eax=1. { /* Assumes the CPU manufacturer is AMD. */ return CPUID_EFFECTIVE_FAMILY(v) == CPUID_FAMILY_K8L && CPUID_EFFECTIVE_MODEL(v) == CPUID_MODEL_PHAROAH_HOUND_0A; } static INLINE Bool CPUID_MODEL_IS_BULLDOZER(uint32 eax) { /* * Bulldozer is models of family 0x15 that are below 10 excluding * Piledriver 02. */ return CPUID_EFFECTIVE_FAMILY(eax) == CPUID_FAMILY_BULLDOZER && CPUID_EFFECTIVE_MODEL(eax) < CPUID_MODEL_PILEDRIVER_10 && CPUID_EFFECTIVE_MODEL(eax) != CPUID_MODEL_PILEDRIVER_02; } static INLINE Bool CPUID_MODEL_IS_PILEDRIVER(uint32 eax) { /* Piledriver is models 0x02 & 0x10 of family 0x15 (so far). */ return CPUID_EFFECTIVE_FAMILY(eax) == CPUID_FAMILY_BULLDOZER && ((CPUID_EFFECTIVE_MODEL(eax) >= CPUID_MODEL_PILEDRIVER_10 && CPUID_EFFECTIVE_MODEL(eax) <= CPUID_MODEL_PILEDRIVER_1F) || CPUID_EFFECTIVE_MODEL(eax) == CPUID_MODEL_PILEDRIVER_02); } static INLINE Bool CPUID_MODEL_IS_STEAMROLLER(uint32 eax) { /* Steamroller is model 0x30 of family 0x15 (so far). */ return CPUID_EFFECTIVE_FAMILY(eax) == CPUID_FAMILY_BULLDOZER && (CPUID_EFFECTIVE_MODEL(eax) >= CPUID_MODEL_STEAMROLLER_30 && CPUID_EFFECTIVE_MODEL(eax) <= CPUID_MODEL_STEAMROLLER_3F); } static INLINE Bool CPUID_MODEL_IS_EXCAVATOR(uint32 eax) { /* Excavator is model 0x60 of family 0x15 (so far). */ return CPUID_EFFECTIVE_FAMILY(eax) == CPUID_FAMILY_BULLDOZER && (CPUID_EFFECTIVE_MODEL(eax) >= CPUID_MODEL_EXCAVATOR_60 && CPUID_EFFECTIVE_MODEL(eax) <= CPUID_MODEL_EXCAVATOR_6F); } static INLINE Bool CPUID_MODEL_IS_KYOTO(uint32 eax) { /* Kyoto is models 0x00 of family 0x16 (so far). */ return CPUID_EFFECTIVE_FAMILY(eax) == CPUID_FAMILY_KYOTO && CPUID_EFFECTIVE_MODEL(eax) == CPUID_MODEL_KYOTO_00; } static INLINE Bool CPUID_MODEL_IS_ZEN(uint32 eax) { return CPUID_EFFECTIVE_FAMILY(eax) == CPUID_FAMILY_ZEN && CPUID_EFFECTIVE_MODEL(eax) <= CPUID_MODEL_ZEN_1F; } static INLINE Bool CPUID_FAMILY_IS_DHYANA(uint32 eax) { return CPUID_EFFECTIVE_FAMILY(eax) == CPUID_FAMILY_DHYANA; } static INLINE Bool CPUID_MODEL_IS_DHYANA_A(uint32 eax) { return CPUID_EFFECTIVE_FAMILY(eax) == CPUID_FAMILY_DHYANA && CPUID_EFFECTIVE_MODEL(eax) == CPUID_MODEL_DHYANA_A; } #define CPUID_TYPE_PRIMARY 0 #define CPUID_TYPE_OVERDRIVE 1 #define CPUID_TYPE_SECONDARY 2 #define CPUID_INTEL_ID4EAX_LEAF4_CACHE_TYPE_NULL 0 #define CPUID_INTEL_ID4EAX_LEAF4_CACHE_TYPE_DATA 1 #define CPUID_INTEL_ID4EAX_LEAF4_CACHE_TYPE_INST 2 #define CPUID_INTEL_ID4EAX_LEAF4_CACHE_TYPE_UNIF 3 #define CPUID_LEAF4_CACHE_TYPE_NULL 0 #define CPUID_LEAF4_CACHE_TYPE_DATA 1 #define CPUID_LEAF4_CACHE_TYPE_INST 2 #define CPUID_LEAF4_CACHE_TYPE_UNIF 3 #define CPUID_LEAF4_CACHE_INDEXING_DIRECT 0 #define CPUID_LEAF4_CACHE_INDEXING_COMPLEX 1 #define CPUID_INTEL_ID4EAX_LEAF4_CACHE_SELF_INIT 0x00000100 #define CPUID_INTEL_ID4EAX_LEAF4_CACHE_FULLY_ASSOC 0x00000200 #define CPUID_LEAF4_CACHE_SELF_INIT 0x00000100 #define CPUID_LEAF4_CACHE_FULLY_ASSOC 0x00000200 #define CPUID_INTEL_IDBECX_LEVEL_TYPE_INVALID 0 #define CPUID_INTEL_IDBECX_LEVEL_TYPE_SMT 1 #define CPUID_INTEL_IDBECX_LEVEL_TYPE_CORE 2 #define CPUID_TOPOLOGY_LEVEL_TYPE_INVALID 0 #define CPUID_TOPOLOGY_LEVEL_TYPE_SMT 1 #define CPUID_TOPOLOGY_LEVEL_TYPE_CORE 2 /* * For certain AMD processors, an lfence instruction is necessary at various * places to ensure ordering. */ static INLINE Bool CPUID_VendorRequiresFence(CpuidVendor vendor) { return vendor == CPUID_VENDOR_AMD; } static INLINE Bool CPUID_VersionRequiresFence(uint32 version) { return CPUID_EFFECTIVE_FAMILY(version) == CPUID_FAMILY_K8 && CPUID_EFFECTIVE_MODEL(version) < 0x40; } static INLINE Bool CPUID_ID0RequiresFence(CPUIDRegs *id0) { if (id0->eax == 0) { return FALSE; } return CPUID_IsVendorAMD(id0); } static INLINE Bool CPUID_ID1RequiresFence(CPUIDRegs *id1) { return CPUID_VersionRequiresFence(id1->eax); } static INLINE Bool CPUID_RequiresFence(CpuidVendor vendor, // IN uint32 version) // IN: %eax from CPUID with %eax=1. { return CPUID_VendorRequiresFence(vendor) && CPUID_VersionRequiresFence(version); } /* * The following low-level functions compute the number of * cores per cpu. They should be used cautiously because * they do not necessarily work on all types of CPUs. * High-level functions that are correct for all CPUs are * available elsewhere: see lib/cpuidInfo/cpuidInfo.c. */ static INLINE uint32 CPUID_IntelCoresPerPackage(uint32 v) /* %eax from CPUID with %eax=4 and %ecx=0. */ { // Note: This is not guaranteed to work on older Intel CPUs. return 1 + CPUID_GET(4, EAX, LEAF4_CORE_COUNT, v); } static INLINE uint32 CPUID_AMDCoresPerPackage(uint32 v) /* %ecx from CPUID with %eax=0x80000008. */ { // Note: This is not guaranteed to work on older AMD CPUs. return 1 + CPUID_GET(0x80000008, ECX, LEAF88_CORE_COUNT, v); } /* * Hypervisor CPUID space is 0x400000XX. */ static INLINE Bool CPUID_IsHypervisorLevel(uint32 level) { return (level & 0xffffff00) == 0x40000000; } /* *---------------------------------------------------------------------- * * CPUID_LevelUsesEcx -- * * Returns TRUE for leaves that support input ECX != 0 (subleaves). * *---------------------------------------------------------------------- */ static INLINE Bool CPUID_LevelUsesEcx(uint32 level) { switch (level) { #define CPUIDLEVEL(t, s, v, c, h) \ case v: \ return c != 0; CPUID_ALL_LEVELS #undef CPUIDLEVEL default: return FALSE; } } /* *---------------------------------------------------------------------- * * CPUID_IsValid*Subleaf -- * * Functions to determine the last subleaf for the level specified * *---------------------------------------------------------------------- */ static INLINE Bool CPUID_IsValidBSubleaf(uint32 ebx) // IN: %ebx = cpuid.b.sublevel.ebx { return ebx != 0; } static INLINE Bool CPUID_IsValid4Subleaf(uint32 eax) // IN: %eax = cpuid.4.sublevel.eax { return eax != 0; } static INLINE Bool CPUID_IsValid7Subleaf(uint32 eax, uint32 subleaf) // IN: %eax = cpuid.7.0.eax { /* * cpuid.7.0.eax is the max ecx (subleaf) index */ return subleaf <= eax; } /* *---------------------------------------------------------------------- * * CPUID_IsValidDSubleaf -- * * It is the caller's repsonsibility to determine if the processor * supports XSAVE and therefore has D sub-leaves. * *---------------------------------------------------------------------- */ static INLINE Bool CPUID_IsValidDSubleaf(uint32 subleaf) // IN: subleaf to check { return subleaf <= 63; } /* *---------------------------------------------------------------------- * * CPUID_SupportsMsrPlatformInfo -- * * Uses vendor and cpuid.1.0.eax to determine if the processor * supports MSR_PLATFORM_INFO. * *---------------------------------------------------------------------- */ static INLINE Bool CPUID_SupportsMsrPlatformInfo(CpuidVendor vendor, uint32 version) { return vendor == CPUID_VENDOR_INTEL && (CPUID_UARCH_IS_NEHALEM(version) || CPUID_UARCH_IS_SANDYBRIDGE(version) || CPUID_UARCH_IS_HASWELL(version) || CPUID_UARCH_IS_SKYLAKE(version) || CPUID_MODEL_IS_KNIGHTS_LANDING(version) || CPUID_MODEL_IS_DENVERTON(version) || CPUID_UARCH_IS_SILVERMONT(version)); } #ifdef _MSC_VER #pragma warning (pop) #endif #if defined __cplusplus } // extern "C" #endif #endif // _X86CPUID_H_ vmci-only/shared/vm_basic_asm.h 0000444 0000000 0000000 00000071321 13432725350 015541 0 ustar root root /********************************************************* * Copyright (C) 2003-2018 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 * *********************************************************/ /* * vm_basic_asm.h * * Basic asm macros */ #ifndef _VM_BASIC_ASM_H_ #define _VM_BASIC_ASM_H_ #define INCLUDE_ALLOW_USERLEVEL #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMK_MODULE #define INCLUDE_ALLOW_VMKERNEL #define INCLUDE_ALLOW_DISTRIBUTE #define INCLUDE_ALLOW_VMCORE #include "includeCheck.h" #include "vm_basic_types.h" #if defined VM_X86_64 #include "vm_basic_asm_x86_common.h" #include "vm_basic_asm_x86_64.h" #elif defined VM_X86_32 #include "vm_basic_asm_x86_common.h" #include "vm_basic_asm_x86.h" #elif defined VM_ARM_32 #include "vm_basic_asm_arm32.h" #define MUL64_NO_ASM 1 #include "mul64.h" #elif defined VM_ARM_64 #include "arm64_basic_defs.h" #include "vm_basic_asm_arm64.h" #else #define MUL64_NO_ASM 1 #include "mul64.h" #endif #if defined __cplusplus extern "C" { #endif /* * Locate most and least significant bit set functions. Use our own name * space to avoid namespace collisions. The new names follow a pattern, * <prefix><size><option>, where: * * <prefix> is [lm]ssb (least/most significant bit set) * <size> is size of the argument: 32 (32-bit), 64 (64-bit) or Ptr (pointer) * <option> is for alternative versions of the functions * * NAME FUNCTION BITS FUNC(0) *----- -------- ---- ------- * lssb32_0 LSB set (uint32) 0..31 -1 * mssb32_0 MSB set (uint32) 0..31 -1 * lssb64_0 LSB set (uint64) 0..63 -1 * mssb64_0 MSB set (uint64) 0..63 -1 * lssbPtr_0 LSB set (uintptr_t;32-bit) 0..31 -1 * lssbPtr_0 LSB set (uintptr_t;64-bit) 0..63 -1 * mssbPtr_0 MSB set (uintptr_t;32-bit) 0..31 -1 * mssbPtr_0 MSB set (uintptr_t;64-bit) 0..63 -1 * lssbPtr LSB set (uintptr_t;32-bit) 1..32 0 * lssbPtr LSB set (uintptr_t;64-bit) 1..64 0 * mssbPtr MSB set (uintptr_t;32-bit) 1..32 0 * mssbPtr MSB set (uintptr_t;64-bit) 1..64 0 * lssb32 LSB set (uint32) 1..32 0 * mssb32 MSB set (uint32) 1..32 0 * lssb64 LSB set (uint64) 1..64 0 * mssb64 MSB set (uint64) 1..64 0 */ #ifdef _MSC_VER static INLINE int lssb32_0(const uint32 value) { unsigned long idx; unsigned char ret; if (UNLIKELY(value == 0)) { return -1; } ret = _BitScanForward(&idx, (unsigned long)value); #ifdef __analysis_assume __analysis_assume(ret != 0); #endif #pragma warning(suppress: 6001 6102) // Suppress bogus complaint that idx may be uninitialized in error case return idx; } static INLINE int mssb32_0(const uint32 value) { unsigned long idx; unsigned char ret; if (UNLIKELY(value == 0)) { return -1; } ret = _BitScanReverse(&idx, (unsigned long)value); #ifdef __analysis_assume __analysis_assume(ret != 0); #endif #pragma warning(suppress: 6001 6102) // Suppress bogus complaint that idx may be uninitialized in error case return idx; } static INLINE int lssb64_0(const uint64 value) { if (UNLIKELY(value == 0)) { return -1; } else { #ifdef VM_X86_64 unsigned long idx; unsigned char ret; ret = _BitScanForward64(&idx, (unsigned __int64)value); #ifdef __analysis_assume __analysis_assume(ret != 0); #endif #pragma warning(suppress: 6001 6102) // Suppress bogus complaint that idx may be uninitialized in error case return idx; #else /* The coding was chosen to minimize conditionals and operations */ int lowFirstBit = lssb32_0((uint32) value); if (lowFirstBit == -1) { lowFirstBit = lssb32_0((uint32) (value >> 32)); if (lowFirstBit != -1) { return lowFirstBit + 32; } } return lowFirstBit; #endif } } static INLINE int mssb64_0(const uint64 value) { if (UNLIKELY(value == 0)) { return -1; } else { #ifdef VM_X86_64 unsigned long idx; unsigned char ret; ret = _BitScanReverse64(&idx, (unsigned __int64)value); #ifdef __analysis_assume __analysis_assume(ret != 0); #endif #pragma warning(suppress: 6001 6102) // Suppress bogus complaint that idx may be uninitialized in error case return idx; #else /* The coding was chosen to minimize conditionals and operations */ if (value > 0xFFFFFFFFULL) { return 32 + mssb32_0((uint32) (value >> 32)); } return mssb32_0((uint32) value); #endif } } #endif #ifdef __GNUC__ #ifdef VM_X86_ANY #define USE_ARCH_X86_CUSTOM #endif /* ********************************************************** * GCC's intrinsics for the lssb and mssb family produce sub-optimal code, * so we use inline assembly to improve matters. However, GCC cannot * propagate constants through inline assembly, so we help GCC out by * allowing it to use its intrinsics for compile-time constant values. * Some day, GCC will make better code and these can collapse to intrinsics. * * For example, in Decoder_AddressSize, inlined into VVT_GetVTInstrInfo: * __builtin_ffs(a) compiles to: * mov $0xffffffff, %esi * bsf %eax, %eax * cmovz %esi, %eax * sub $0x1, %eax * and $0x7, %eax * * While the code below compiles to: * bsf %eax, %eax * sub $0x1, %eax * * Ideally, GCC should have recognized non-zero input in the first case. * Other instances of the intrinsic produce code like * sub $1, %eax; add $1, %eax; clts * ********************************************************** */ #if __GNUC__ < 4 #define FEWER_BUILTINS #endif static INLINE int lssb32_0(uint32 value) { #ifdef USE_ARCH_X86_CUSTOM if (!__builtin_constant_p(value)) { if (UNLIKELY(value == 0)) { return -1; } else { int pos; __asm__ ("bsfl %1, %0\n" : "=r" (pos) : "rm" (value) : "cc"); return pos; } } #endif return __builtin_ffs(value) - 1; } #ifndef FEWER_BUILTINS static INLINE int mssb32_0(uint32 value) { /* * We must keep the UNLIKELY(...) outside the #if defined ... * because __builtin_clz(0) is undefined according to gcc's * documentation. */ if (UNLIKELY(value == 0)) { return -1; } else { int pos; #ifdef USE_ARCH_X86_CUSTOM if (!__builtin_constant_p(value)) { __asm__ ("bsrl %1, %0\n" : "=r" (pos) : "rm" (value) : "cc"); return pos; } #endif pos = 32 - __builtin_clz(value) - 1; return pos; } } static INLINE int lssb64_0(const uint64 value) { #ifdef USE_ARCH_X86_CUSTOM if (!__builtin_constant_p(value)) { if (UNLIKELY(value == 0)) { return -1; } else { intptr_t pos; #ifdef VM_X86_64 __asm__ ("bsf %1, %0\n" : "=r" (pos) : "rm" (value) : "cc"); #else /* The coding was chosen to minimize conditionals and operations */ pos = lssb32_0((uint32) value); if (pos == -1) { pos = lssb32_0((uint32) (value >> 32)); if (pos != -1) { return pos + 32; } } #endif return pos; } } #endif return __builtin_ffsll(value) - 1; } #endif /* !FEWER_BUILTINS */ #ifdef FEWER_BUILTINS /* GCC 3.3.x does not like __bulitin_clz or __builtin_ffsll. */ static INLINE int mssb32_0(uint32 value) { if (UNLIKELY(value == 0)) { return -1; } else { int pos; __asm__ __volatile__("bsrl %1, %0\n" : "=r" (pos) : "rm" (value) : "cc"); return pos; } } static INLINE int lssb64_0(const uint64 value) { if (UNLIKELY(value == 0)) { return -1; } else { intptr_t pos; #ifdef VM_X86_64 __asm__ __volatile__("bsf %1, %0\n" : "=r" (pos) : "rm" (value) : "cc"); #else /* The coding was chosen to minimize conditionals and operations */ pos = lssb32_0((uint32) value); if (pos == -1) { pos = lssb32_0((uint32) (value >> 32)); if (pos != -1) { return pos + 32; } } #endif /* VM_X86_64 */ return pos; } } #endif /* FEWER_BUILTINS */ static INLINE int mssb64_0(const uint64 value) { if (UNLIKELY(value == 0)) { return -1; } else { intptr_t pos; #ifdef USE_ARCH_X86_CUSTOM #ifdef VM_X86_64 __asm__ ("bsr %1, %0\n" : "=r" (pos) : "rm" (value) : "cc"); #else /* The coding was chosen to minimize conditionals and operations */ if (value > 0xFFFFFFFFULL) { pos = 32 + mssb32_0((uint32) (value >> 32)); } else { pos = mssb32_0((uint32) value); } #endif #else pos = 64 - __builtin_clzll(value) - 1; #endif return pos; } } #ifdef USE_ARCH_X86_CUSTOM #undef USE_ARCH_X86_CUSTOM #endif #endif // __GNUC__ static INLINE int lssbPtr_0(const uintptr_t value) { #ifdef VM_64BIT return lssb64_0((uint64) value); #else return lssb32_0((uint32) value); #endif } static INLINE int lssbPtr(const uintptr_t value) { return lssbPtr_0(value) + 1; } static INLINE int mssbPtr_0(const uintptr_t value) { #ifdef VM_64BIT return mssb64_0((uint64) value); #else return mssb32_0((uint32) value); #endif } static INLINE int mssbPtr(const uintptr_t value) { return mssbPtr_0(value) + 1; } static INLINE int lssb32(const uint32 value) { return lssb32_0(value) + 1; } static INLINE int mssb32(const uint32 value) { return mssb32_0(value) + 1; } static INLINE int lssb64(const uint64 value) { return lssb64_0(value) + 1; } static INLINE int mssb64(const uint64 value) { return mssb64_0(value) + 1; } #ifdef __GNUC__ #if defined(VM_X86_ANY) || defined(VM_ARM_ANY) /* *---------------------------------------------------------------------- * * uint16set -- * * memset a given address with an uint16 value, count times. * * Results: * Pointer to filled memory range. * * Side effects: * As with memset. * *---------------------------------------------------------------------- */ static INLINE void * uint16set(void *dst, uint16 val, size_t count) { #ifdef VM_ARM_32 void *tmpDst = dst; __asm__ __volatile__ ( "cmp %1, #0\n\t" "beq 2f\n" "1:\n\t" "strh %2, [%0], #2\n\t" "subs %1, %1, #1\n\t" "bne 1b\n" "2:" : "+r" (tmpDst), "+r" (count) : "r" (val) : "cc", "memory"); #elif defined(VM_ARM_64) void *tmpDst = dst; uint64 tmpVal = 0; if (count == 0) { return dst; } __asm__ __volatile__ ( "cbz %3, 1f\n\t" // Copy 16 bits twice... "bfm %2, %3, #0, #15\n\t" "lsl %2, %2, #16\n\t" "bfm %2, %3, #0, #15\n\t" // Copy 32 bits from the bottom of the reg. to the top... "lsl %2, %2, #32\n\t" "bfm %2, %2, #32, #63\n" // Copy into dst 8 bytes (4 uint16s) at a time "1:\t" "cmp %1, #4\n\t" "b.lo 2f\n\t" "str %2, [%0], #8\n\t" "sub %1, %1, #4\n\t" "b 1b\n" // Copy into dst 4 bytes at a time "2:\t" "cmp %1, #2\n\t" "b.lo 3f\n\t" "str %w2, [%0], #4\n\t" "sub %1, %1, #2\n\t" "b 2b\n" // We have 1 or zero items left... "3:\t" "cbz %1, 4f\n\t" "strh %w2, [%0]\n" "4:" : "+r" (tmpDst), "+r" (count), "+r" (tmpVal) : "r" (val) : "cc", "memory"); #else size_t dummy0; void *dummy1; __asm__ __volatile__("\t" "cld" "\n\t" "rep ; stosw" "\n" : "=c" (dummy0), "=D" (dummy1) : "0" (count), "1" (dst), "a" (val) : "memory", "cc" ); #endif return dst; } /* *---------------------------------------------------------------------- * * uint32set -- * * memset a given address with an uint32 value, count times. * * Results: * Pointer to filled memory range. * * Side effects: * As with memset. * *---------------------------------------------------------------------- */ static INLINE void * uint32set(void *dst, uint32 val, size_t count) { #ifdef VM_ARM_32 void *tmpDst = dst; __asm__ __volatile__ ( "cmp %1, #0\n\t" "beq 2f\n" "1:\n\t" "str %2, [%0], #4\n\t" "subs %1, %1, #1\n\t" "bne 1b\n" "2:" : "+r" (tmpDst), "+r" (count) : "r" (val) : "cc", "memory"); #elif defined(VM_ARM_64) void *tmpDst = dst; if (count == 0) { return dst; } __asm__ __volatile__ ( "cbz %2, 1f\n\t" // Drop our value in the top 32 bits, then copy from there to the bottom "lsl %2, %2, #32\n\t" "bfm %2, %2, #32, #63\n" // Copy four at a time "1:\t" "cmp %1, #16\n\t" "b.lo 2f\n\t" "stp %2, %2, [%0], #16\n\t" "stp %2, %2, [%0], #16\n\t" "stp %2, %2, [%0], #16\n\t" "stp %2, %2, [%0], #16\n\t" "sub %1, %1, #16\n\t" "b 1b\n" // Copy remaining pairs of data "2:\t" "cmp %1, #2\n\t" "b.lo 3f\n\t" "str %2, [%0], #8\n\t" "sub %1, %1, #2\n\t" "b 2b\n" // One or zero values left to copy "3:\t" "cbz %1, 4f\n\t" "str %w2, [%0]\n\t" // No incr "4:" : "+r" (tmpDst), "+r" (count), "+r" (val) : : "cc", "memory"); #else size_t dummy0; void *dummy1; __asm__ __volatile__("\t" "cld" "\n\t" "rep ; stosl" "\n" : "=c" (dummy0), "=D" (dummy1) : "0" (count), "1" (dst), "a" (val) : "memory", "cc" ); #endif return dst; } #else /* unknown system: rely on C to write */ static INLINE void * uint16set(void *dst, uint16 val, size_t count) { size_t i; for (i = 0; i < count; i++) { ((uint16 *) dst)[i] = val; } return dst; } static INLINE void * uint32set(void *dst, uint32 val, size_t count) { size_t i; for (i = 0; i < count; i++) { ((uint32 *) dst)[i] = val; } return dst; } #endif // defined(VM_X86_ANY) || defined(VM_ARM_ANY) #elif defined(_MSC_VER) static INLINE void * uint16set(void *dst, uint16 val, size_t count) { #ifdef VM_X86_64 __stosw((uint16*)dst, val, count); #elif defined(VM_ARM_32) size_t i; for (i = 0; i < count; i++) { ((uint16 *)dst)[i] = val; } #else __asm { pushf; mov ax, val; mov ecx, count; mov edi, dst; cld; rep stosw; popf; } #endif return dst; } static INLINE void * uint32set(void *dst, uint32 val, size_t count) { #ifdef VM_X86_64 __stosd((unsigned long*)dst, (unsigned long)val, count); #elif defined(VM_ARM_32) size_t i; for (i = 0; i < count; i++) { ((uint32 *)dst)[i] = val; } #else __asm { pushf; mov eax, val; mov ecx, count; mov edi, dst; cld; rep stosd; popf; } #endif return dst; } #else #error "No compiler defined for uint*set" #endif /* *----------------------------------------------------------------------------- * * Bswap16 -- * * Swap the 2 bytes of "v" as follows: 32 -> 23. * *----------------------------------------------------------------------------- */ static INLINE uint16 Bswap16(uint16 v) { #if defined(VM_ARM_64) __asm__("rev16 %w0, %w0" : "+r"(v)); return v; #else return ((v >> 8) & 0x00ff) | ((v << 8) & 0xff00); #endif } /* *----------------------------------------------------------------------------- * * Bswap32 -- * * Swap the 4 bytes of "v" as follows: 3210 -> 0123. * *----------------------------------------------------------------------------- */ static INLINE uint32 Bswap32(uint32 v) // IN { #if defined(__GNUC__) && defined(VM_X86_ANY) /* Checked against the Intel manual and GCC. --hpreg */ __asm__( "bswap %0" : "=r" (v) : "0" (v) ); return v; #elif defined(VM_ARM_32) && !defined(__ANDROID__) && !defined(_MSC_VER) __asm__("rev %0, %0" : "+r"(v)); return v; #elif defined(VM_ARM_64) __asm__("rev32 %x0, %x0" : "+r"(v)); return v; #else return (v >> 24) | ((v >> 8) & 0xFF00) | ((v & 0xFF00) << 8) | (v << 24) ; #endif } #define Bswap Bswap32 /* *----------------------------------------------------------------------------- * * Bswap64 -- * * Swap the 8 bytes of "v" as follows: 76543210 -> 01234567. * *----------------------------------------------------------------------------- */ static INLINE uint64 Bswap64(uint64 v) // IN { #if defined(VM_ARM_64) __asm__("rev %0, %0" : "+r"(v)); return v; #else return ((uint64)Bswap((uint32)v) << 32) | Bswap((uint32)(v >> 32)); #endif } /* * PAUSE is a P4 instruction that improves spinlock power+performance; * on non-P4 IA32 systems, the encoding is interpreted as a REPZ-NOP. * Use volatile to avoid NOP removal. */ static INLINE void PAUSE(void) #if defined(__GNUC__) || defined(VM_ARM_32) { #ifdef VM_ARM_ANY /* * ARM has no instruction to execute "spin-wait loop", just leave it * empty. */ #else __asm__ __volatile__( "pause" :); #endif } #elif defined(_MSC_VER) #ifdef VM_X86_64 { _mm_pause(); } #else /* VM_X86_64 */ #pragma warning( disable : 4035) { __asm _emit 0xf3 __asm _emit 0x90 } #pragma warning (default: 4035) #endif /* VM_X86_64 */ #else /* __GNUC__ */ #error No compiler defined for PAUSE #endif /* * Checked against the Intel manual and GCC --hpreg * * volatile because the tsc always changes without the compiler knowing it. */ static INLINE uint64 RDTSC(void) #ifdef __GNUC__ { #ifdef VM_X86_64 uint64 tscLow; uint64 tscHigh; __asm__ __volatile__( "rdtsc" : "=a" (tscLow), "=d" (tscHigh) ); return tscHigh << 32 | tscLow; #elif defined(VM_X86_32) uint64 tim; __asm__ __volatile__( "rdtsc" : "=A" (tim) ); return tim; #elif defined(VM_ARM_64) #if (defined(VMKERNEL) || defined(VMM)) && !defined(VMK_ARM_EL1) return MRS(CNTPCT_EL0); #else return MRS(CNTVCT_EL0); #endif #else /* * For platform without cheap timer, just return 0. */ return 0; #endif } #elif defined(_MSC_VER) #ifdef VM_X86_64 { return __rdtsc(); } #elif defined(VM_ARM_32) { /* * We need to do more inverstagetion here to find * a microsoft equivalent of that code */ NOT_IMPLEMENTED(); return 0; } #else #pragma warning( disable : 4035) { __asm _emit 0x0f __asm _emit 0x31 } #pragma warning (default: 4035) #endif /* VM_X86_64 */ #else /* __GNUC__ */ #error No compiler defined for RDTSC #endif /* __GNUC__ */ /* *----------------------------------------------------------------------------- * * DEBUGBREAK -- * * Does an int3 for MSVC / GCC, bkpt/brk for ARM. This is a macro to make * sure int3 is always inlined. * *----------------------------------------------------------------------------- */ #ifdef VM_ARM_32 #define DEBUGBREAK() __asm__("bkpt") #elif defined(VM_ARM_64) #define DEBUGBREAK() __asm__("brk #0") #elif defined(_MSC_VER) #define DEBUGBREAK() __debugbreak() #else #define DEBUGBREAK() __asm__("int $3") #endif /* *----------------------------------------------------------------------------- * * {Clear,Set,Test}Bit{32,64} -- * * Sets or clears a specified single bit in the provided variable. * * The index input value specifies which bit to modify and is 0-based. * Index is truncated by hardware to a 5-bit or 6-bit offset for the * 32 and 64-bit flavors, respectively, but input values are not validated * with asserts to avoid include dependencies. * * 64-bit flavors are not handcrafted for 32-bit builds because they may * defeat compiler optimizations. * *----------------------------------------------------------------------------- */ static INLINE void SetBit32(uint32 *var, uint32 index) { #if defined(__GNUC__) && defined(VM_X86_ANY) __asm__ ( "bts %1, %0" : "+mr" (*var) : "rI" (index) : "cc" ); #elif defined(_MSC_VER) _bittestandset((long *)var, index); #else *var |= (1 << index); #endif } static INLINE void ClearBit32(uint32 *var, uint32 index) { #if defined(__GNUC__) && defined(VM_X86_ANY) __asm__ ( "btr %1, %0" : "+mr" (*var) : "rI" (index) : "cc" ); #elif defined(_MSC_VER) _bittestandreset((long *)var, index); #else *var &= ~(1 << index); #endif } static INLINE void SetBit64(uint64 *var, uint64 index) { #if defined(VM_64BIT) && !defined(VM_ARM_64) #ifdef __GNUC__ __asm__ ( "bts %1, %0" : "+mr" (*var) : "rJ" (index) : "cc" ); #elif defined(_MSC_VER) _bittestandset64((__int64 *)var, index); #endif #else *var |= ((uint64)1 << index); #endif } static INLINE void ClearBit64(uint64 *var, uint64 index) { #if defined(VM_64BIT) && !defined(VM_ARM_64) #ifdef __GNUC__ __asm__ ( "btrq %1, %0" : "+mr" (*var) : "rJ" (index) : "cc" ); #elif defined(_MSC_VER) _bittestandreset64((__int64 *)var, index); #endif #else *var &= ~((uint64)1 << index); #endif } static INLINE Bool TestBit32(const uint32 *var, uint32 index) { #if defined(__GNUC__) && defined(VM_X86_ANY) Bool bit; __asm__ ( "bt %[index], %[var] \n" "setc %[bit]" : [bit] "=qQm" (bit) : [index] "rI" (index), [var] "r" (*var) : "cc" ); return bit; #else return (*var & (1 << index)) != 0; #endif } static INLINE Bool TestBit64(const uint64 *var, uint64 index) { #if defined __GNUC__ && defined VM_X86_64 Bool bit; __asm__ ( "bt %[index], %[var] \n" "setc %[bit]" : [bit] "=qQm" (bit) : [index] "rJ" (index), [var] "r" (*var) : "cc" ); return bit; #else return (*var & (CONST64U(1) << index)) != 0; #endif } /* *----------------------------------------------------------------------------- * * {Clear,Set,Complement,Test}BitVector -- * * Sets, clears, complements, or tests a specified single bit in the * provided array. The index input value specifies which bit to modify * and is 0-based. Bit number can be +-2Gb (+-128MB) relative from 'var' * variable. * * All functions return value of the bit before modification was performed. * *----------------------------------------------------------------------------- */ static INLINE Bool SetBitVector(void *var, int32 index) { #if defined(__GNUC__) && defined(VM_X86_ANY) Bool bit; __asm__ ( "bts %2, %1;" "setc %0" : "=qQm" (bit), "+m" (*(uint32 *)var) : "rI" (index) : "memory", "cc" ); return bit; #elif defined(_MSC_VER) return _bittestandset((long *)var, index) != 0; #else Bool retVal = (((uint8 *)var)[index / 8] & (1 << (index % 8))) != 0; ((uint8 *)var)[index / 8] |= 1 << (index % 8); return retVal; #endif } static INLINE Bool ClearBitVector(void *var, int32 index) { #if defined(__GNUC__) && defined(VM_X86_ANY) Bool bit; __asm__ ( "btr %2, %1;" "setc %0" : "=qQm" (bit), "+m" (*(uint32 *)var) : "rI" (index) : "memory", "cc" ); return bit; #elif defined(_MSC_VER) return _bittestandreset((long *)var, index) != 0; #else Bool retVal = (((uint8 *)var)[index / 8] & (1 << (index % 8))) != 0; ((uint8 *)var)[index / 8] &= ~(1 << (index % 8)); return retVal; #endif } static INLINE Bool ComplementBitVector(void *var, int32 index) { #if defined(__GNUC__) && defined(VM_X86_ANY) Bool bit; __asm__ ( "btc %2, %1;" "setc %0" : "=qQm" (bit), "+m" (*(uint32 *)var) : "rI" (index) : "memory", "cc" ); return bit; #elif defined(_MSC_VER) return _bittestandcomplement((long *)var, index) != 0; #else Bool retVal = (((uint8 *)var)[index / 8] & (1 << (index % 8))) != 0; ((uint8 *)var)[index / 8] ^= ~(1 << (index % 8)); return retVal; #endif } static INLINE Bool TestBitVector(const void *var, int32 index) { #if defined(__GNUC__) && defined(VM_X86_ANY) Bool bit; __asm__ ( "bt %2, %1;" "setc %0" : "=qQm" (bit) : "m" (*(const uint32 *)var), "rI" (index) : "cc" ); return bit; #elif defined _MSC_VER return _bittest((long *)var, index) != 0; #else return (((const uint8 *)var)[index / 8] & (1 << (index % 8))) != 0; #endif } /* *----------------------------------------------------------------------------- * RoundUpPow2_{64,32} -- * * Rounds a value up to the next higher power of 2. Returns the original * value if it is a power of 2. The next power of 2 for inputs {0, 1} is 1. * The result is undefined for inputs above {2^63, 2^31} (but equal to 1 * in this implementation). *----------------------------------------------------------------------------- */ static INLINE uint64 RoundUpPow2C64(uint64 value) { if (value <= 1 || value > (CONST64U(1) << 63)) { return 1; // Match the assembly's undefined value for large inputs. } else { return (CONST64U(2) << mssb64_0(value - 1)); } } #if defined(__GNUC__) && defined(VM_X86_64) static INLINE uint64 RoundUpPow2Asm64(uint64 value) { uint64 out = 2; __asm__("lea -1(%[in]), %%rcx;" // rcx = value - 1. Preserve original. "bsr %%rcx, %%rcx;" // rcx = log2(value - 1) if value != 1 // if value == 0, then rcx = 63 // if value == 1 then zf = 1, else zf = 0. "rol %%cl, %[out];" // out = 2 << rcx (if rcx != -1) // = 2^(log2(value - 1) + 1) // if rcx == -1 (value == 0), out = 1 // zf is always unmodified. "cmovz %[in], %[out]" // if value == 1 (zf == 1), write 1 to out. : [out]"+r"(out) : [in]"r"(value) : "%rcx", "cc"); return out; } #endif static INLINE uint64 RoundUpPow2_64(uint64 value) { #if defined(__GNUC__) && defined(VM_X86_64) if (__builtin_constant_p(value)) { return RoundUpPow2C64(value); } else { return RoundUpPow2Asm64(value); } #else return RoundUpPow2C64(value); #endif } static INLINE uint32 RoundUpPow2C32(uint32 value) { if (value <= 1 || value > (1U << 31)) { return 1; // Match the assembly's undefined value for large inputs. } else { return (2 << mssb32_0(value - 1)); } } #ifdef __GNUC__ static INLINE uint32 RoundUpPow2Asm32(uint32 value) { #ifdef VM_ARM_32 uint32 out = 1; // Note: None Thumb only! // The value of the argument "value" // will be affected! __asm__("sub %[in], %[in], #1;" // r1 = value - 1 . if value == 0 then r1 = 0xFFFFFFFF "clz %[in], %[in];" // r1 = log2(value - 1) if value != 1 // if value == 0 then r1 = 0 // if value == 1 then r1 = 32 "mov %[out], %[out], ror %[in]" // out = 2^(32 - r1) // if out == 2^32 then out = 1 as it is right rotate : [in]"+r"(value),[out]"+r"(out)); return out; #elif defined(VM_ARM_64) return RoundUpPow2C32(value); #else uint32 out = 2; __asm__("lea -1(%[in]), %%ecx;" // ecx = value - 1. Preserve original. "bsr %%ecx, %%ecx;" // ecx = log2(value - 1) if value != 1 // if value == 0, then ecx = 31 // if value == 1 then zf = 1, else zf = 0. "rol %%cl, %[out];" // out = 2 << ecx (if ecx != -1) // = 2^(log2(value - 1) + 1). // if ecx == -1 (value == 0), out = 1 // zf is always unmodified "cmovz %[in], %[out]" // if value == 1 (zf == 1), write 1 to out. : [out]"+r"(out) : [in]"r"(value) : "%ecx", "cc"); return out; #endif } #endif // __GNUC__ static INLINE uint32 RoundUpPow2_32(uint32 value) { #ifdef __GNUC__ if (__builtin_constant_p(value)) { return RoundUpPow2C32(value); } else { return RoundUpPow2Asm32(value); } #else return RoundUpPow2C32(value); #endif } #if defined __cplusplus } // extern "C" #endif #endif // _VM_BASIC_ASM_H_ vmci-only/shared/vmciKernelAPI3.h 0000444 0000000 0000000 00000003150 13432725350 015625 0 ustar root root /********************************************************* * Copyright (C) 2017 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 * *********************************************************/ /* * vmciKernelAPI3.h -- * * Kernel API (v3) exported from the VMCI host and guest drivers. */ #ifndef __VMCI_KERNELAPI_3_H__ #define __VMCI_KERNELAPI_3_H__ #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMK_MODULE #define INCLUDE_ALLOW_VMKERNEL #include "includeCheck.h" #include "vmciKernelAPI2.h" #if defined __cplusplus extern "C" { #endif /* Define version 3. */ #undef VMCI_KERNEL_API_VERSION #define VMCI_KERNEL_API_VERSION_3 3 #define VMCI_KERNEL_API_VERSION VMCI_KERNEL_API_VERSION_3 /* VMCI Detach Cause API (only available in vmkernel). */ #define VMCI_DETACH_REGULAR 0 #define VMCI_DETACH_VMOTION 1 int vmci_qpair_get_detach_cause(VMCIQPair *qpair, uint8 *cause); #if defined __cplusplus } // extern "C" #endif #endif /* !__VMCI_KERNELAPI_3_H__ */ vmci-only/shared/guest_msg_def.h 0000444 0000000 0000000 00000005647 13432725350 015741 0 ustar root root /********************************************************* * Copyright (C) 1998-2016 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 * *********************************************************/ /* * guest_msg_def.h -- * * Second layer of the internal communication channel between guest * applications and vmware * */ #ifndef _GUEST_MSG_DEF_H_ #define _GUEST_MSG_DEF_H_ #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_USERLEVEL #include "includeCheck.h" /* Basic request types */ typedef enum { MESSAGE_TYPE_OPEN, MESSAGE_TYPE_SENDSIZE, MESSAGE_TYPE_SENDPAYLOAD, MESSAGE_TYPE_RECVSIZE, MESSAGE_TYPE_RECVPAYLOAD, MESSAGE_TYPE_RECVSTATUS, MESSAGE_TYPE_CLOSE, } MessageType; /* Reply statuses */ /* The basic request succeeded */ #define MESSAGE_STATUS_SUCCESS 0x0001 /* vmware has a message available for its party */ #define MESSAGE_STATUS_DORECV 0x0002 /* The channel has been closed */ #define MESSAGE_STATUS_CLOSED 0x0004 /* vmware removed the message before the party fetched it */ #define MESSAGE_STATUS_UNSENT 0x0008 /* A checkpoint occurred */ #define MESSAGE_STATUS_CPT 0x0010 /* An underlying device is powering off */ #define MESSAGE_STATUS_POWEROFF 0x0020 /* vmware has detected a timeout on the channel */ #define MESSAGE_STATUS_TIMEOUT 0x0040 /* vmware supports high-bandwidth for sending and receiving the payload */ #define MESSAGE_STATUS_HB 0x0080 /* * This mask defines the status bits that the guest is allowed to set; * we use this to mask out all other bits when receiving the status * from the guest. Otherwise, the guest can manipulate VMX state by * setting status bits that are only supposed to be changed by the * VMX. See bug 45385. */ #define MESSAGE_STATUS_GUEST_MASK MESSAGE_STATUS_SUCCESS /* * Max number of channels. * Unfortunately this has to be public because the monitor part * of the backdoor needs it for its trivial-case optimization. [greg] */ #define GUESTMSG_MAX_CHANNEL 8 /* Flags to open a channel. --hpreg */ #define GUESTMSG_FLAG_COOKIE 0x80000000 #define GUESTMSG_FLAG_ALL GUESTMSG_FLAG_COOKIE /* * Maximum size of incoming message. This is to prevent denial of host service * attacks from guest applications. */ #define GUESTMSG_MAX_IN_SIZE (64 * 1024) #endif /* _GUEST_MSG_DEF_H_ */ vmci-only/shared/dbllnklst.h 0000444 0000000 0000000 00000015155 13432725346 015117 0 ustar root root /********************************************************* * Copyright (C) 1998-2017 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 * *********************************************************/ /* * dbllnklst.h -- * * Double linked lists */ #ifndef _DBLLNKLST_H_ #define _DBLLNKLST_H_ #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_USERLEVEL #include "includeCheck.h" #include "vm_basic_types.h" #if defined(__cplusplus) extern "C" { #endif #define DblLnkLst_OffsetOf(type, field) ((intptr_t)&((type *)0)->field) #define DblLnkLst_Container(addr, type, field) \ ((type *)((char *)(addr) - DblLnkLst_OffsetOf(type, field))) #define DblLnkLst_ForEach(curr, head) \ for (curr = (head)->next; curr != (head); curr = (curr)->next) /* Safe from list element removal within loop body. */ #define DblLnkLst_ForEachSafe(curr, nextElem, head) \ for (curr = (head)->next, nextElem = (curr)->next; \ curr != (head); \ curr = nextElem, nextElem = (curr)->next) typedef struct DblLnkLst_Links { struct DblLnkLst_Links *prev; struct DblLnkLst_Links *next; } DblLnkLst_Links; /* * Functions * * DblLnkLst_LinkFirst, DblLnkLst_LinkLast, and DblLnkLst_Swap are specific * to anchored lists. The rest are for both circular and anchored lists. */ /* *---------------------------------------------------------------------- * * DblLnkLst_Init -- * * Initialize a member of a doubly linked list * * Result * None * * Side effects: * None * *---------------------------------------------------------------------- */ static INLINE void DblLnkLst_Init(DblLnkLst_Links *l) // OUT { l->prev = l->next = l; } /* *---------------------------------------------------------------------- * * DblLnkLst_Link -- * * Merge two doubly linked lists into one * * The operation is commutative * The operation is inversible (its inverse is DblLnkLst_Unlink) * * Result * None * * Side effects: * None * *---------------------------------------------------------------------- */ static INLINE void DblLnkLst_Link(DblLnkLst_Links *l1, // IN/OUT DblLnkLst_Links *l2) // IN/OUT { DblLnkLst_Links *tmp; (tmp = l1->prev)->next = l2; (l1->prev = l2->prev)->next = l1; l2->prev = tmp ; } /* *---------------------------------------------------------------------- * * DblLnkLst_Unlink -- * * Split one doubly linked list into two * * No check is performed: the caller must ensure that both members * belong to the same doubly linked list * * The operation is commutative * The operation is inversible (its inverse is DblLnkLst_Link) * * Result * None * * Side effects: * None * *---------------------------------------------------------------------- */ static INLINE void DblLnkLst_Unlink(DblLnkLst_Links *l1, // IN/OUT DblLnkLst_Links *l2) // IN/OUT { DblLnkLst_Links *tmp; tmp = l1->prev ; (l1->prev = l2->prev)->next = l1; (l2->prev = tmp )->next = l2; } /* *---------------------------------------------------------------------- * * DblLnkLst_Unlink1 -- * * Unlink an element from its list. * * Result * None * * Side effects: * None * *---------------------------------------------------------------------- */ static INLINE void DblLnkLst_Unlink1(DblLnkLst_Links *l) // IN/OUT { DblLnkLst_Unlink(l, l->next); } /* *---------------------------------------------------------------------------- * * DblLnkLst_IsLinked -- * * Determines whether an element is linked with any other elements. * * Results: * TRUE if link is linked, FALSE otherwise. * * Side effects: * None. * *---------------------------------------------------------------------------- */ static INLINE Bool DblLnkLst_IsLinked(DblLnkLst_Links const *l) // IN { /* * A DblLnkLst_Links is either linked to itself (not linked) or linked to * other elements in a list (linked). */ return l->prev != l; } /* *---------------------------------------------------------------------- * * DblLnkLst_LinkFirst -- * * Insert 'l' at the beginning of the list anchored at 'head' * * Result * None * * Side effects: * None * *---------------------------------------------------------------------- */ static INLINE void DblLnkLst_LinkFirst(DblLnkLst_Links *head, // IN/OUT DblLnkLst_Links *l) // IN/OUT { DblLnkLst_Link(head->next, l); } /* *---------------------------------------------------------------------- * * DblLnkLst_LinkLast -- * * Insert 'l' at the end of the list anchored at 'head' * * Result * None * * Side effects: * None * *---------------------------------------------------------------------- */ static INLINE void DblLnkLst_LinkLast(DblLnkLst_Links *head, // IN/OUT DblLnkLst_Links *l) // IN/OUT { DblLnkLst_Link(head, l); } /* *---------------------------------------------------------------------- * * DblLnkLst_Swap -- * * Swap all entries between the list anchored at 'head1' and the list * anchored at 'head2'. * * The operation is commutative * The operation is inversible (its inverse is itself) * * Result * None * * Side effects: * None * *---------------------------------------------------------------------- */ static INLINE void DblLnkLst_Swap(DblLnkLst_Links *head1, // IN/OUT DblLnkLst_Links *head2) // IN/OUT { DblLnkLst_Links const tmp = *head1; if (DblLnkLst_IsLinked(head2)) { (head1->prev = head2->prev)->next = head1; (head1->next = head2->next)->prev = head1; } else { DblLnkLst_Init(head1); } if (tmp.prev != head1) { (head2->prev = tmp.prev)->next = head2; (head2->next = tmp.next)->prev = head2; } else { DblLnkLst_Init(head2); } } #if defined(__cplusplus) } // extern "C" #endif #endif /* _DBLLNKLST_H_ */ vmci-only/shared/compat_scsi.h 0000444 0000000 0000000 00000003024 13432725347 015423 0 ustar root root /********************************************************* * Copyright (C) 2002 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 * *********************************************************/ #ifndef __COMPAT_SCSI_H__ # define __COMPAT_SCSI_H__ /* The scsi_bufflen() API appeared somewhere in time --hpreg */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 23) # define scsi_bufflen(cmd) ((cmd)->request_bufflen) # define scsi_sg_count(cmd) ((cmd)->use_sg) # define scsi_sglist(cmd) ((struct scatterlist *)(cmd)->request_buffer) # define scsi_set_resid(cmd, _resid) ((cmd)->resid = _resid) #endif /* * Using scsi_sglist to access the request buffer looks strange * so instead we define this macro. What happened is later kernel * put all SCSI data in sglists, since it simplifies passing buffers */ #define scsi_request_buffer(cmd) scsi_sglist(cmd) #endif /* __COMPAT_SCSI_H__ */ vmci-only/shared/vm_basic_math.h 0000444 0000000 0000000 00000010721 13432725350 015707 0 ustar root root /********************************************************* * Copyright (C) 2008-2017 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 * *********************************************************/ /* * vm_basic_math.h -- * * Standard mathematical macros for VMware source code. */ #ifndef _VM_BASIC_MATH_H_ #define _VM_BASIC_MATH_H_ #define INCLUDE_ALLOW_USERLEVEL #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMKERNEL #define INCLUDE_ALLOW_VMKDRIVERS #define INCLUDE_ALLOW_VMK_MODULE #define INCLUDE_ALLOW_DISTRIBUTE #define INCLUDE_ALLOW_VMCORE #include "includeCheck.h" #include "vm_basic_types.h" // For INLINE. #include "vm_basic_asm.h" // For Div64... #if defined __cplusplus extern "C" { #endif static INLINE uint32 RatioOf(uint32 numer1, uint32 numer2, uint32 denom) { uint64 numer = (uint64)numer1 * numer2; /* Calculate "(numer1 * numer2) / denom" avoiding round-off errors. */ #if defined(VMM) || !(defined(__i386__) || defined(__x86_64__)) return numer / denom; #else uint32 ratio; uint32 unused; Div643232(numer, denom, &ratio, &unused); return ratio; #endif } static INLINE uint32 ExponentialAvg(uint32 avg, uint32 value, uint32 gainNumer, uint32 gainDenom) { uint32 term1 = gainNumer * avg; uint32 term2 = (gainDenom - gainNumer) * value; return (term1 + term2) / gainDenom; } /* *----------------------------------------------------------------------------- * * IsZeroOrPowerOfTwo -- * IsZeroOrPowerOfTwo64 -- * * Results: * TRUE iff the value is 0 or a power of two. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE Bool IsZeroOrPowerOfTwo64(uint64 x) { return !(x & (x - 1)); } static INLINE Bool IsZeroOrPowerOfTwo(uint32 x) // IN { return !(x & (x - 1)); } static INLINE uint32 GetPowerOfTwo(uint32 x) { /* Returns next-greatest power-of-two. */ uint32 power2 = 1; while (x > power2) { power2 = power2 << 1; } return power2; } #if !defined(_WIN32) && !defined(_WIN64) /* *----------------------------------------------------------------------------- * * RotateLeft32 -- * * Results: * Value rotated to the left by 'shift' bits. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE uint32 RotateLeft32(uint32 value, uint8 shift) { return ((value << shift) | (value >> (32 - shift))); } /* *----------------------------------------------------------------------------- * * RotateRight32 -- * * Results: * Value rotated to the right by 'shift' bits. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE uint32 RotateRight32(uint32 value, uint8 shift) { return ((value >> shift) | (value << (32 - shift))); } /* *----------------------------------------------------------------------------- * * RotateLeft64 -- * * Results: * Value rotated to the left by 'shift' bits. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE uint64 RotateLeft64(uint64 value, uint8 shift) { return ((value << shift) | (value >> (64 - shift))); } /* *----------------------------------------------------------------------------- * * RotateRight64 -- * * Results: * Value rotated to the right by 'shift' bits. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE uint64 RotateRight64(uint64 value, uint8 shift) { return ((value >> shift) | (value << (64 - shift))); } #endif // if !defined(_WIN32) && !defined(_WIN64) #if defined __cplusplus } // extern "C" #endif #endif // ifndef _VM_BASIC_MATH_H_ vmci-only/shared/compat_slab.h 0000444 0000000 0000000 00000006653 13432725347 015416 0 ustar root root /********************************************************* * Copyright (C) 2005 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 * *********************************************************/ #ifndef __COMPAT_SLAB_H__ # define __COMPAT_SLAB_H__ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 2, 0) # include <linux/slab.h> #else # include <linux/malloc.h> #endif /* * Before 2.6.20, kmem_cache_t was the accepted way to refer to a kmem_cache * structure. Prior to 2.6.15, this structure was called kmem_cache_s, and * afterwards it was renamed to kmem_cache. Here we keep things simple and use * the accepted typedef until it became deprecated, at which point we switch * over to the kmem_cache name. */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 20) # define compat_kmem_cache struct kmem_cache #else # define compat_kmem_cache kmem_cache_t #endif /* * Up to 2.6.22 kmem_cache_create has 6 arguments - name, size, alignment, flags, * constructor, and destructor. Then for some time kernel was asserting that * destructor is NULL, and since 2.6.23-pre1 kmem_cache_create takes only 5 * arguments - destructor is gone. */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 22) || defined(VMW_KMEMCR_HAS_DTOR) #define compat_kmem_cache_create(name, size, align, flags, ctor) \ kmem_cache_create(name, size, align, flags, ctor, NULL) #else #define compat_kmem_cache_create(name, size, align, flags, ctor) \ kmem_cache_create(name, size, align, flags, ctor) #endif /* * Up to 2.6.23 kmem_cache constructor has three arguments - pointer to block to * prepare (aka "this"), from which cache it came, and some unused flags. After * 2.6.23 flags were removed, and order of "this" and cache parameters was swapped... * Since 2.6.27-rc2 everything is different again, and ctor has only one argument. * * HAS_3_ARGS has precedence over HAS_2_ARGS if both are defined. */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 23) && !defined(VMW_KMEMCR_CTOR_HAS_3_ARGS) # define VMW_KMEMCR_CTOR_HAS_3_ARGS #endif #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 26) && !defined(VMW_KMEMCR_CTOR_HAS_2_ARGS) # define VMW_KMEMCR_CTOR_HAS_2_ARGS #endif #if defined(VMW_KMEMCR_CTOR_HAS_3_ARGS) typedef void compat_kmem_cache_ctor(void *, compat_kmem_cache *, unsigned long); #define COMPAT_KMEM_CACHE_CTOR_ARGS(arg) void *arg, \ compat_kmem_cache *cache, \ unsigned long flags #elif defined(VMW_KMEMCR_CTOR_HAS_2_ARGS) typedef void compat_kmem_cache_ctor(compat_kmem_cache *, void *); #define COMPAT_KMEM_CACHE_CTOR_ARGS(arg) compat_kmem_cache *cache, \ void *arg #else typedef void compat_kmem_cache_ctor(void *); #define COMPAT_KMEM_CACHE_CTOR_ARGS(arg) void *arg #endif #endif /* __COMPAT_SLAB_H__ */ vmci-only/shared/compat_mm.h 0000444 0000000 0000000 00000003002 13432725347 015067 0 ustar root root /********************************************************* * Copyright (C) 2002 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 * *********************************************************/ #ifndef __COMPAT_MM_H__ # define __COMPAT_MM_H__ #include <linux/mm.h> /* 2.2.x uses 0 instead of some define */ #ifndef NOPAGE_SIGBUS #define NOPAGE_SIGBUS (0) #endif /* 2.2.x does not have HIGHMEM support */ #ifndef GFP_HIGHUSER #define GFP_HIGHUSER (GFP_USER) #endif /* * In 2.4.14, the logic behind the UnlockPage macro was moved to the * unlock_page() function. Later (in 2.5.12), the UnlockPage macro was removed * altogether, and nowadays everyone uses unlock_page(). */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 14) #define compat_unlock_page(page) UnlockPage(page) #else #define compat_unlock_page(page) unlock_page(page) #endif #endif /* __COMPAT_MM_H__ */ vmci-only/shared/driver-config.h 0000444 0000000 0000000 00000004314 13432725347 015660 0 ustar root root /********************************************************* * Copyright (C) 1998 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 * *********************************************************/ /* * Sets the proper defines from the Linux header files * * This file must be included before the inclusion of any kernel header file, * with the exception of linux/autoconf.h and linux/version.h --hpreg */ #ifndef __VMX_CONFIG_H__ #define __VMX_CONFIG_H__ #define INCLUDE_ALLOW_VMCORE #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_DISTRIBUTE #define INCLUDE_ALLOW_VMKDRIVERS #include "includeCheck.h" #include "compat_version.h" #include "compat_autoconf.h" /* * We rely on Kernel Module support. Check here. */ #ifndef CONFIG_MODULES # error "No Module support in this kernel. Please configure with CONFIG_MODULES" #endif /* * 2.2 kernels still use __SMP__ (derived from CONFIG_SMP * in the main Makefile), so we do it here. */ #ifdef CONFIG_SMP # define __SMP__ 1 #endif #if defined(CONFIG_MODVERSIONS) && defined(KERNEL_2_1) # if LINUX_VERSION_CODE < KERNEL_VERSION(2,5,60) /* * MODVERSIONS might be already defined when using kernel's Makefiles. */ # ifndef MODVERSIONS # define MODVERSIONS # endif # include <linux/modversions.h> # endif #endif #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 24) /* * Force the uintptr_t definition to come from linux/types.h instead of vm_basic_types.h. */ # include <linux/types.h> # define _STDINT_H 1 #endif #ifndef __KERNEL__ # define __KERNEL__ #endif #endif vmci-only/shared/vmciQueue.h 0000444 0000000 0000000 00000017362 13432725350 015066 0 ustar root root /********************************************************* * Copyright (C) 2010 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 * *********************************************************/ #ifndef _VMCI_QUEUE_H_ #define _VMCI_QUEUE_H_ /* * * vmciQueue.h -- * * Defines the queue structure, and helper functions to enqueue and dequeue * items. XXX needs checksumming? */ #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMX #define INCLUDE_ALLOW_VMK_MODULE #define INCLUDE_ALLOW_VMKERNEL #include "includeCheck.h" #if defined(__APPLE__) # include <sys/uio.h> #endif #if defined VMKERNEL # include "vm_atomic.h" # include "return_status.h" # include "util_copy_dist.h" #endif #if defined __cplusplus extern "C" { #endif /* * VMCIQueue * * This data type contains the information about a queue. * * There are two queues (hence, queue pairs) per transaction model between a * pair of end points, A & B. One queue is used by end point A to transmit * commands and responses to B. The other queue is used by B to transmit * commands and responses. * * VMCIQueueKernelIf is a per-OS defined Queue structure. It contains either a * direct pointer to the linear address of the buffer contents or a pointer to * structures which help the OS locate those data pages. See vmciKernelIf.c * for each platform for its definition. */ typedef struct VMCIQueueKernelIf VMCIQueueKernelIf; typedef struct VMCIQueue { VMCIQueueHeader *qHeader; VMCIQueueHeader *savedHeader; VMCIQueueKernelIf *kernelIf; } VMCIQueue; /* * ESX uses a buffer type for the memcpy functions. Currently, none * of the hosted products use such a field. And, to keep the function * definitions simple, we use a define to declare the type parameter. */ #ifdef VMKERNEL #define BUF_TYPE Util_BufferType #else #define BUF_TYPE int #endif /* *----------------------------------------------------------------------------- * * VMCIMemcpy{To,From}QueueFunc() prototypes. Functions of these * types are passed around to enqueue and dequeue routines. Note that * often the functions passed are simply wrappers around memcpy * itself. * * Note: In order for the memcpy typedefs to be compatible with the VMKernel, * there's an unused last parameter for the hosted side. In * ESX, that parameter holds a buffer type. * *----------------------------------------------------------------------------- */ typedef int VMCIMemcpyToQueueFunc(VMCIQueue *queue, uint64 queueOffset, const void *src, size_t srcOffset, size_t size, BUF_TYPE bufType, Bool canBlock); typedef int VMCIMemcpyFromQueueFunc(void *dest, size_t destOffset, const VMCIQueue *queue, uint64 queueOffset, size_t size, BUF_TYPE bufType, Bool canBlock); #if defined(_WIN32) && defined(WINNT_DDK) /* * Windows needs iovec for the V functions. We use an MDL for the actual * buffers, but we also have an offset that comes from WSK_BUF. */ struct iovec { PMDL mdl; // List of memory descriptors. ULONG offset; // Base offset. }; #endif // _WIN32 && WINNT_DDK /* *----------------------------------------------------------------------------- * * VMCIMemcpy{To,From}Queue[V][Local]() prototypes * * Note that these routines are NOT SAFE to call on a host end-point * until the guest end of the queue pair has attached -AND- * SetPageStore(). The VMX crosstalk device will issue the * SetPageStore() on behalf of the guest when the guest creates a * QueuePair or attaches to one created by the host. So, if the guest * notifies the host that it's attached then the queue is safe to use. * Also, if the host registers notification of the connection of the * guest, then it will only receive that notification when the guest * has issued the SetPageStore() call and not before (when the guest * had attached). * *----------------------------------------------------------------------------- */ int VMCIMemcpyToQueue(VMCIQueue *queue, uint64 queueOffset, const void *src, size_t srcOffset, size_t size, BUF_TYPE bufType, Bool canBlock); int VMCIMemcpyFromQueue(void *dest, size_t destOffset, const VMCIQueue *queue, uint64 queueOffset, size_t size, BUF_TYPE bufType, Bool canBlock); int VMCIMemcpyToQueueLocal(VMCIQueue *queue, uint64 queueOffset, const void *src, size_t srcOffset, size_t size, BUF_TYPE bufType, Bool canBlock); int VMCIMemcpyFromQueueLocal(void *dest, size_t destOffset, const VMCIQueue *queue, uint64 queueOffset, size_t size, BUF_TYPE bufType, Bool canBlock); #if defined VMKERNEL || \ (defined(__APPLE__) && !defined (VMX86_TOOLS)) || \ (defined(__linux__) && defined(__KERNEL__)) || \ (defined(_WIN32) && defined(WINNT_DDK)) int VMCIMemcpyToQueueV(VMCIQueue *queue, uint64 queueOffset, const void *src, size_t srcOffset, size_t size, BUF_TYPE bufType, Bool canBlock); int VMCIMemcpyFromQueueV(void *dest, size_t destOffset, const VMCIQueue *queue, uint64 queueOffset, size_t size, BUF_TYPE bufType, Bool canBlock); # if defined(VMKERNEL) int VMCIMemcpyToQueueVLocal(VMCIQueue *queue, uint64 queueOffset, const void *src, size_t srcOffset, size_t size, BUF_TYPE bufType, Bool canBlock); int VMCIMemcpyFromQueueVLocal(void *dest, size_t destOffset, const VMCIQueue *queue, uint64 queueOffset, size_t size, BUF_TYPE bufType, Bool canBlock); # else /* * For non-vmkernel platforms, the local versions are identical to the * non-local ones. */ static INLINE int VMCIMemcpyToQueueVLocal(VMCIQueue *queue, // IN/OUT uint64 queueOffset, // IN const void *src, // IN: iovec size_t srcOffset, // IN size_t size, // IN BUF_TYPE bufType, // IN Bool canBlock) // IN { return VMCIMemcpyToQueueV(queue, queueOffset, src, srcOffset, size, bufType, canBlock); } static INLINE int VMCIMemcpyFromQueueVLocal(void *dest, // IN/OUT: iovec size_t destOffset, // IN const VMCIQueue *queue, // IN uint64 queueOffset, // IN size_t size, // IN BUF_TYPE bufType, // IN Bool canBlock) // IN { return VMCIMemcpyFromQueueV(dest, destOffset, queue, queueOffset, size, bufType, canBlock); } # endif /* !VMKERNEL */ #endif /* Does the O/S support iovec? */ #if defined __cplusplus } // extern "C" #endif #endif /* !_VMCI_QUEUE_H_ */ vmci-only/shared/x86cpuid_asm.h 0000444 0000000 0000000 00000023356 13432725350 015435 0 ustar root root /********************************************************* * Copyright (C) 2003-2017 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 * *********************************************************/ /* * x86cpuid_asm.h * * CPUID-related assembly functions. */ #ifndef _X86CPUID_ASM_H_ #define _X86CPUID_ASM_H_ #define INCLUDE_ALLOW_USERLEVEL #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMK_MODULE #define INCLUDE_ALLOW_VMKERNEL #define INCLUDE_ALLOW_DISTRIBUTE #define INCLUDE_ALLOW_VMCORE #include "includeCheck.h" #include "vm_basic_asm.h" #include "x86cpuid.h" /* * x86-64 windows doesn't support inline asm so we have to use these * intrinsic functions defined in the compiler. Not all of these are well * documented. There is an array in the compiler dll (c1.dll) which has * an array of the names of all the intrinsics minus the leading * underscore. Searching around in the ntddk.h file can also be helpful. * * The declarations for the intrinsic functions were taken from the DDK. * Our declarations must match the ddk's otherwise the 64-bit c++ compiler * will complain about second linkage of the intrinsic functions. * We define the intrinsic using the basic types corresponding to the * Windows typedefs. This avoids having to include windows header files * to get to the windows types. */ #ifdef _MSC_VER #ifdef __cplusplus extern "C" { #endif #ifdef VM_X86_64 /* * intrinsic functions only supported by x86-64 windows as of 2k3sp1 */ void __cpuid(int regs[4], int eax); #pragma intrinsic(__cpuid) /* * __cpuidex has been supported since VS2008 */ #if _MSC_VER >= 1500 void __cpuidex(int regs[4], int eax, int ecx); #pragma intrinsic(__cpuidex) #endif /* _MSC_VER >= 1500 */ #endif /* VM_X86_64 */ #ifdef __cplusplus } #endif #endif /* _MSC_VER */ #ifdef __GNUC__ // { /* * Checked against the Intel manual and GCC --hpreg * * Need __volatile__ and "memory" since CPUID has a synchronizing effect. * The CPUID may also change at runtime (APIC flag, etc). * */ /* * %ebx is reserved on i386 PIC. Apple's gcc-5493 (gcc 4.0) compiling * for x86_64 incorrectly errors out saying %ebx is reserved. This is * Apple bug 7304232. */ #if vm_x86_64 ? (defined __APPLE_CC__ && __APPLE_CC__ == 5493) : defined __PIC__ #if vm_x86_64 /* * Note that this generates movq %rbx,%rbx; cpuid; xchgq %rbx,%rbx ... * Unfortunately Apple's assembler does not have .ifnes, and I cannot * figure out how to do that with .if. If we ever enable this code * on other 64bit systems, both movq & xchgq should be surrounded by * .ifnes \"%%rbx\", \"%q1\" & .endif */ #define VM_CPUID_BLOCK "movq %%rbx, %q1\n\t" \ "cpuid\n\t" \ "xchgq %%rbx, %q1\n\t" #define VM_EBX_OUT(reg) "=&r"(reg) #else #define VM_CPUID_BLOCK "movl %%ebx, %1\n\t" \ "cpuid\n\t" \ "xchgl %%ebx, %1\n\t" #define VM_EBX_OUT(reg) "=&rm"(reg) #endif #else #define VM_CPUID_BLOCK "cpuid" #define VM_EBX_OUT(reg) "=b"(reg) #endif static INLINE void __GET_CPUID(int eax, // IN CPUIDRegs *regs) // OUT { __asm__ __volatile__( VM_CPUID_BLOCK : "=a" (regs->eax), VM_EBX_OUT(regs->ebx), "=c" (regs->ecx), "=d" (regs->edx) : "a" (eax) : "memory" ); } static INLINE void __GET_CPUID2(int eax, // IN int ecx, // IN CPUIDRegs *regs) // OUT { __asm__ __volatile__( VM_CPUID_BLOCK : "=a" (regs->eax), VM_EBX_OUT(regs->ebx), "=c" (regs->ecx), "=d" (regs->edx) : "a" (eax), "c" (ecx) : "memory" ); } static INLINE uint32 __GET_EAX_FROM_CPUID(int eax) // IN { uint32 ebx; __asm__ __volatile__( VM_CPUID_BLOCK : "=a" (eax), VM_EBX_OUT(ebx) : "a" (eax) : "memory", "%ecx", "%edx" ); return eax; } static INLINE uint32 __GET_EBX_FROM_CPUID(int eax) // IN { uint32 ebx; __asm__ __volatile__( VM_CPUID_BLOCK : "=a" (eax), VM_EBX_OUT(ebx) : "a" (eax) : "memory", "%ecx", "%edx" ); return ebx; } static INLINE uint32 __GET_ECX_FROM_CPUID(int eax) // IN { uint32 ecx; uint32 ebx; __asm__ __volatile__( VM_CPUID_BLOCK : "=a" (eax), VM_EBX_OUT(ebx), "=c" (ecx) : "a" (eax) : "memory", "%edx" ); return ecx; } static INLINE uint32 __GET_EDX_FROM_CPUID(int eax) // IN { uint32 edx; uint32 ebx; __asm__ __volatile__( VM_CPUID_BLOCK : "=a" (eax), VM_EBX_OUT(ebx), "=d" (edx) : "a" (eax) : "memory", "%ecx" ); return edx; } static INLINE uint32 __GET_EAX_FROM_CPUID4(int ecx) // IN { uint32 eax; uint32 ebx; __asm__ __volatile__( VM_CPUID_BLOCK : "=a" (eax), VM_EBX_OUT(ebx), "=c" (ecx) : "a" (4), "c" (ecx) : "memory", "%edx" ); return eax; } #undef VM_CPUID_BLOCK #undef VM_EBX_OUT #elif defined(_MSC_VER) // } { static INLINE void __GET_CPUID(int input, CPUIDRegs *regs) { #ifdef VM_X86_64 __cpuid((int *)regs, input); #else __asm push esi __asm push ebx __asm push ecx __asm push edx __asm mov eax, input __asm mov esi, regs __asm _emit 0x0f __asm _emit 0xa2 __asm mov 0x0[esi], eax __asm mov 0x4[esi], ebx __asm mov 0x8[esi], ecx __asm mov 0xC[esi], edx __asm pop edx __asm pop ecx __asm pop ebx __asm pop esi #endif } #ifdef VM_X86_64 #if _MSC_VER >= 1500 /* * __cpuidex has been supported since VS2008 */ static INLINE void __GET_CPUID2(int inputEax, int inputEcx, CPUIDRegs *regs) { __cpuidex((int *)regs, inputEax, inputEcx); } #else // _MSC_VER >= 1500 /* * No inline assembly in Win64. Implemented in bora/lib/misc in * cpuidMasm64.asm. */ extern void __GET_CPUID2(int inputEax, int inputEcx, CPUIDRegs *regs); #endif // _MSC_VER >= 1500 #else // VM_X86_64 static INLINE void __GET_CPUID2(int inputEax, int inputEcx, CPUIDRegs *regs) { __asm push esi __asm push ebx __asm push ecx __asm push edx __asm mov eax, inputEax __asm mov ecx, inputEcx __asm mov esi, regs __asm _emit 0x0f __asm _emit 0xa2 __asm mov 0x0[esi], eax __asm mov 0x4[esi], ebx __asm mov 0x8[esi], ecx __asm mov 0xC[esi], edx __asm pop edx __asm pop ecx __asm pop ebx __asm pop esi } #endif static INLINE uint32 __GET_EAX_FROM_CPUID(int input) { #ifdef VM_X86_64 CPUIDRegs regs; __cpuid((int *)®s, input); return regs.eax; #else uint32 output; //NOT_TESTED(); __asm push ebx __asm push ecx __asm push edx __asm mov eax, input __asm _emit 0x0f __asm _emit 0xa2 __asm mov output, eax __asm pop edx __asm pop ecx __asm pop ebx return output; #endif } static INLINE uint32 __GET_EBX_FROM_CPUID(int input) { #ifdef VM_X86_64 CPUIDRegs regs; __cpuid((int *)®s, input); return regs.ebx; #else uint32 output; //NOT_TESTED(); __asm push ebx __asm push ecx __asm push edx __asm mov eax, input __asm _emit 0x0f __asm _emit 0xa2 __asm mov output, ebx __asm pop edx __asm pop ecx __asm pop ebx return output; #endif } static INLINE uint32 __GET_ECX_FROM_CPUID(int input) { #ifdef VM_X86_64 CPUIDRegs regs; __cpuid((int *)®s, input); return regs.ecx; #else uint32 output; //NOT_TESTED(); __asm push ebx __asm push ecx __asm push edx __asm mov eax, input __asm _emit 0x0f __asm _emit 0xa2 __asm mov output, ecx __asm pop edx __asm pop ecx __asm pop ebx return output; #endif } static INLINE uint32 __GET_EDX_FROM_CPUID(int input) { #ifdef VM_X86_64 CPUIDRegs regs; __cpuid((int *)®s, input); return regs.edx; #else uint32 output; //NOT_TESTED(); __asm push ebx __asm push ecx __asm push edx __asm mov eax, input __asm _emit 0x0f __asm _emit 0xa2 __asm mov output, edx __asm pop edx __asm pop ecx __asm pop ebx return output; #endif } #ifdef VM_X86_64 /* * No inline assembly in Win64. Implemented in bora/lib/misc in * cpuidMasm64.asm. */ extern uint32 __GET_EAX_FROM_CPUID4(int inputEcx); #else // VM_X86_64 static INLINE uint32 __GET_EAX_FROM_CPUID4(int inputEcx) { uint32 output; //NOT_TESTED(); __asm push ebx __asm push ecx __asm push edx __asm mov eax, 4 __asm mov ecx, inputEcx __asm _emit 0x0f __asm _emit 0xa2 __asm mov output, eax __asm pop edx __asm pop ecx __asm pop ebx return output; } #endif // VM_X86_64 #else // } #error #endif #define CPUID_FOR_SIDE_EFFECTS() ((void)__GET_EAX_FROM_CPUID(0)) /* The first parameter is used as an rvalue and then as an lvalue. */ #define GET_CPUID(_ax, _bx, _cx, _dx) { \ CPUIDRegs regs; \ __GET_CPUID(_ax, ®s); \ _ax = regs.eax; \ _bx = regs.ebx; \ _cx = regs.ecx; \ _dx = regs.edx; \ } #define GET_CPUID2(_ax, _bx, _cx, _dx) {\ CPUIDRegs regs; \ __GET_CPUID2(_ax, _cx, ®s); \ _ax = regs.eax; \ _bx = regs.ebx; \ _cx = regs.ecx; \ _dx = regs.edx; \ } #endif vmci-only/shared/vmci_call_defs.h 0000444 0000000 0000000 00000023713 13432725350 016052 0 ustar root root /********************************************************* * Copyright (C) 2006-2016,2018 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 * *********************************************************/ #ifndef _VMCI_CALL_DEFS_H_ #define _VMCI_CALL_DEFS_H_ #define INCLUDE_ALLOW_USERLEVEL #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMCORE #define INCLUDE_ALLOW_VMKMOD #define INCLUDE_ALLOW_VMKERNEL #define INCLUDE_ALLOW_DISTRIBUTE #include "includeCheck.h" #include "vm_basic_types.h" #include "vmci_defs.h" #if defined __cplusplus extern "C" { #endif /* * All structs here are an integral size of their largest member, ie. a struct * with at least one 8-byte member will have a size that is an integral of 8. * A struct which has a largest member of size 4 will have a size that is an * integral of 4. This is because Windows CL enforces this rule. 32 bit gcc * doesn't e.g. 32 bit gcc can misalign an 8 byte member if it is preceeded by * a 4 byte member. */ /* * Base struct for vmci datagrams. */ typedef struct VMCIDatagram { VMCIHandle dst; VMCIHandle src; uint64 payloadSize; } VMCIDatagram; /* * Second flag is for creating a well-known handle instead of a per context * handle. Next flag is for deferring datagram delivery, so that the * datagram callback is invoked in a delayed context (not interrupt context). */ #define VMCI_FLAG_DG_NONE 0 #define VMCI_FLAG_WELLKNOWN_DG_HND 0x1 #define VMCI_FLAG_ANYCID_DG_HND 0x2 #define VMCI_FLAG_DG_DELAYED_CB 0x4 /* Event callback should fire in a delayed context (not interrupt context.) */ #define VMCI_FLAG_EVENT_NONE 0 #define VMCI_FLAG_EVENT_DELAYED_CB 0x1 /* * Maximum supported size of a VMCI datagram for routable datagrams. * Datagrams going to the hypervisor are allowed to be larger. */ #define VMCI_MAX_DG_SIZE (17 * 4096) #define VMCI_MAX_DG_PAYLOAD_SIZE (VMCI_MAX_DG_SIZE - sizeof(VMCIDatagram)) #define VMCI_DG_PAYLOAD(_dg) (void *)((char *)(_dg) + sizeof(VMCIDatagram)) #define VMCI_DG_HEADERSIZE sizeof(VMCIDatagram) #define VMCI_DG_SIZE(_dg) (VMCI_DG_HEADERSIZE + (size_t)(_dg)->payloadSize) #define VMCI_DG_SIZE_ALIGNED(_dg) ((VMCI_DG_SIZE(_dg) + 7) & (size_t)~7) #define VMCI_MAX_DATAGRAM_QUEUE_SIZE (VMCI_MAX_DG_SIZE * 2) /* * We allow at least 1024 more event datagrams from the hypervisor past the * normally allowed datagrams pending for a given context. We define this * limit on event datagrams from the hypervisor to guard against DoS attack * from a malicious VM which could repeatedly attach to and detach from a queue * pair, causing events to be queued at the destination VM. However, the rate * at which such events can be generated is small since it requires a VM exit * and handling of queue pair attach/detach call at the hypervisor. Event * datagrams may be queued up at the destination VM if it has interrupts * disabled or if it is not draining events for some other reason. 1024 * datagrams is a grossly conservative estimate of the time for which * interrupts may be disabled in the destination VM, but at the same time does * not exacerbate the memory pressure problem on the host by much (size of each * event datagram is small). */ #define VMCI_MAX_DATAGRAM_AND_EVENT_QUEUE_SIZE \ (VMCI_MAX_DATAGRAM_QUEUE_SIZE + \ 1024 * (sizeof(VMCIDatagram) + sizeof(VMCIEventData_Max))) /* * Struct for sending VMCI_DATAGRAM_REQUEST_MAP and * VMCI_DATAGRAM_REMOVE_MAP datagrams. Struct size is 32 bytes. All * fields in struct are aligned to their natural alignment. These * datagrams are obsoleted by the removal of VM to VM communication. */ typedef struct VMCIDatagramWellKnownMapMsg { VMCIDatagram hdr; VMCIId wellKnownID; uint32 _pad; } VMCIDatagramWellKnownMapMsg; /* * Struct used for querying, via VMCI_RESOURCES_QUERY, the availability of * hypervisor resources. * Struct size is 16 bytes. All fields in struct are aligned to their natural * alignment. */ typedef struct VMCIResourcesQueryHdr { VMCIDatagram hdr; uint32 numResources; uint32 _padding; } VMCIResourcesQueryHdr; /* * Convenience struct for negotiating vectors. Must match layout of * VMCIResourceQueryHdr minus the VMCIDatagram header. */ typedef struct VMCIResourcesQueryMsg { uint32 numResources; uint32 _padding; VMCI_Resource resources[1]; } VMCIResourcesQueryMsg; /* * The maximum number of resources that can be queried using * VMCI_RESOURCE_QUERY is 31, as the result is encoded in the lower 31 * bits of a positive return value. Negative values are reserved for * errors. */ #define VMCI_RESOURCE_QUERY_MAX_NUM 31 /* Maximum size for the VMCI_RESOURCE_QUERY request. */ #define VMCI_RESOURCE_QUERY_MAX_SIZE sizeof(VMCIResourcesQueryHdr) \ + VMCI_RESOURCE_QUERY_MAX_NUM * sizeof(VMCI_Resource) /* * Struct used for setting the notification bitmap. All fields in * struct are aligned to their natural alignment. */ typedef struct VMCINotifyBitmapSetMsg { VMCIDatagram hdr; PPN32 bitmapPPN; uint32 _pad; } VMCINotifyBitmapSetMsg; /* * Struct used for linking a doorbell handle with an index in the * notify bitmap. All fields in struct are aligned to their natural * alignment. */ typedef struct VMCIDoorbellLinkMsg { VMCIDatagram hdr; VMCIHandle handle; uint64 notifyIdx; } VMCIDoorbellLinkMsg; /* * Struct used for unlinking a doorbell handle from an index in the * notify bitmap. All fields in struct are aligned to their natural * alignment. */ typedef struct VMCIDoorbellUnlinkMsg { VMCIDatagram hdr; VMCIHandle handle; } VMCIDoorbellUnlinkMsg; /* * Struct used for generating a notification on a doorbell handle. All * fields in struct are aligned to their natural alignment. */ typedef struct VMCIDoorbellNotifyMsg { VMCIDatagram hdr; VMCIHandle handle; } VMCIDoorbellNotifyMsg; /* * This struct is used to contain data for events. Size of this struct is a * multiple of 8 bytes, and all fields are aligned to their natural alignment. */ typedef struct VMCI_EventData { VMCI_Event event; /* 4 bytes. */ uint32 _pad; /* * Event payload is put here. */ } VMCI_EventData; /* Callback needed for correctly waiting on events. */ typedef int (*VMCIDatagramRecvCB)(void *clientData, // IN: client data for handler VMCIDatagram *msg); // IN: /* * We use the following inline function to access the payload data associated * with an event data. */ static INLINE void * VMCIEventDataPayload(VMCI_EventData *evData) // IN: { return (void *)((char *)evData + sizeof *evData); } /* * Define the different VMCI_EVENT payload data types here. All structs must * be a multiple of 8 bytes, and fields must be aligned to their natural * alignment. */ typedef struct VMCIEventPayload_Context { VMCIId contextID; /* 4 bytes. */ uint32 _pad; } VMCIEventPayload_Context; typedef struct VMCIEventPayload_QP { VMCIHandle handle; /* QueuePair handle. */ VMCIId peerId; /* Context id of attaching/detaching VM. */ uint32 _pad; } VMCIEventPayload_QP; /* * We define the following struct to get the size of the maximum event data * the hypervisor may send to the guest. If adding a new event payload type * above, add it to the following struct too (inside the union). */ typedef struct VMCIEventData_Max { VMCI_EventData eventData; union { VMCIEventPayload_Context contextPayload; VMCIEventPayload_QP qpPayload; } evDataPayload; } VMCIEventData_Max; /* * Struct used for VMCI_EVENT_SUBSCRIBE/UNSUBSCRIBE and VMCI_EVENT_HANDLER * messages. Struct size is 32 bytes. All fields in struct are aligned to * their natural alignment. */ typedef struct VMCIEventMsg { VMCIDatagram hdr; VMCI_EventData eventData; /* Has event type and payload. */ /* * Payload gets put here. */ } VMCIEventMsg; /* * We use the following inline function to access the payload data associated * with an event message. */ static INLINE void * VMCIEventMsgPayload(VMCIEventMsg *eMsg) // IN: { return VMCIEventDataPayload(&eMsg->eventData); } /* Flags for VMCI QueuePair API. */ #define VMCI_QPFLAG_ATTACH_ONLY 0x1 /* Fail alloc if QP not created by peer. */ #define VMCI_QPFLAG_LOCAL 0x2 /* Only allow attaches from local context. */ #define VMCI_QPFLAG_NONBLOCK 0x4 /* Host won't block when guest is quiesced. */ /* For asymmetric queuepairs, update as new flags are added. */ #define VMCI_QP_ASYMM VMCI_QPFLAG_NONBLOCK #define VMCI_QP_ASYMM_PEER (VMCI_QPFLAG_ATTACH_ONLY | VMCI_QP_ASYMM) /* Update the following (bitwise OR flags) while adding new flags. */ #define VMCI_QP_ALL_FLAGS (VMCI_QPFLAG_ATTACH_ONLY | VMCI_QPFLAG_LOCAL | \ VMCI_QPFLAG_NONBLOCK) /* * Structs used for QueuePair alloc and detach messages. We align fields of * these structs to 64bit boundaries. */ typedef struct VMCIQueuePairAllocMsg { VMCIDatagram hdr; VMCIHandle handle; VMCIId peer; /* 32bit field. */ uint32 flags; uint64 produceSize; uint64 consumeSize; uint64 numPPNs; /* List of PPNs placed here. */ } VMCIQueuePairAllocMsg; typedef struct VMCIQueuePairDetachMsg { VMCIDatagram hdr; VMCIHandle handle; } VMCIQueuePairDetachMsg; #if defined __cplusplus } // extern "C" #endif #endif // _VMCI_CALL_DEFS_H_ vmci-only/shared/compat_interrupt.h 0000444 0000000 0000000 00000003573 13432725347 016527 0 ustar root root /********************************************************* * Copyright (C) 2003 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 * *********************************************************/ #ifndef __COMPAT_INTERRUPT_H__ # define __COMPAT_INTERRUPT_H__ #include <linux/interrupt.h> #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 5, 69) /* * We cannot just define irqreturn_t, as some 2.4.x kernels have * typedef void irqreturn_t; for "increasing" backward compatibility. */ typedef void compat_irqreturn_t; #define COMPAT_IRQ_NONE #define COMPAT_IRQ_HANDLED #define COMPAT_IRQ_RETVAL(x) #else typedef irqreturn_t compat_irqreturn_t; #define COMPAT_IRQ_NONE IRQ_NONE #define COMPAT_IRQ_HANDLED IRQ_HANDLED #define COMPAT_IRQ_RETVAL(x) IRQ_RETVAL(x) #endif #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 18) #define COMPAT_IRQF_DISABLED SA_INTERRUPT #define COMPAT_IRQF_SHARED SA_SHIRQ #else #define COMPAT_IRQF_DISABLED IRQF_DISABLED #define COMPAT_IRQF_SHARED IRQF_SHARED #endif #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 20) #define COMPAT_IRQ_HANDLER_ARGS(irq, devp) (int irq, void *devp, struct pt_regs *regs) #else #define COMPAT_IRQ_HANDLER_ARGS(irq, devp) (int irq, void *devp) #endif #endif /* __COMPAT_INTERRUPT_H__ */ vmci-only/COPYING 0000444 0000000 0000000 00000043103 13432725341 012527 0 ustar root root GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> 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; either version 2 of the License, or (at your option) any 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 Street, Fifth Floor, Boston, MA 02110-1301 USA. Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. <signature of Ty Coon>, 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. vmci-only/Makefile.normal 0000444 0000000 0000000 00000010550 13432725347 014431 0 ustar root root #!/usr/bin/make -f ########################################################## # Copyright (C) 2007 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 # ########################################################## vm_check_build = $(shell if $(CC) $(CC_OPTS) $(INCLUDE) -Werror -S -o /dev/null -xc $(1) \ > /dev/null 2>&1; then echo "$(2)"; else echo "$(3)"; fi) #### #### DESTDIR is where the module, object files, and dependencies are built #### DESTDIR := driver-$(VM_UNAME) #### #### DRIVERNAME should be untouched unless you have a good reason to change #### it. The form below is how the scripts expect it. #### DRIVERNAME := $(DRIVER)-xxx-$(VM_UNAME) ifneq (,$(filter x86_64%, $(shell $(CC) -dumpmachine))) MACHINE := x86_64 else MACHINE := x386 endif ifdef QUIET ECHO := @true else ECHO := @echo endif #### #### You must compile with at least -O level of optimization #### or the module won't load. #### If desparate, I think that bringing in <linux/bitops.h> might #### suffice. #### CC_WARNINGS := -Wall -Wstrict-prototypes # Don't use -pipe or egcs-2.91.66 (shipped with RedHat) will die CC_KFLAGS := -D__KERNEL__ -fno-strength-reduce -fno-omit-frame-pointer \ -fno-common -DKBUILD_MODNAME=\"$(DRIVER)\" CC_KFLAGS += $(call vm_check_gcc,-falign-loops=2 -falign-jumps=2 -falign-functions=2, \ -malign-loops=2 -malign-jumps=2 -malign-functions=2) CC_KFLAGS += $(call vm_check_gcc,-fno-strict-aliasing,) ifeq ($(MACHINE),x86_64) CC_KFLAGS += -mno-red-zone -mcmodel=kernel else # Gcc 3.0 deprecates -m486 --hpreg CC_KFLAGS += -DCPU=586 $(call check_gcc,-march=i586,-m486) endif CC_OPTS := -O2 -DMODULE -DVMCI $(GLOBAL_DEFS) $(CC_KFLAGS) $(CC_WARNINGS) INCLUDE := -I$(SRCROOT)/shared -I$(SRCROOT)/common -I$(SRCROOT)/linux \ -I$(HEADER_DIR) INCLUDE += $(shell $(CC) $(INCLUDE) -E $(SRCROOT)/shared/autoconf/geninclude.c \ | sed -n -e 's!^APATH!-I$(HEADER_DIR)/asm!p') ifdef OVT_SOURCE_PATH DRIVERLOGPATH := $(OVT_SOURCE_DIR)/modules/linux/shared else DRIVERLOGPATH := $(SRCROOT)/shared endif C_TARGETS_LINUX := driver.o vmciKernelIf.o C_TARGETS_COMMON := vmciContext.o vmciDatagram.o vmciDriver.o \ vmciHashtable.o vmciResource.o \ vmciQueuePair.o vmciEvent.o vmciRoute.o C_TARGETS_LINUX_D := ${C_TARGETS_LINUX:.o=.d} C_TARGETS_COMMON_D := ${C_TARGETS_COMMON:.o=.d} C_TARGETS := $(C_TARGETS_LINUX) $(C_TARGETS_COMMON) driverLog.o #### #### Make Targets are beneath here. #### driver: setup deps $(MAKE) -C $(DESTDIR) -f ../Makefile SRCROOT=../$(SRCROOT) $(DRIVER).o \ INCLUDE_DEPS=1 setup: @if [ -d $(DESTDIR) ] ; then true ; else mkdir $(DESTDIR); chmod 755 $(DESTDIR) ; fi $(DRIVER) $(DRIVER).o: $(DRIVERNAME) cp -f $< $@ $(DRIVERNAME): $(C_TARGETS) $(ECHO) "Building $(DRIVERNAME)" ld -r -o $(DRIVERNAME) $(C_TARGETS) auto-build: $(MAKE) driver QUIET=1 cp -f $(DESTDIR)/$(DRIVERNAME) $(SRCROOT)/../$(DRIVER).o $(C_TARGETS_LINUX): %.o: $(SRCROOT)/linux/%.c $(ECHO) "Compiling linux/$(<F)" $(CC) $(CC_OPTS) $(INCLUDE) -c $< $(C_TARGETS_COMMON): %.o: $(SRCROOT)/common/%.c $(ECHO) "Compiling common/$(<F)" $(CC) $(CC_OPTS) $(INCLUDE) -c $< driverLog.o: $(DRIVERLOGPATH)/driverLog.c $(CC) $(CC_OPTS) $(INCLUDE) -c $< clean: rm -rf $(DESTDIR)/ $(C_TARGETS_COMMON_D): %.d: $(SRCROOT)/common/%.c $(ECHO) "Dependencies for $(<F)" $(CC) -MM $(CC_OPTS) $(INCLUDE) $< > $@ $(C_TARGETS_LINUX_D): %.d: $(SRCROOT)/linux/%.c $(ECHO) "Dependencies for $(<F)" $(CC) -MM $(CC_OPTS) $(INCLUDE) $< > $@ driverLog.d: $(DRIVERLOGPATH)/driverLog.c $(ECHO) "Dependencies for $(<F)" $(CC) -MM $(CC_OPTS) $(INCLUDE) $< > $@ deps: setup $(MAKE) -C $(DESTDIR) -f ../Makefile SRCROOT=../$(SRCROOT) driver_deps driver_deps: ${C_TARGETS:.o=.d} ifdef INCLUDE_DEPS include ${C_TARGETS:.o=.d} endif .SILENT: vmci-only/common/ 0000755 0000000 0000000 00000000000 13432726375 012775 5 ustar root root vmci-only/common/vmciDriver.h 0000444 0000000 0000000 00000006026 13432725347 015260 0 ustar root root /********************************************************* * Copyright (C) 2006-2013 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 * *********************************************************/ /* * vmciDriver.h -- * * VMCI host driver interface. */ #ifndef _VMCI_DRIVER_H_ #define _VMCI_DRIVER_H_ #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMCORE #define INCLUDE_ALLOW_VMKERNEL #include "includeCheck.h" #include "vmci_defs.h" #include "vmci_infrastructure.h" #include "vmciContext.h" /* * A few macros to encapsulate logging in common code. The macros * result in LOG/LOGThrottled on vmkernel and Log on hosted. */ #ifdef _WIN32 # include "vmciLog.h" #else // _WIN32 #if defined(VMKERNEL) && !defined(VMKERNEL_OFFSET_CHECKER) /* * LOGLEVEL_MODULE is defined in another header that gets included into the * dummy file used by the offsetchecker, which causes it to barf on the * redefinition. */ # define LOGLEVEL_MODULE_LEN 0 # define LOGLEVEL_MODULE VMCIVMK # include "log.h" # ifdef VMX86_LOG # define _VMCILOG(_args...) LOG(i, _args) # define VMCI_DEBUG_LOG(_level, _args) \ do { \ int i = _level; \ _VMCILOG _args ; \ } while(FALSE) # else // VMX86_LOG # define VMCI_DEBUG_LOG(_level, _args) # endif // VMX86_LOG #else // VMKERNEL # define VMCI_DEBUG_LEVEL 4 # define VMCI_DEBUG_LOG(_level, _args) \ do { \ if (_level < VMCI_DEBUG_LEVEL) { \ Log _args ; \ } \ } while(FALSE) #endif // VMKERNEL #define VMCI_LOG(_args) Log _args #define VMCI_WARNING(_args) Warning _args #endif // _WIN32 int VMCI_SharedInit(void); void VMCI_SharedCleanup(void); int VMCI_HostInit(void); void VMCI_HostCleanup(void); VMCIId VMCI_GetContextID(void); int VMCI_SendDatagram(VMCIDatagram *dg); void VMCIUtil_Init(void); void VMCIUtil_Exit(void); Bool VMCI_CheckHostCapabilities(void); void VMCI_ReadDatagramsFromPort(VMCIIoHandle ioHandle, VMCIIoPort dgInPort, uint8 *dgInBuffer, size_t dgInBufferSize); Bool VMCI_DeviceEnabled(void); #if defined(_WIN64) int VMCIDoSendDatagram(unsigned int dgSize, ULONG *dataPort, ULONG *resultPort, VMCIDatagram *dg); #endif // _WIN64 #endif // _VMCI_DRIVER_H_ vmci-only/common/vmciDriver.c 0000444 0000000 0000000 00000044460 13432725347 015257 0 ustar root root /********************************************************* * Copyright (C) 2006 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 * *********************************************************/ /* * vmciDriver.c -- * * VMCI initialization and ioctl handling. */ #include "vmci_kernel_if.h" #include "vm_assert.h" #include "vmci_defs.h" #include "vmci_infrastructure.h" #include "vmciCommonInt.h" #include "vmciContext.h" #include "vmciDatagram.h" #include "vmciDoorbell.h" #include "vmciDriver.h" #include "vmciEvent.h" #include "vmciHashtable.h" #include "vmciKernelAPI.h" #include "vmciQueuePair.h" #include "vmciResource.h" #if defined(VMKERNEL) # include "vmciVmkInt.h" # include "vm_libc.h" # include "helper_ext.h" #endif #define LGPFX "VMCI: " static VMCIId ctxUpdateSubID = VMCI_INVALID_ID; static VMCIContext *hostContext; static Atomic_uint32 vmContextID = { VMCI_INVALID_ID }; /* *---------------------------------------------------------------------- * * VMCI_HostInit -- * * Initializes the host driver specific components of VMCI. * * Results: * VMCI_SUCCESS if successful, appropriate error code otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ int VMCI_HostInit(void) { int result; /* * In theory, it is unsafe to pass an eventHnd of -1 to platforms which use * it (VMKernel/Windows/Mac OS at the time of this writing). In practice we * are fine though, because the event is never used in the case of the host * context. */ result = VMCIContext_InitContext(VMCI_HOST_CONTEXT_ID, VMCI_DEFAULT_PROC_PRIVILEGE_FLAGS, VMCI_HOST_CONTEXT_INVALID_EVENT, VMCI_VERSION, NULL, &hostContext); if (result < VMCI_SUCCESS) { VMCI_WARNING((LGPFX"Failed to initialize VMCIContext (result=%d).\n", result)); goto errorExit; } result = VMCIQPBroker_Init(); if (result < VMCI_SUCCESS) { goto hostContextExit; } VMCI_DEBUG_LOG(0, (LGPFX"host components initialized.\n")); return VMCI_SUCCESS; hostContextExit: VMCIContext_ReleaseContext(hostContext); errorExit: return result; } /* *---------------------------------------------------------------------- * * VMCI_HostCleanup -- * * Cleans up the host specific components of the VMCI module. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ void VMCI_HostCleanup(void) { VMCIContext_ReleaseContext(hostContext); VMCIQPBroker_Exit(); } #if defined(__APPLE__) || defined(VMKERNEL) /* Windows has its own implementation of this, and Linux doesn't need one. */ /* *---------------------------------------------------------------------- * * vmci_device_get -- * * Verifies that a valid VMCI device is present, and indicates * the callers intention to use the device until it calls * VMCI_DeviceRelease(). * * Results: * TRUE if a valid VMCI device is present, FALSE otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_device_get) Bool vmci_device_get(uint32 *apiVersion, // IN/OUT VMCI_DeviceShutdownFn *deviceShutdownCB, // UNUSED void *userData, // UNUSED void **deviceRegistration) // OUT { if (NULL != deviceRegistration) { *deviceRegistration = NULL; } if (*apiVersion > VMCI_KERNEL_API_VERSION) { *apiVersion = VMCI_KERNEL_API_VERSION; return FALSE; } if (!VMCI_DeviceEnabled()) { return FALSE; } return TRUE; } /* *---------------------------------------------------------------------- * * vmci_device_release -- * * Indicates that the caller is done using the VMCI device. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_device_release) void vmci_device_release(void *deviceRegistration) // UNUSED { } #endif // __APPLE__ || VMKERNEL /* *----------------------------------------------------------------------------- * * VMCIUtilCidUpdate -- * * Gets called with the new context id if updated or resumed. * * Results: * Context id. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static void VMCIUtilCidUpdate(VMCIId subID, // IN: VMCI_EventData *eventData, // IN: void *clientData) // IN: { VMCIEventPayload_Context *evPayload = VMCIEventDataPayload(eventData); UNREFERENCED_PARAMETER(clientData); if (subID != ctxUpdateSubID) { VMCI_DEBUG_LOG(4, (LGPFX"Invalid subscriber (ID=0x%x).\n", subID)); return; } if (eventData == NULL || evPayload->contextID == VMCI_INVALID_ID) { VMCI_DEBUG_LOG(4, (LGPFX"Invalid event data.\n")); return; } VMCI_LOG((LGPFX"Updating context from (ID=0x%x) to (ID=0x%x) on event " "(type=%d).\n", Atomic_Read(&vmContextID), evPayload->contextID, eventData->event)); Atomic_Write(&vmContextID, evPayload->contextID); } /* *----------------------------------------------------------------------------- * * VMCIUtil_Init -- * * Subscribe to context id update event. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ void VMCIUtil_Init(void) { /* * We subscribe to the VMCI_EVENT_CTX_ID_UPDATE here so we can update the * internal context id when needed. */ if (vmci_event_subscribe(VMCI_EVENT_CTX_ID_UPDATE, #if !defined(__linux__) || defined(VMKERNEL) VMCI_FLAG_EVENT_NONE, #endif // !linux || VMKERNEL VMCIUtilCidUpdate, NULL, &ctxUpdateSubID) < VMCI_SUCCESS) { VMCI_WARNING((LGPFX"Failed to subscribe to event (type=%d).\n", VMCI_EVENT_CTX_ID_UPDATE)); } } /* *----------------------------------------------------------------------------- * * VMCIUtil_Exit -- * * Cleanup * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ void VMCIUtil_Exit(void) { if (vmci_event_unsubscribe(ctxUpdateSubID) < VMCI_SUCCESS) { VMCI_WARNING((LGPFX"Failed to unsubscribe to event (type=%d) with " "subscriber (ID=0x%x).\n", VMCI_EVENT_CTX_ID_UPDATE, ctxUpdateSubID)); } } /* *----------------------------------------------------------------------------- * * VMCIUtil_CheckHostCapabilities -- * * Verify that the host supports the hypercalls we need. If it does not, * try to find fallback hypercalls and use those instead. * * Results: * TRUE if required hypercalls (or fallback hypercalls) are * supported by the host, FALSE otherwise. * * Side effects: * None. * *----------------------------------------------------------------------------- */ #define VMCI_UTIL_NUM_RESOURCES 1 static Bool VMCIUtilCheckHostCapabilities(void) { int result; VMCIResourcesQueryMsg *msg; uint32 msgSize = sizeof(VMCIResourcesQueryHdr) + VMCI_UTIL_NUM_RESOURCES * sizeof(VMCI_Resource); VMCIDatagram *checkMsg = VMCI_AllocKernelMem(msgSize, VMCI_MEMORY_NONPAGED); if (checkMsg == NULL) { VMCI_WARNING((LGPFX"Check host: Insufficient memory.\n")); return FALSE; } checkMsg->dst = VMCI_MAKE_HANDLE(VMCI_HYPERVISOR_CONTEXT_ID, VMCI_RESOURCES_QUERY); checkMsg->src = VMCI_ANON_SRC_HANDLE; checkMsg->payloadSize = msgSize - VMCI_DG_HEADERSIZE; msg = (VMCIResourcesQueryMsg *)VMCI_DG_PAYLOAD(checkMsg); msg->numResources = VMCI_UTIL_NUM_RESOURCES; msg->resources[0] = VMCI_GET_CONTEXT_ID; result = VMCI_SendDatagram(checkMsg); VMCI_FreeKernelMem(checkMsg, msgSize); /* We need the vector. There are no fallbacks. */ return (result == 0x1); } /* *----------------------------------------------------------------------------- * * VMCI_CheckHostCapabilities -- * * Tell host which guestcalls we support and let each API check * that the host supports the hypercalls it needs. If a hypercall * is not supported, the API can check for a fallback hypercall, * or fail the check. * * Results: * TRUE if successful, FALSE otherwise. * * Side effects: * Fallback mechanisms may be enabled in the API and vmmon. * *----------------------------------------------------------------------------- */ Bool VMCI_CheckHostCapabilities(void) { Bool result = VMCIEvent_CheckHostCapabilities(); result &= VMCIDatagram_CheckHostCapabilities(); result &= VMCIUtilCheckHostCapabilities(); if (!result) { /* If it failed, then make sure this goes to the system event log. */ VMCI_WARNING((LGPFX"Host capability checked failed.\n")); } else { VMCI_DEBUG_LOG(0, (LGPFX"Host capability check passed.\n")); } return result; } /* *---------------------------------------------------------------------- * * VMCI_ReadDatagramsFromPort -- * * Reads datagrams from the data in port and dispatches them. We * always start reading datagrams into only the first page of the * datagram buffer. If the datagrams don't fit into one page, we * use the maximum datagram buffer size for the remainder of the * invocation. This is a simple heuristic for not penalizing * small datagrams. * * This function assumes that it has exclusive access to the data * in port for the duration of the call. * * Results: * No result. * * Side effects: * Datagram handlers may be invoked. * *---------------------------------------------------------------------- */ void VMCI_ReadDatagramsFromPort(VMCIIoHandle ioHandle, // IN VMCIIoPort dgInPort, // IN uint8 *dgInBuffer, // IN size_t dgInBufferSize) // IN { VMCIDatagram *dg; size_t currentDgInBufferSize = PAGE_SIZE; size_t remainingBytes; ASSERT(dgInBufferSize >= PAGE_SIZE); VMCI_ReadPortBytes(ioHandle, dgInPort, dgInBuffer, currentDgInBufferSize); dg = (VMCIDatagram *)dgInBuffer; remainingBytes = currentDgInBufferSize; while (dg->dst.resource != VMCI_INVALID_ID || remainingBytes > PAGE_SIZE) { size_t dgInSize; /* * When the input buffer spans multiple pages, a datagram can * start on any page boundary in the buffer. */ if (dg->dst.resource == VMCI_INVALID_ID) { ASSERT(remainingBytes > PAGE_SIZE); dg = (VMCIDatagram *)ROUNDUP((uintptr_t)dg + 1, PAGE_SIZE); ASSERT((uint8 *)dg < dgInBuffer + currentDgInBufferSize); remainingBytes = (size_t)(dgInBuffer + currentDgInBufferSize - (uint8 *)dg); continue; } dgInSize = VMCI_DG_SIZE_ALIGNED(dg); if (dgInSize <= dgInBufferSize) { int result; /* * If the remaining bytes in the datagram buffer doesn't * contain the complete datagram, we first make sure we have * enough room for it and then we read the reminder of the * datagram and possibly any following datagrams. */ if (dgInSize > remainingBytes) { if (remainingBytes != currentDgInBufferSize) { /* * We move the partial datagram to the front and read * the reminder of the datagram and possibly following * calls into the following bytes. */ memmove(dgInBuffer, dgInBuffer + currentDgInBufferSize - remainingBytes, remainingBytes); dg = (VMCIDatagram *)dgInBuffer; } if (currentDgInBufferSize != dgInBufferSize) { currentDgInBufferSize = dgInBufferSize; } VMCI_ReadPortBytes(ioHandle, dgInPort, dgInBuffer + remainingBytes, currentDgInBufferSize - remainingBytes); } /* We special case event datagrams from the hypervisor. */ if (dg->src.context == VMCI_HYPERVISOR_CONTEXT_ID && dg->dst.resource == VMCI_EVENT_HANDLER) { result = VMCIEvent_Dispatch(dg); } else { result = VMCIDatagram_InvokeGuestHandler(dg); } if (result < VMCI_SUCCESS) { VMCI_DEBUG_LOG(4, (LGPFX"Datagram with resource (ID=0x%x) failed " "(err=%d).\n", dg->dst.resource, result)); } /* On to the next datagram. */ dg = (VMCIDatagram *)((uint8 *)dg + dgInSize); } else { size_t bytesToSkip; /* * Datagram doesn't fit in datagram buffer of maximal size. We drop it. */ VMCI_DEBUG_LOG(4, (LGPFX"Failed to receive datagram (size=%"FMTSZ"u bytes).\n", dgInSize)); bytesToSkip = dgInSize - remainingBytes; if (currentDgInBufferSize != dgInBufferSize) { currentDgInBufferSize = dgInBufferSize; } for (;;) { VMCI_ReadPortBytes(ioHandle, dgInPort, dgInBuffer, currentDgInBufferSize); if (bytesToSkip <= currentDgInBufferSize) { break; } bytesToSkip -= currentDgInBufferSize; } dg = (VMCIDatagram *)(dgInBuffer + bytesToSkip); } remainingBytes = (size_t) (dgInBuffer + currentDgInBufferSize - (uint8 *)dg); if (remainingBytes < VMCI_DG_HEADERSIZE) { /* Get the next batch of datagrams. */ VMCI_ReadPortBytes(ioHandle, dgInPort, dgInBuffer, currentDgInBufferSize); dg = (VMCIDatagram *)dgInBuffer; remainingBytes = currentDgInBufferSize; } } } /* *---------------------------------------------------------------------------- * * vmci_get_context_id -- * * Returns the current context ID. Note that since this is accessed only * from code running in the host, this always returns the host context ID. * * Results: * Context ID. * * Side effects: * None. * *---------------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_get_context_id) VMCIId vmci_get_context_id(void) { if (VMCI_GuestPersonalityActive()) { if (Atomic_Read(&vmContextID) == VMCI_INVALID_ID) { uint32 result; VMCIDatagram getCidMsg; getCidMsg.dst = VMCI_MAKE_HANDLE(VMCI_HYPERVISOR_CONTEXT_ID, VMCI_GET_CONTEXT_ID); getCidMsg.src = VMCI_ANON_SRC_HANDLE; getCidMsg.payloadSize = 0; result = VMCI_SendDatagram(&getCidMsg); Atomic_Write(&vmContextID, result); } return Atomic_Read(&vmContextID); } else if (VMCI_HostPersonalityActive()) { return VMCI_HOST_CONTEXT_ID; } return VMCI_INVALID_ID; } /* *---------------------------------------------------------------------- * * vmci_version -- * * Returns the version of the VMCI driver. * * Results: * Returns a version number. * * Side effects: * None. * *---------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_version) uint32 vmci_version(void) { return VMCI_VERSION; } /* *---------------------------------------------------------------------- * * VMCI_SharedInit -- * * Initializes VMCI components shared between guest and host * driver. This registers core hypercalls. * * Results: * VMCI_SUCCESS if successful, appropriate error code otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ int VMCI_SharedInit(void) { int result; result = VMCIResource_Init(); if (result < VMCI_SUCCESS) { VMCI_WARNING((LGPFX"Failed to initialize VMCIResource (result=%d).\n", result)); goto errorExit; } result = VMCIContext_Init(); if (result < VMCI_SUCCESS) { VMCI_WARNING((LGPFX"Failed to initialize VMCIContext (result=%d).\n", result)); goto resourceExit; } result = VMCIDatagram_Init(); if (result < VMCI_SUCCESS) { VMCI_WARNING((LGPFX"Failed to initialize VMCIDatagram (result=%d).\n", result)); goto contextExit; } result = VMCIEvent_Init(); if (result < VMCI_SUCCESS) { VMCI_WARNING((LGPFX"Failed to initialize VMCIEvent (result=%d).\n", result)); goto datagramExit; } result = VMCIDoorbell_Init(); if (result < VMCI_SUCCESS) { VMCI_WARNING((LGPFX"Failed to initialize VMCIDoorbell (result=%d).\n", result)); goto eventExit; } VMCI_DEBUG_LOG(0, (LGPFX"shared components initialized.\n")); return VMCI_SUCCESS; eventExit: VMCIEvent_Exit(); datagramExit: VMCIDatagram_Exit(); contextExit: VMCIContext_Exit(); resourceExit: VMCIResource_Exit(); errorExit: return result; } /* *---------------------------------------------------------------------- * * VMCI_SharedCleanup -- * * Cleans up VMCI components shared between guest and host * driver. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ void VMCI_SharedCleanup(void) { VMCIDoorbell_Exit(); VMCIEvent_Exit(); VMCIDatagram_Exit(); VMCIContext_Exit(); VMCIResource_Exit(); } vmci-only/common/vmciResource.c 0000444 0000000 0000000 00000024037 13432725347 015611 0 ustar root root /********************************************************* * Copyright (C) 2006 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 * *********************************************************/ /* * vmciResource.c -- * * Implementation of the VMCI Resource Access Control API. */ #include "vmci_kernel_if.h" #include "vm_assert.h" #include "vmci_defs.h" #include "vmci_infrastructure.h" #include "vmciCommonInt.h" #include "vmciHashtable.h" #include "vmciResource.h" #if defined(VMKERNEL) # include "vmciVmkInt.h" # include "vm_libc.h" # include "helper_ext.h" # include "vmciDriver.h" #else # include "vmciDriver.h" #endif #define LGPFX "VMCIResource: " /* 0 through VMCI_RESERVED_RESOURCE_ID_MAX are reserved. */ static uint32 resourceID = VMCI_RESERVED_RESOURCE_ID_MAX + 1; static VMCILock resourceIdLock; static void VMCIResourceDoRemove(VMCIResource *resource); static VMCIHashTable *resourceTable = NULL; /* Public Resource Access Control API. */ /* *------------------------------------------------------------------------------ * * VMCIResource_Init -- * * Initializes the VMCI Resource Access Control API. Creates a hashtable * to hold all resources, and registers vectors and callbacks for * hypercalls. * * Results: * None. * * Side effects: * None. * *------------------------------------------------------------------------------ */ int VMCIResource_Init(void) { int err = VMCI_InitLock(&resourceIdLock, "VMCIRIDLock", VMCI_LOCK_RANK_RESOURCE); if (err < VMCI_SUCCESS) { return err; } resourceTable = VMCIHashTable_Create(128); if (resourceTable == NULL) { VMCI_WARNING((LGPFX"Failed creating a resource hash table for VMCI.\n")); VMCI_CleanupLock(&resourceIdLock); return VMCI_ERROR_NO_MEM; } return VMCI_SUCCESS; } /* *------------------------------------------------------------------------------ * * VMCIResource_Exit -- * * Cleans up resources. * * Results: * None. * * Side effects: * None. * *------------------------------------------------------------------------------ */ void VMCIResource_Exit(void) { /* Cleanup resources.*/ VMCI_CleanupLock(&resourceIdLock); if (resourceTable) { VMCIHashTable_Destroy(resourceTable); } } /* *------------------------------------------------------------------------------ * * VMCIResource_GetID -- * * Return resource ID. The first VMCI_RESERVED_RESOURCE_ID_MAX are * reserved so we start from its value + 1. * * Result: * VMCI resource id on success, VMCI_INVALID_ID on failure. * * Side effects: * None. * * *------------------------------------------------------------------------------ */ VMCIId VMCIResource_GetID(VMCIId contextID) { VMCIId oldRID = resourceID; VMCIId currentRID; Bool foundRID = FALSE; /* * Generate a unique resource ID. Keep on trying until we wrap around * in the RID space. */ ASSERT(oldRID > VMCI_RESERVED_RESOURCE_ID_MAX); do { VMCILockFlags flags; VMCIHandle handle; VMCI_GrabLock(&resourceIdLock, &flags); currentRID = resourceID; handle = VMCI_MAKE_HANDLE(contextID, currentRID); resourceID++; if (UNLIKELY(resourceID == VMCI_INVALID_ID)) { /* * Skip the reserved rids. */ resourceID = VMCI_RESERVED_RESOURCE_ID_MAX + 1; } VMCI_ReleaseLock(&resourceIdLock, flags); foundRID = !VMCIHashTable_EntryExists(resourceTable, handle); } while (!foundRID && resourceID != oldRID); if (UNLIKELY(!foundRID)) { return VMCI_INVALID_ID; } else { return currentRID; } } /* *------------------------------------------------------------------------------ * * VMCIResource_Add -- * * Results: * VMCI_SUCCESS if successful, error code if not. * * Side effects: * None. * *------------------------------------------------------------------------------ */ int VMCIResource_Add(VMCIResource *resource, // IN VMCIResourceType resourceType, // IN VMCIHandle resourceHandle, // IN VMCIResourceFreeCB containerFreeCB, // IN void *containerObject) // IN { int result; ASSERT(resource); if (VMCI_HANDLE_EQUAL(resourceHandle, VMCI_INVALID_HANDLE)) { VMCI_DEBUG_LOG(4, (LGPFX"Invalid argument resource (handle=0x%x:0x%x).\n", resourceHandle.context, resourceHandle.resource)); return VMCI_ERROR_INVALID_ARGS; } VMCIHashTable_InitEntry(&resource->hashEntry, resourceHandle); resource->type = resourceType; resource->containerFreeCB = containerFreeCB; resource->containerObject = containerObject; /* Add resource to hashtable. */ result = VMCIHashTable_AddEntry(resourceTable, &resource->hashEntry); if (result != VMCI_SUCCESS) { VMCI_DEBUG_LOG(4, (LGPFX"Failed to add entry to hash table " "(result=%d).\n", result)); return result; } return result; } /* *------------------------------------------------------------------------------ * * VMCIResource_Remove -- * * Results: * None. * * Side effects: * None. * *------------------------------------------------------------------------------ */ void VMCIResource_Remove(VMCIHandle resourceHandle, // IN: VMCIResourceType resourceType) // IN: { VMCIResource *resource = VMCIResource_Get(resourceHandle, resourceType); if (resource == NULL) { return; } /* Remove resource from hashtable. */ VMCIHashTable_RemoveEntry(resourceTable, &resource->hashEntry); VMCIResource_Release(resource); /* resource could be freed by now. */ } /* *------------------------------------------------------------------------------ * * VMCIResource_Get -- * * Results: * Resource is successful. Otherwise NULL. * * Side effects: * None. * *------------------------------------------------------------------------------ */ VMCIResource * VMCIResource_Get(VMCIHandle resourceHandle, // IN VMCIResourceType resourceType) // IN { VMCIResource *resource; VMCIHashEntry *entry = VMCIHashTable_GetEntry(resourceTable, resourceHandle); if (entry == NULL) { return NULL; } resource = RESOURCE_CONTAINER(entry, VMCIResource, hashEntry); if (resourceType == VMCI_RESOURCE_TYPE_ANY || resource->type == resourceType) { return resource; } VMCIHashTable_ReleaseEntry(resourceTable, entry); return NULL; } /* *------------------------------------------------------------------------------ * * VMCIResource_Hold -- * * Hold the given resource. This will hold the hashtable entry. This * is like doing a Get() but without having to lookup the resource by * handle. * * Results: * None. * * Side effects: * None. * *------------------------------------------------------------------------------ */ void VMCIResource_Hold(VMCIResource *resource) { ASSERT(resource); VMCIHashTable_HoldEntry(resourceTable, &resource->hashEntry); } /* *------------------------------------------------------------------------------ * * VMCIResourceDoRemove -- * * Deallocates data structures associated with the given resource * and invoke any call back registered for the resource. * * Results: * None. * * Side effects: * May deallocate memory and invoke a callback for the removed resource. * *------------------------------------------------------------------------------ */ static void INLINE VMCIResourceDoRemove(VMCIResource *resource) { ASSERT(resource); if (resource->containerFreeCB) { resource->containerFreeCB(resource->containerObject); /* Resource has been freed don't dereference it. */ } } /* *------------------------------------------------------------------------------ * * VMCIResource_Release -- * * Results: * None. * * Side effects: * resource's containerFreeCB will get called if last reference. * *------------------------------------------------------------------------------ */ int VMCIResource_Release(VMCIResource *resource) { int result; ASSERT(resource); result = VMCIHashTable_ReleaseEntry(resourceTable, &resource->hashEntry); if (result == VMCI_SUCCESS_ENTRY_DEAD) { VMCIResourceDoRemove(resource); } /* * We propagate the information back to caller in case it wants to know * whether entry was freed. */ return result; } /* *------------------------------------------------------------------------------ * * VMCIResource_Handle -- * * Get the handle for the given resource. * * Results: * The resource's associated handle. * * Side effects: * None. * *------------------------------------------------------------------------------ */ VMCIHandle VMCIResource_Handle(VMCIResource *resource) { ASSERT(resource); return resource->hashEntry.handle; } /* *------------------------------------------------------------------------------ * * VMCIResource_Sync -- * * Use this as a synchronization point when setting globals, for example, * during device shutdown. * * Results: * None. * * Side effects: * None. * *------------------------------------------------------------------------------ */ void VMCIResource_Sync(void) { VMCIHashTable_Sync(resourceTable); } vmci-only/common/vmciRoute.c 0000444 0000000 0000000 00000020561 13432725347 015116 0 ustar root root /********************************************************* * Copyright (C) 2011-2012,2014 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 * *********************************************************/ /* * vmciRoute.c -- * * Implementation of VMCI routing rules. */ #include "vmci_kernel_if.h" #include "vm_assert.h" #include "vmci_defs.h" #include "vmci_infrastructure.h" #include "vmciCommonInt.h" #include "vmciContext.h" #include "vmciDriver.h" #include "vmciKernelAPI.h" #include "vmciRoute.h" #if defined(VMKERNEL) # include "vmciVmkInt.h" # include "vm_libc.h" # include "helper_ext.h" #endif #define LGPFX "VMCIRoute: " /* *------------------------------------------------------------------------------ * * VMCI_Route -- * * Make a routing decision for the given source and destination handles. * This will try to determine the route using the handles and the available * devices. * * Result: * A VMCIRoute value. * * Side effects: * Sets the source context if it is invalid. * *------------------------------------------------------------------------------ */ int VMCI_Route(VMCIHandle *src, // IN/OUT const VMCIHandle *dst, // IN Bool fromGuest, // IN VMCIRoute *route) // OUT { Bool hasHostDevice; Bool hasGuestDevice; ASSERT(src); ASSERT(dst); ASSERT(route); *route = VMCI_ROUTE_NONE; /* * "fromGuest" is only ever set to TRUE by IOCTL_VMCI_DATAGRAM_SEND (or by * the vmkernel equivalent), which comes from the VMX, so we know it is * coming from a guest. */ /* * To avoid inconsistencies, test these once. We will test them again * when we do the actual send to ensure that we do not touch a non-existent * device. */ hasHostDevice = VMCI_HostPersonalityActive(); hasGuestDevice = VMCI_GuestPersonalityActive(); /* Must have a valid destination context. */ if (VMCI_INVALID_ID == dst->context) { return VMCI_ERROR_INVALID_ARGS; } /* Anywhere to hypervisor. */ if (VMCI_HYPERVISOR_CONTEXT_ID == dst->context) { /* * If this message already came from a guest then we cannot send it * to the hypervisor. It must come from a local client. */ if (fromGuest) { return VMCI_ERROR_DST_UNREACHABLE; } /* We must be acting as a guest in order to send to the hypervisor. */ if (!hasGuestDevice) { return VMCI_ERROR_DEVICE_NOT_FOUND; } /* And we cannot send if the source is the host context. */ if (VMCI_HOST_CONTEXT_ID == src->context) { return VMCI_ERROR_INVALID_ARGS; } /* Send from local client down to the hypervisor. */ *route = VMCI_ROUTE_AS_GUEST; return VMCI_SUCCESS; } /* Anywhere to local client on host. */ if (VMCI_HOST_CONTEXT_ID == dst->context) { /* * If it is not from a guest but we are acting as a guest, then we need * to send it down to the host. Note that if we are also acting as a * host then this will prevent us from sending from local client to * local client, but we accept that restriction as a way to remove * any ambiguity from the host context. */ if (src->context == VMCI_HYPERVISOR_CONTEXT_ID) { /* * If the hypervisor is the source, this is host local * communication. The hypervisor may send vmci event * datagrams to the host itself, but it will never send * datagrams to an "outer host" through the guest device. */ if (hasHostDevice) { *route = VMCI_ROUTE_AS_HOST; return VMCI_SUCCESS; } else { return VMCI_ERROR_DEVICE_NOT_FOUND; } } if (!fromGuest && hasGuestDevice) { /* If no source context then use the current. */ if (VMCI_INVALID_ID == src->context) { src->context = vmci_get_context_id(); } /* Send it from local client down to the host. */ *route = VMCI_ROUTE_AS_GUEST; return VMCI_SUCCESS; } /* * Otherwise we already received it from a guest and it is destined * for a local client on this host, or it is from another local client * on this host. We must be acting as a host to service it. */ if (!hasHostDevice) { return VMCI_ERROR_DEVICE_NOT_FOUND; } if (VMCI_INVALID_ID == src->context) { /* * If it came from a guest then it must have a valid context. * Otherwise we can use the host context. */ if (fromGuest) { return VMCI_ERROR_INVALID_ARGS; } src->context = VMCI_HOST_CONTEXT_ID; } /* Route to local client. */ *route = VMCI_ROUTE_AS_HOST; return VMCI_SUCCESS; } /* If we are acting as a host then this might be destined for a guest. */ if (hasHostDevice) { /* It will have a context if it is meant for a guest. */ if (VMCIContext_Exists(dst->context)) { if (VMCI_INVALID_ID == src->context) { /* * If it came from a guest then it must have a valid context. * Otherwise we can use the host context. */ if (fromGuest) { return VMCI_ERROR_INVALID_ARGS; } src->context = VMCI_HOST_CONTEXT_ID; } else if (VMCI_CONTEXT_IS_VM(src->context) && src->context != dst->context) { /* * VM to VM communication is not allowed. Since we catch * all communication destined for the host above, this * must be destined for a VM since there is a valid * context. */ ASSERT(VMCI_CONTEXT_IS_VM(dst->context)); return VMCI_ERROR_DST_UNREACHABLE; } /* Pass it up to the guest. */ *route = VMCI_ROUTE_AS_HOST; return VMCI_SUCCESS; } else if (!hasGuestDevice) { /* * The host is attempting to reach a CID without an active context, and * we can't send it down, since we have no guest device. */ return VMCI_ERROR_DST_UNREACHABLE; } } /* * We must be a guest trying to send to another guest, which means * we need to send it down to the host. We do not filter out VM to * VM communication here, since we want to be able to use the guest * driver on older versions that do support VM to VM communication. */ if (!hasGuestDevice) { /* * Ending up here means we have neither guest nor host device. That * shouldn't happen, since any VMCI client in the kernel should have done * a successful VMCI_DeviceGet. */ ASSERT(FALSE); return VMCI_ERROR_DEVICE_NOT_FOUND; } /* If no source context then use the current context. */ if (VMCI_INVALID_ID == src->context) { src->context = vmci_get_context_id(); } /* * Send it from local client down to the host, which will route it to * the other guest for us. */ *route = VMCI_ROUTE_AS_GUEST; return VMCI_SUCCESS; } /* *------------------------------------------------------------------------------ * * VMCI_RouteString -- * * Get a string for the given route. * * Result: * A string representing the route, if the route is valid, otherwise an * empty string. * * Side effects: * None. * *------------------------------------------------------------------------------ */ const char * VMCI_RouteString(VMCIRoute route) // IN { const char *vmciRouteStrings[] = { "none", "as host", "as guest", }; if (route >= VMCI_ROUTE_NONE && route <= VMCI_ROUTE_AS_GUEST) { return vmciRouteStrings[route]; } return ""; } vmci-only/common/vmciDoorbell.h 0000444 0000000 0000000 00000003051 13432725347 015562 0 ustar root root /********************************************************* * Copyright (C) 2010-2013 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 * *********************************************************/ /* * vmciDoorbell.h -- * * Internal functions in the VMCI Doorbell API. */ #ifndef VMCI_DOORBELL_H #define VMCI_DOORBELL_H #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMCORE #define INCLUDE_ALLOW_VMKERNEL #include "includeCheck.h" #include "vmci_kernel_if.h" #include "vmci_defs.h" int VMCIDoorbell_Init(void); void VMCIDoorbell_Exit(void); void VMCIDoorbell_Hibernate(Bool enterHibernation); void VMCIDoorbell_Sync(void); int VMCIDoorbellHostContextNotify(VMCIId srcCID, VMCIHandle handle); int VMCIDoorbellGetPrivFlags(VMCIHandle handle, VMCIPrivilegeFlags *privFlags); Bool VMCI_RegisterNotificationBitmap(PPN bitmapPPN); void VMCI_ScanNotificationBitmap(uint8 *bitmap); #endif // VMCI_DOORBELL_H vmci-only/common/vmciHashtable.c 0000444 0000000 0000000 00000036221 13432725347 015713 0 ustar root root /********************************************************* * Copyright (C) 2006-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 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 * *********************************************************/ /* * vmciHashtable.c -- * * Implementation of the VMCI Hashtable. * TODO: Look into what is takes to use lib/misc/hashTable.c instead of * our own implementation. */ #include "vmci_kernel_if.h" #include "vm_assert.h" #include "vmci_defs.h" #include "vmci_infrastructure.h" #include "vmciCommonInt.h" #include "vmciDriver.h" #include "vmciHashtable.h" #if defined(VMKERNEL) # include "vmciVmkInt.h" # include "vm_libc.h" # include "helper_ext.h" #endif #define LGPFX "VMCIHashTable: " #define VMCI_HASHTABLE_HASH(_h, _sz) \ VMCI_HashId(VMCI_HANDLE_TO_RESOURCE_ID(_h), (_sz)) static int HashTableUnlinkEntry(VMCIHashTable *table, VMCIHashEntry *entry); static Bool VMCIHashTableEntryExistsLocked(VMCIHashTable *table, VMCIHandle handle); /* *------------------------------------------------------------------------------ * * VMCIHashTable_Create -- * XXX Factor out the hashtable code to be shared amongst host and guest. * * Result: * None. * *------------------------------------------------------------------------------ */ VMCIHashTable * VMCIHashTable_Create(int size) { VMCIHashTable *table = VMCI_AllocKernelMem(sizeof *table, VMCI_MEMORY_NONPAGED); if (table == NULL) { return NULL; } table->entries = VMCI_AllocKernelMem(sizeof *table->entries * size, VMCI_MEMORY_NONPAGED); if (table->entries == NULL) { VMCI_FreeKernelMem(table, sizeof *table); return NULL; } memset(table->entries, 0, sizeof *table->entries * size); table->size = size; if (VMCI_InitLock(&table->lock, "VMCIHashTableLock", VMCI_LOCK_RANK_HASHTABLE) < VMCI_SUCCESS) { VMCI_FreeKernelMem(table->entries, sizeof *table->entries * size); VMCI_FreeKernelMem(table, sizeof *table); return NULL; } return table; } /* *------------------------------------------------------------------------------ * * VMCIHashTable_Destroy -- * This function should be called at module exit time. * We rely on the module ref count to insure that no one is accessing any * hash table entries at this point in time. Hence we should be able to just * remove all entries from the hash table. * * Result: * None. * *------------------------------------------------------------------------------ */ void VMCIHashTable_Destroy(VMCIHashTable *table) { VMCILockFlags flags; #if 0 DEBUG_ONLY(int i;) DEBUG_ONLY(int leakingEntries = 0;) #endif ASSERT(table); VMCI_GrabLock_BH(&table->lock, &flags); #if 0 #ifdef VMX86_DEBUG for (i = 0; i < table->size; i++) { VMCIHashEntry *head = table->entries[i]; while (head) { leakingEntries++; head = head->next; } } if (leakingEntries) { VMCI_WARNING((LGPFX"Leaking entries (%d) for hash table (%p).\n", leakingEntries, table)); } #endif // VMX86_DEBUG #endif VMCI_FreeKernelMem(table->entries, sizeof *table->entries * table->size); table->entries = NULL; VMCI_ReleaseLock_BH(&table->lock, flags); VMCI_CleanupLock(&table->lock); VMCI_FreeKernelMem(table, sizeof *table); } /* *------------------------------------------------------------------------------ * * VMCIHashTable_InitEntry -- * Initializes a hash entry; * * Result: * None. * *------------------------------------------------------------------------------ */ void VMCIHashTable_InitEntry(VMCIHashEntry *entry, // IN VMCIHandle handle) // IN { ASSERT(entry); entry->handle = handle; entry->refCount = 0; } /* *------------------------------------------------------------------------------ * * VMCIHashTable_AddEntry -- * XXX Factor out the hashtable code to be shared amongst host and guest. * * Result: * None. * *------------------------------------------------------------------------------ */ int VMCIHashTable_AddEntry(VMCIHashTable *table, // IN VMCIHashEntry *entry) // IN { int idx; VMCILockFlags flags; ASSERT(entry); ASSERT(table); VMCI_GrabLock_BH(&table->lock, &flags); /* Check if creation of a new hashtable entry is allowed. */ if (!VMCI_CanCreate()) { VMCI_ReleaseLock_BH(&table->lock, flags); return VMCI_ERROR_UNAVAILABLE; } if (VMCIHashTableEntryExistsLocked(table, entry->handle)) { VMCI_DEBUG_LOG(4, (LGPFX"Entry (handle=0x%x:0x%x) already exists.\n", entry->handle.context, entry->handle.resource)); VMCI_ReleaseLock_BH(&table->lock, flags); return VMCI_ERROR_DUPLICATE_ENTRY; } idx = VMCI_HASHTABLE_HASH(entry->handle, table->size); ASSERT(idx < table->size); /* New entry is added to top/front of hash bucket. */ entry->refCount++; entry->next = table->entries[idx]; table->entries[idx] = entry; VMCI_ReleaseLock_BH(&table->lock, flags); return VMCI_SUCCESS; } /* *------------------------------------------------------------------------------ * * VMCIHashTable_RemoveEntry -- * XXX Factor out the hashtable code to shared amongst API and perhaps * host and guest. * * Result: * None. * *------------------------------------------------------------------------------ */ int VMCIHashTable_RemoveEntry(VMCIHashTable *table, // IN VMCIHashEntry *entry) // IN { int result; VMCILockFlags flags; ASSERT(table); ASSERT(entry); VMCI_GrabLock_BH(&table->lock, &flags); /* First unlink the entry. */ result = HashTableUnlinkEntry(table, entry); if (result != VMCI_SUCCESS) { /* We failed to find the entry. */ goto done; } /* Decrement refcount and check if this is last reference. */ entry->refCount--; if (entry->refCount == 0) { result = VMCI_SUCCESS_ENTRY_DEAD; goto done; } done: VMCI_ReleaseLock_BH(&table->lock, flags); return result; } /* *------------------------------------------------------------------------------ * * VMCIHashTableGetEntryLocked -- * * Looks up an entry in the hash table, that is already locked. * * Result: * If the element is found, a pointer to the element is returned. * Otherwise NULL is returned. * * Side effects: * The reference count of the returned element is increased. * *------------------------------------------------------------------------------ */ static VMCIHashEntry * VMCIHashTableGetEntryLocked(VMCIHashTable *table, // IN VMCIHandle handle) // IN { VMCIHashEntry *cur = NULL; int idx; ASSERT(!VMCI_HANDLE_EQUAL(handle, VMCI_INVALID_HANDLE)); ASSERT(table); idx = VMCI_HASHTABLE_HASH(handle, table->size); cur = table->entries[idx]; while (TRUE) { if (cur == NULL) { break; } if (VMCI_HANDLE_TO_RESOURCE_ID(cur->handle) == VMCI_HANDLE_TO_RESOURCE_ID(handle)) { if ((VMCI_HANDLE_TO_CONTEXT_ID(cur->handle) == VMCI_HANDLE_TO_CONTEXT_ID(handle)) || (VMCI_INVALID_ID == VMCI_HANDLE_TO_CONTEXT_ID(cur->handle))) { cur->refCount++; break; } } cur = cur->next; } return cur; } /* *------------------------------------------------------------------------------ * * VMCIHashTable_GetEntry -- * XXX Factor out the hashtable code to shared amongst API and perhaps * host and guest. * * Result: * None. * *------------------------------------------------------------------------------ */ VMCIHashEntry * VMCIHashTable_GetEntry(VMCIHashTable *table, // IN VMCIHandle handle) // IN { VMCIHashEntry *entry; VMCILockFlags flags; if (VMCI_HANDLE_EQUAL(handle, VMCI_INVALID_HANDLE)) { return NULL; } ASSERT(table); VMCI_GrabLock_BH(&table->lock, &flags); entry = VMCIHashTableGetEntryLocked(table, handle); VMCI_ReleaseLock_BH(&table->lock, flags); return entry; } /* *------------------------------------------------------------------------------ * * VMCIHashTable_HoldEntry -- * * Hold the given entry. This will increment the entry's reference count. * This is like a GetEntry() but without having to lookup the entry by * handle. * * Result: * None. * * Side effects: * None. * *------------------------------------------------------------------------------ */ void VMCIHashTable_HoldEntry(VMCIHashTable *table, // IN VMCIHashEntry *entry) // IN/OUT { VMCILockFlags flags; ASSERT(table); ASSERT(entry); VMCI_GrabLock_BH(&table->lock, &flags); entry->refCount++; VMCI_ReleaseLock_BH(&table->lock, flags); } /* *------------------------------------------------------------------------------ * * VMCIHashTableReleaseEntryLocked -- * * Releases an element previously obtained with * VMCIHashTableGetEntryLocked. * * Result: * If the entry is removed from the hash table, VMCI_SUCCESS_ENTRY_DEAD * is returned. Otherwise, VMCI_SUCCESS is returned. * * Side effects: * The reference count of the entry is decreased and the entry is removed * from the hash table on 0. * *------------------------------------------------------------------------------ */ static int VMCIHashTableReleaseEntryLocked(VMCIHashTable *table, // IN VMCIHashEntry *entry) // IN { int result = VMCI_SUCCESS; ASSERT(table); ASSERT(entry); entry->refCount--; /* Check if this is last reference and report if so. */ if (entry->refCount == 0) { /* * Remove entry from hash table if not already removed. This could have * happened already because VMCIHashTable_RemoveEntry was called to unlink * it. We ignore if it is not found. Datagram handles will often have * RemoveEntry called, whereas SharedMemory regions rely on ReleaseEntry * to unlink the entry, since the creator does not call RemoveEntry when * it detaches. */ HashTableUnlinkEntry(table, entry); result = VMCI_SUCCESS_ENTRY_DEAD; } return result; } /* *------------------------------------------------------------------------------ * * VMCIHashTable_ReleaseEntry -- * XXX Factor out the hashtable code to shared amongst API and perhaps * host and guest. * * Result: * None. * *------------------------------------------------------------------------------ */ int VMCIHashTable_ReleaseEntry(VMCIHashTable *table, // IN VMCIHashEntry *entry) // IN { VMCILockFlags flags; int result; ASSERT(table); VMCI_GrabLock_BH(&table->lock, &flags); result = VMCIHashTableReleaseEntryLocked(table, entry); VMCI_ReleaseLock_BH(&table->lock, flags); return result; } /* *------------------------------------------------------------------------------ * * VMCIHashTable_EntryExists -- * XXX Factor out the hashtable code to shared amongst API and perhaps * host and guest. * * Result: * TRUE if handle already in hashtable. FALSE otherwise. * * Side effects: * None. * *------------------------------------------------------------------------------ */ Bool VMCIHashTable_EntryExists(VMCIHashTable *table, // IN VMCIHandle handle) // IN { Bool exists; VMCILockFlags flags; ASSERT(table); VMCI_GrabLock_BH(&table->lock, &flags); exists = VMCIHashTableEntryExistsLocked(table, handle); VMCI_ReleaseLock_BH(&table->lock, flags); return exists; } /* *------------------------------------------------------------------------------ * * VMCIHashTableEntryExistsLocked -- * * Unlocked version of VMCIHashTable_EntryExists. * * Result: * TRUE if handle already in hashtable. FALSE otherwise. * * Side effects: * None. * *------------------------------------------------------------------------------ */ static Bool VMCIHashTableEntryExistsLocked(VMCIHashTable *table, // IN VMCIHandle handle) // IN { VMCIHashEntry *entry; int idx; ASSERT(table); idx = VMCI_HASHTABLE_HASH(handle, table->size); entry = table->entries[idx]; while (entry) { if (VMCI_HANDLE_TO_RESOURCE_ID(entry->handle) == VMCI_HANDLE_TO_RESOURCE_ID(handle)) { if ((VMCI_HANDLE_TO_CONTEXT_ID(entry->handle) == VMCI_HANDLE_TO_CONTEXT_ID(handle)) || (VMCI_INVALID_ID == VMCI_HANDLE_TO_CONTEXT_ID(handle)) || (VMCI_INVALID_ID == VMCI_HANDLE_TO_CONTEXT_ID(entry->handle))) { return TRUE; } } entry = entry->next; } return FALSE; } /* *------------------------------------------------------------------------------ * * HashTableUnlinkEntry -- * XXX Factor out the hashtable code to shared amongst API and perhaps * host and guest. * Assumes caller holds table lock. * * Result: * None. * *------------------------------------------------------------------------------ */ static int HashTableUnlinkEntry(VMCIHashTable *table, // IN VMCIHashEntry *entry) // IN { int result; VMCIHashEntry *prev, *cur; int idx; idx = VMCI_HASHTABLE_HASH(entry->handle, table->size); prev = NULL; cur = table->entries[idx]; while (TRUE) { if (cur == NULL) { result = VMCI_ERROR_NOT_FOUND; break; } if (VMCI_HANDLE_EQUAL(cur->handle, entry->handle)) { ASSERT(cur == entry); /* Remove entry and break. */ if (prev) { prev->next = cur->next; } else { table->entries[idx] = cur->next; } cur->next = NULL; result = VMCI_SUCCESS; break; } prev = cur; cur = cur->next; } return result; } /* *----------------------------------------------------------------------------- * * VMCIHashTable_Sync -- * * Use this as a synchronization point when setting globals, for example, * during device shutdown. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ void VMCIHashTable_Sync(VMCIHashTable *table) { VMCILockFlags flags; ASSERT(table); VMCI_GrabLock_BH(&table->lock, &flags); VMCI_ReleaseLock_BH(&table->lock, flags); } vmci-only/common/vmciQueuePair.c 0000444 0000000 0000000 00000306264 13432725347 015727 0 ustar root root /********************************************************* * Copyright (C) 2007-2017 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 * *********************************************************/ /* * vmciQueuePair.c -- * * VMCI QueuePair API implementation in the host driver. */ #include "vmci_kernel_if.h" #include "vm_assert.h" #include "vmci_defs.h" #include "vmci_handle_array.h" #include "vmci_infrastructure.h" #include "vmciCommonInt.h" #include "vmciContext.h" #include "vmciDatagram.h" #include "vmciDriver.h" #include "vmciEvent.h" #include "vmciHashtable.h" #include "vmciKernelAPI.h" #include "vmciQueuePair.h" #include "vmciResource.h" #include "vmciRoute.h" #if defined(VMKERNEL) # include "vmciVmkInt.h" # include "vm_libc.h" #endif #define LGPFX "VMCIQueuePair: " /* * In the following, we will distinguish between two kinds of VMX processes - * the ones with versions lower than VMCI_VERSION_NOVMVM that use specialized * VMCI page files in the VMX and supporting VM to VM communication) and the * newer ones that use the guest memory directly. We will in the following refer * to the older VMX versions as old-style VMX'en, and the newer ones as new-style * VMX'en. * * The state transition datagram is as follows (the VMCIQPB_ prefix has been * removed for readability) - see below for more details on the transtions: * * -------------- NEW ------------- * | | * \_/ \_/ * CREATED_NO_MEM <-----------------> CREATED_MEM * | | | * | o-----------------------o | * | | | * \_/ \_/ \_/ * ATTACHED_NO_MEM <----------------> ATTACHED_MEM * | | | * | o----------------------o | * | | | * \_/ \_/ \_/ * SHUTDOWN_NO_MEM <----------------> SHUTDOWN_MEM * | | * | | * -------------> gone <------------- * * In more detail. When a VMCI queue pair is first created, it will be in the * VMCIQPB_NEW state. It will then move into one of the following states: * - VMCIQPB_CREATED_NO_MEM: this state indicates that either: * - the created was performed by a host endpoint, in which case there is no * backing memory yet. * - the create was initiated by an old-style VMX, that uses * VMCIQPBroker_SetPageStore to specify the UVAs of the queue pair at a * later point in time. This state can be distinguished from the one above * by the context ID of the creator. A host side is not allowed to attach * until the page store has been set. * - VMCIQPB_CREATED_MEM: this state is the result when the queue pair is created * by a VMX using the queue pair device backend that sets the UVAs of the * queue pair immediately and stores the information for later attachers. At * this point, it is ready for the host side to attach to it. * Once the queue pair is in one of the created states (with the exception of the * case mentioned for older VMX'en above), it is possible to attach to the queue * pair. Again we have two new states possible: * - VMCIQPB_ATTACHED_MEM: this state can be reached through the following paths: * - from VMCIQPB_CREATED_NO_MEM when a new-style VMX allocates a queue pair, * and attaches to a queue pair previously created by the host side. * - from VMCIQPB_CREATED_MEM when the host side attaches to a queue pair * already created by a guest. * - from VMCIQPB_ATTACHED_NO_MEM, when an old-style VMX calls * VMCIQPBroker_SetPageStore (see below). * - VMCIQPB_ATTACHED_NO_MEM: If the queue pair already was in the * VMCIQPB_CREATED_NO_MEM due to a host side create, an old-style VMX will * bring the queue pair into this state. Once VMCIQPBroker_SetPageStore is * called to register the user memory, the VMCIQPB_ATTACH_MEM state will be * entered. * From the attached queue pair, the queue pair can enter the shutdown states * when either side of the queue pair detaches. If the guest side detaches first, * the queue pair will enter the VMCIQPB_SHUTDOWN_NO_MEM state, where the content * of the queue pair will no longer be available. If the host side detaches first, * the queue pair will either enter the VMCIQPB_SHUTDOWN_MEM, if the guest memory * is currently mapped, or VMCIQPB_SHUTDOWN_NO_MEM, if the guest memory is not * mapped (e.g., the host detaches while a guest is stunned). * * New-style VMX'en will also unmap guest memory, if the guest is quiesced, e.g., * during a snapshot operation. In that case, the guest memory will no longer be * available, and the queue pair will transition from *_MEM state to a *_NO_MEM * state. The VMX may later map the memory once more, in which case the queue * pair will transition from the *_NO_MEM state at that point back to the *_MEM * state. Note that the *_NO_MEM state may have changed, since the peer may have * either attached or detached in the meantime. The values are laid out such that * ++ on a state will move from a *_NO_MEM to a *_MEM state, and vice versa. */ typedef enum { VMCIQPB_NEW, VMCIQPB_CREATED_NO_MEM, VMCIQPB_CREATED_MEM, VMCIQPB_ATTACHED_NO_MEM, VMCIQPB_ATTACHED_MEM, VMCIQPB_SHUTDOWN_NO_MEM, VMCIQPB_SHUTDOWN_MEM, VMCIQPB_GONE } QPBrokerState; #define QPBROKERSTATE_HAS_MEM(_qpb) (_qpb->state == VMCIQPB_CREATED_MEM || \ _qpb->state == VMCIQPB_ATTACHED_MEM || \ _qpb->state == VMCIQPB_SHUTDOWN_MEM) /* * In the queue pair broker, we always use the guest point of view for * the produce and consume queue values and references, e.g., the * produce queue size stored is the guests produce queue size. The * host endpoint will need to swap these around. The only exception is * the local queue pairs on the host, in which case the host endpoint * that creates the queue pair will have the right orientation, and * the attaching host endpoint will need to swap. */ typedef struct QueuePairEntry { VMCIListItem listItem; VMCIHandle handle; VMCIId peer; uint32 flags; uint64 produceSize; uint64 consumeSize; uint32 refCount; } QueuePairEntry; typedef struct QPBrokerEntry { QueuePairEntry qp; VMCIId createId; VMCIId attachId; QPBrokerState state; Bool requireTrustedAttach; Bool createdByTrusted; Bool vmciPageFiles; // Created by VMX using VMCI page files uint8 detachCause; VMCIQueue *produceQ; VMCIQueue *consumeQ; VMCIQueueHeader savedProduceQ; VMCIQueueHeader savedConsumeQ; VMCIEventReleaseCB wakeupCB; void *clientData; void *localMem; // Kernel memory for local queue pair } QPBrokerEntry; #if !defined(VMKERNEL) typedef struct QPGuestEndpoint { QueuePairEntry qp; uint64 numPPNs; void *produceQ; void *consumeQ; Bool hibernateFailure; PPNSet ppnSet; } QPGuestEndpoint; #endif typedef struct QueuePairList { VMCIList head; Atomic_uint32 hibernate; VMCIMutex mutex; } QueuePairList; static QueuePairList qpBrokerList; #define QPE_NUM_PAGES(_QPE) ((uint32)(CEILING(_QPE.produceSize, PAGE_SIZE) + \ CEILING(_QPE.consumeSize, PAGE_SIZE) + 2)) #if !defined(VMKERNEL) static QueuePairList qpGuestEndpoints; static VMCIHandleArray *hibernateFailedList; static VMCILock hibernateFailedListLock; #endif static void VMCIQPBrokerLock(void); static void VMCIQPBrokerUnlock(void); static QueuePairEntry *QueuePairList_FindEntry(QueuePairList *qpList, VMCIHandle handle); static void QueuePairList_AddEntry(QueuePairList *qpList, QueuePairEntry *entry); static void QueuePairList_RemoveEntry(QueuePairList *qpList, QueuePairEntry *entry); static QueuePairEntry *QueuePairList_GetHead(QueuePairList *qpList); static int QueuePairNotifyPeer(Bool attach, VMCIHandle handle, VMCIId myId, VMCIId peerId); static int VMCIQPBrokerAllocInt(VMCIHandle handle, VMCIId peer, uint32 flags, VMCIPrivilegeFlags privFlags, uint64 produceSize, uint64 consumeSize, QueuePairPageStore *pageStore, VMCIContext *context, VMCIEventReleaseCB wakeupCB, void *clientData, QPBrokerEntry **ent, Bool *swap); static int VMCIQPBrokerAttach(QPBrokerEntry *entry, VMCIId peer, uint32 flags, VMCIPrivilegeFlags privFlags, uint64 produceSize, uint64 consumeSize, QueuePairPageStore *pageStore, VMCIContext *context, VMCIEventReleaseCB wakeupCB, void *clientData, QPBrokerEntry **ent); static int VMCIQPBrokerCreate(VMCIHandle handle, VMCIId peer, uint32 flags, VMCIPrivilegeFlags privFlags, uint64 produceSize, uint64 consumeSize, QueuePairPageStore *pageStore, VMCIContext *context, VMCIEventReleaseCB wakeupCB, void *clientData, QPBrokerEntry **ent); static int VMCIQueuePairAllocHostWork(VMCIHandle *handle, VMCIQueue **produceQ, uint64 produceSize, VMCIQueue **consumeQ, uint64 consumeSize, VMCIId peer, uint32 flags, VMCIPrivilegeFlags privFlags, VMCIEventReleaseCB wakeupCB, void *clientData); static int VMCIQueuePairDetachHostWork(VMCIHandle handle); static int QueuePairSaveHeaders(QPBrokerEntry *entry); static void QueuePairResetSavedHeaders(QPBrokerEntry *entry); #if !defined(VMKERNEL) static int QueuePairNotifyPeerLocal(Bool attach, VMCIHandle handle); static QPGuestEndpoint *QPGuestEndpointCreate(VMCIHandle handle, VMCIId peer, uint32 flags, uint64 produceSize, uint64 consumeSize, void *produceQ, void *consumeQ); static void QPGuestEndpointDestroy(QPGuestEndpoint *entry); static int VMCIQueuePairAllocHypercall(const QPGuestEndpoint *entry); static int VMCIQueuePairAllocGuestWork(VMCIHandle *handle, VMCIQueue **produceQ, uint64 produceSize, VMCIQueue **consumeQ, uint64 consumeSize, VMCIId peer, uint32 flags, VMCIPrivilegeFlags privFlags); static int VMCIQueuePairDetachGuestWork(VMCIHandle handle); static int VMCIQueuePairDetachHypercall(VMCIHandle handle); static void VMCIQPMarkHibernateFailed(QPGuestEndpoint *entry); static void VMCIQPUnmarkHibernateFailed(QPGuestEndpoint *entry); extern int VMCI_SendDatagram(VMCIDatagram *); #endif /* *----------------------------------------------------------------------------- * * VMCIQueuePair_Alloc -- * * Allocates a VMCI QueuePair. Only checks validity of input * arguments. The real work is done in the host or guest * specific function. * * Results: * VMCI_SUCCESS on success, appropriate error code otherwise. * * Side effects: * None. * *----------------------------------------------------------------------------- */ int VMCIQueuePair_Alloc(VMCIHandle *handle, // IN/OUT VMCIQueue **produceQ, // OUT uint64 produceSize, // IN VMCIQueue **consumeQ, // OUT uint64 consumeSize, // IN VMCIId peer, // IN uint32 flags, // IN VMCIPrivilegeFlags privFlags, // IN Bool guestEndpoint, // IN VMCIEventReleaseCB wakeupCB, // IN void *clientData) // IN { if (!handle || !produceQ || !consumeQ || (!produceSize && !consumeSize) || (flags & ~VMCI_QP_ALL_FLAGS)) { return VMCI_ERROR_INVALID_ARGS; } if (guestEndpoint) { #if !defined(VMKERNEL) return VMCIQueuePairAllocGuestWork(handle, produceQ, produceSize, consumeQ, consumeSize, peer, flags, privFlags); #else return VMCI_ERROR_INVALID_ARGS; #endif } else { return VMCIQueuePairAllocHostWork(handle, produceQ, produceSize, consumeQ, consumeSize, peer, flags, privFlags, wakeupCB, clientData); } } /* *----------------------------------------------------------------------------- * * VMCIQueuePair_Detach -- * * Detaches from a VMCI QueuePair. Only checks validity of input argument. * Real work is done in the host or guest specific function. * * Results: * Success or failure. * * Side effects: * Memory is freed. * *----------------------------------------------------------------------------- */ int VMCIQueuePair_Detach(VMCIHandle handle, // IN Bool guestEndpoint) // IN { if (VMCI_HANDLE_INVALID(handle)) { return VMCI_ERROR_INVALID_ARGS; } if (guestEndpoint) { #if !defined(VMKERNEL) return VMCIQueuePairDetachGuestWork(handle); #else return VMCI_ERROR_INVALID_ARGS; #endif } else { return VMCIQueuePairDetachHostWork(handle); } } #if defined(VMKERNEL) /* *----------------------------------------------------------------------------- * * VMCIQueuePair_GetDetachCause -- * * Retrieves the cause of a peer detach from a VMCI QueuePair. * * Results: * Success or failure. * * Side effects: * None. * *----------------------------------------------------------------------------- */ int VMCIQueuePair_GetDetachCause(VMCIHandle handle, // IN uint8 *cause) // OUT { QPBrokerEntry *entry; int result = VMCI_SUCCESS; if (VMCI_HANDLE_INVALID(handle)) { return VMCI_ERROR_INVALID_ARGS; } VMCIQPBrokerLock(); entry = (QPBrokerEntry *)QueuePairList_FindEntry(&qpBrokerList, handle); if (!entry) { result = VMCI_ERROR_NOT_FOUND; goto out; } if (cause != NULL) { *cause = entry->detachCause; } out: VMCIQPBrokerUnlock(); return result; } #endif /* *----------------------------------------------------------------------------- * * QueuePairList_Init -- * * Initializes the list of QueuePairs. * * Results: * Success or failure. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE int QueuePairList_Init(QueuePairList *qpList) // IN { int ret; VMCIList_Init(&qpList->head); Atomic_Write(&qpList->hibernate, 0); ret = VMCIMutex_Init(&qpList->mutex, "VMCIQPListLock", VMCI_SEMA_RANK_QUEUEPAIRLIST); return ret; } /* *----------------------------------------------------------------------------- * * QueuePairList_Destroy -- * * Destroy the list's mutex. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE void QueuePairList_Destroy(QueuePairList *qpList) { VMCIMutex_Destroy(&qpList->mutex); VMCIList_Init(&qpList->head); } /* *----------------------------------------------------------------------------- * * VMCIQPBrokerLock -- * * Acquires the mutex protecting a VMCI queue pair broker transaction. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static void VMCIQPBrokerLock(void) { VMCIMutex_Acquire(&qpBrokerList.mutex); } /* *----------------------------------------------------------------------------- * * VMCIQPBrokerUnlock -- * * Releases the mutex protecting a VMCI queue pair broker transaction. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static void VMCIQPBrokerUnlock(void) { VMCIMutex_Release(&qpBrokerList.mutex); } /* *----------------------------------------------------------------------------- * * QueuePairList_FindEntry -- * * Finds the entry in the list corresponding to a given handle. Assumes * that the list is locked. * * Results: * Pointer to entry. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static QueuePairEntry * QueuePairList_FindEntry(QueuePairList *qpList, // IN VMCIHandle handle) // IN { VMCIListItem *next; if (VMCI_HANDLE_INVALID(handle)) { return NULL; } VMCIList_Scan(next, &qpList->head) { QueuePairEntry *entry = VMCIList_Entry(next, QueuePairEntry, listItem); if (VMCI_HANDLE_EQUAL(entry->handle, handle)) { return entry; } } return NULL; } /* *----------------------------------------------------------------------------- * * QueuePairList_AddEntry -- * * Adds the given entry to the list. Assumes that the list is locked. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static void QueuePairList_AddEntry(QueuePairList *qpList, // IN QueuePairEntry *entry) // IN { if (entry) { VMCIList_Insert(&entry->listItem, &qpList->head); } } /* *----------------------------------------------------------------------------- * * QueuePairList_RemoveEntry -- * * Removes the given entry from the list. Assumes that the list is locked. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static void QueuePairList_RemoveEntry(QueuePairList *qpList, // IN QueuePairEntry *entry) // IN { UNREFERENCED_PARAMETER(qpList); if (entry) { VMCIList_Remove(&entry->listItem); } } /* *----------------------------------------------------------------------------- * * QueuePairList_GetHead -- * * Returns the entry from the head of the list. Assumes that the list is * locked. * * Results: * Pointer to entry. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static QueuePairEntry * QueuePairList_GetHead(QueuePairList *qpList) { VMCIListItem *first = VMCIList_First(&qpList->head); if (first) { QueuePairEntry *entry = VMCIList_Entry(first, QueuePairEntry, listItem); return entry; } return NULL; } /* *----------------------------------------------------------------------------- * * VMCIQPBroker_Init -- * * Initalizes queue pair broker state. * * Results: * Success or failure. * * Side effects: * None. * *----------------------------------------------------------------------------- */ int VMCIQPBroker_Init(void) { return QueuePairList_Init(&qpBrokerList); } /* *----------------------------------------------------------------------------- * * VMCIQPBroker_Exit -- * * Destroys the queue pair broker state. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ void VMCIQPBroker_Exit(void) { QPBrokerEntry *entry; VMCIQPBrokerLock(); while ((entry = (QPBrokerEntry *)QueuePairList_GetHead(&qpBrokerList)) != NULL) { QueuePairList_RemoveEntry(&qpBrokerList, &entry->qp); VMCI_FreeKernelMem(entry, sizeof *entry); } VMCIQPBrokerUnlock(); QueuePairList_Destroy(&qpBrokerList); } /* *----------------------------------------------------------------------------- * * VMCIQPBroker_Alloc -- * * Requests that a queue pair be allocated with the VMCI queue * pair broker. Allocates a queue pair entry if one does not * exist. Attaches to one if it exists, and retrieves the page * files backing that QueuePair. Assumes that the queue pair * broker lock is held. * * Results: * Success or failure. * * Side effects: * Memory may be allocated. * *----------------------------------------------------------------------------- */ int VMCIQPBroker_Alloc(VMCIHandle handle, // IN VMCIId peer, // IN uint32 flags, // IN VMCIPrivilegeFlags privFlags, // IN uint64 produceSize, // IN uint64 consumeSize, // IN QueuePairPageStore *pageStore, // IN/OUT VMCIContext *context) // IN: Caller { return VMCIQPBrokerAllocInt(handle, peer, flags, privFlags, produceSize, consumeSize, pageStore, context, NULL, NULL, NULL, NULL); } /* *----------------------------------------------------------------------------- * * QueuePairNotifyPeer -- * * Enqueues an event datagram to notify the peer VM attached to * the given queue pair handle about attach/detach event by the * given VM. * * Results: * Payload size of datagram enqueued on success, error code otherwise. * * Side effects: * Memory is allocated. * *----------------------------------------------------------------------------- */ int QueuePairNotifyPeer(Bool attach, // IN: attach or detach? VMCIHandle handle, // IN VMCIId myId, // IN VMCIId peerId) // IN: CID of VM to notify { int rv; VMCIEventMsg *eMsg; VMCIEventPayload_QP *evPayload; char buf[sizeof *eMsg + sizeof *evPayload]; if (VMCI_HANDLE_INVALID(handle) || myId == VMCI_INVALID_ID || peerId == VMCI_INVALID_ID) { return VMCI_ERROR_INVALID_ARGS; } /* * Notification message contains: queue pair handle and * attaching/detaching VM's context id. */ eMsg = (VMCIEventMsg *)buf; /* * In VMCIContext_EnqueueDatagram() we enforce the upper limit on number of * pending events from the hypervisor to a given VM otherwise a rogue VM * could do an arbitrary number of attach and detach operations causing memory * pressure in the host kernel. */ /* Clear out any garbage. */ memset(eMsg, 0, sizeof buf); eMsg->hdr.dst = VMCI_MAKE_HANDLE(peerId, VMCI_EVENT_HANDLER); eMsg->hdr.src = VMCI_MAKE_HANDLE(VMCI_HYPERVISOR_CONTEXT_ID, VMCI_CONTEXT_RESOURCE_ID); eMsg->hdr.payloadSize = sizeof *eMsg + sizeof *evPayload - sizeof eMsg->hdr; eMsg->eventData.event = attach ? VMCI_EVENT_QP_PEER_ATTACH : VMCI_EVENT_QP_PEER_DETACH; evPayload = VMCIEventMsgPayload(eMsg); evPayload->handle = handle; evPayload->peerId = myId; rv = VMCIDatagram_Dispatch(VMCI_HYPERVISOR_CONTEXT_ID, (VMCIDatagram *)eMsg, FALSE); if (rv < VMCI_SUCCESS) { VMCI_WARNING((LGPFX"Failed to enqueue QueuePair %s event datagram for " "context (ID=0x%x).\n", attach ? "ATTACH" : "DETACH", peerId)); } return rv; } /* *---------------------------------------------------------------------- * * VMCIQueuePairAllocHostWork -- * * This function implements the kernel API for allocating a queue * pair. * * Results: * VMCI_SUCCESS on succes and appropriate failure code otherwise. * * Side effects: * May allocate memory. * *---------------------------------------------------------------------- */ static int VMCIQueuePairAllocHostWork(VMCIHandle *handle, // IN/OUT VMCIQueue **produceQ, // OUT uint64 produceSize, // IN VMCIQueue **consumeQ, // OUT uint64 consumeSize, // IN VMCIId peer, // IN uint32 flags, // IN VMCIPrivilegeFlags privFlags, // IN VMCIEventReleaseCB wakeupCB, // IN void *clientData) // IN { VMCIContext *context; QPBrokerEntry *entry; int result; Bool swap; if (VMCI_HANDLE_INVALID(*handle)) { VMCIId resourceID = VMCIResource_GetID(VMCI_HOST_CONTEXT_ID); if (resourceID == VMCI_INVALID_ID) { return VMCI_ERROR_NO_HANDLE; } *handle = VMCI_MAKE_HANDLE(VMCI_HOST_CONTEXT_ID, resourceID); } context = VMCIContext_Get(VMCI_HOST_CONTEXT_ID); ASSERT(context); entry = NULL; result = VMCIQPBrokerAllocInt(*handle, peer, flags, privFlags, produceSize, consumeSize, NULL, context, wakeupCB, clientData, &entry, &swap); if (result == VMCI_SUCCESS) { if (swap) { /* * If this is a local queue pair, the attacher will swap around produce * and consume queues. */ *produceQ = entry->consumeQ; *consumeQ = entry->produceQ; } else { *produceQ = entry->produceQ; *consumeQ = entry->consumeQ; } } else { *handle = VMCI_INVALID_HANDLE; VMCI_DEBUG_LOG(4, (LGPFX"queue pair broker failed to alloc (result=%d).\n", result)); } VMCIContext_Release(context); return result; } /* *---------------------------------------------------------------------- * * VMCIQueuePairDetachHostWork -- * * This function implements the host kernel API for detaching from * a queue pair. * * Results: * VMCI_SUCCESS on success and appropriate failure code otherwise. * * Side effects: * May deallocate memory. * *---------------------------------------------------------------------- */ static int VMCIQueuePairDetachHostWork(VMCIHandle handle) // IN { int result; VMCIContext *context; context = VMCIContext_Get(VMCI_HOST_CONTEXT_ID); result = VMCIQPBroker_Detach(handle, context); VMCIContext_Release(context); return result; } /* *----------------------------------------------------------------------------- * * VMCIQPBrokerAllocInt -- * * QueuePair_Alloc for use when setting up queue pair endpoints * on the host. Like QueuePair_Alloc, but returns a pointer to * the QPBrokerEntry on success. * * Results: * Success or failure. * * Side effects: * Memory may be allocated. * *----------------------------------------------------------------------------- */ static int VMCIQPBrokerAllocInt(VMCIHandle handle, // IN VMCIId peer, // IN uint32 flags, // IN VMCIPrivilegeFlags privFlags, // IN uint64 produceSize, // IN uint64 consumeSize, // IN QueuePairPageStore *pageStore, // IN/OUT VMCIContext *context, // IN: Caller VMCIEventReleaseCB wakeupCB, // IN void *clientData, // IN QPBrokerEntry **ent, // OUT Bool *swap) // OUT: swap queues? { const VMCIId contextId = VMCIContext_GetId(context); Bool create; QPBrokerEntry *entry; Bool isLocal = flags & VMCI_QPFLAG_LOCAL; int result; #if defined(_WIN32) #pragma warning(suppress: 6235) /* !vmkernel always true */ #endif if (VMCI_HANDLE_INVALID(handle) || (flags & ~VMCI_QP_ALL_FLAGS) || (isLocal && (!vmkernel || contextId != VMCI_HOST_CONTEXT_ID || handle.context != contextId)) || !(produceSize || consumeSize) || !context || contextId == VMCI_INVALID_ID || handle.context == VMCI_INVALID_ID) { VMCI_DEBUG_LOG(5, ("Invalid argument - handle, flags, whatever\n")); return VMCI_ERROR_INVALID_ARGS; } if (pageStore && !VMCI_QP_PAGESTORE_IS_WELLFORMED(pageStore)) { VMCI_DEBUG_LOG(5, ("Invalid argument - page store\n")); return VMCI_ERROR_INVALID_ARGS; } /* * In the initial argument check, we ensure that non-vmkernel hosts * are not allowed to create local queue pairs. */ ASSERT(vmkernel || !isLocal); VMCIQPBrokerLock(); if (!isLocal && VMCIContext_QueuePairExists(context, handle)) { VMCI_DEBUG_LOG(4, (LGPFX"Context (ID=0x%x) already attached to queue pair " "(handle=0x%x:0x%x).\n", contextId, handle.context, handle.resource)); VMCIQPBrokerUnlock(); return VMCI_ERROR_ALREADY_EXISTS; } entry = (QPBrokerEntry *)QueuePairList_FindEntry(&qpBrokerList, handle); if (!entry) { create = TRUE; result = VMCIQPBrokerCreate(handle, peer, flags, privFlags, produceSize, consumeSize, pageStore, context, wakeupCB, clientData, ent); } else { create = FALSE; result = VMCIQPBrokerAttach(entry, peer, flags, privFlags, produceSize, consumeSize, pageStore, context, wakeupCB, clientData, ent); } VMCIQPBrokerUnlock(); if (swap) { *swap = (contextId == VMCI_HOST_CONTEXT_ID) && !(create && isLocal); } return result; } /* *----------------------------------------------------------------------------- * * VMCIQPBrokerCreate -- * * The first endpoint issuing a queue pair allocation will create the state * of the queue pair in the queue pair broker. * * If the creator is a guest, it will associate a VMX virtual address range * with the queue pair as specified by the pageStore. For compatibility with * older VMX'en, that would use a separate step to set the VMX virtual * address range, the virtual address range can be registered later using * VMCIQPBroker_SetPageStore. In that case, a pageStore of NULL should be * used. * * If the creator is the host, a pageStore of NULL should be used as well, * since the host is not able to supply a page store for the queue pair. * * For older VMX and host callers, the queue pair will be created in the * VMCIQPB_CREATED_NO_MEM state, and for current VMX callers, it will be * created in VMCOQPB_CREATED_MEM state. * * Results: * VMCI_SUCCESS on success, appropriate error code otherwise. * * Side effects: * Memory will be allocated, and pages may be pinned. * *----------------------------------------------------------------------------- */ static int VMCIQPBrokerCreate(VMCIHandle handle, // IN VMCIId peer, // IN uint32 flags, // IN VMCIPrivilegeFlags privFlags, // IN uint64 produceSize, // IN uint64 consumeSize, // IN QueuePairPageStore *pageStore, // IN VMCIContext *context, // IN: Caller VMCIEventReleaseCB wakeupCB, // IN void *clientData, // IN QPBrokerEntry **ent) // OUT { QPBrokerEntry *entry = NULL; const VMCIId contextId = VMCIContext_GetId(context); Bool isLocal = flags & VMCI_QPFLAG_LOCAL; int result; uint64 guestProduceSize; uint64 guestConsumeSize; /* * Do not create if the caller asked not to. */ if (flags & VMCI_QPFLAG_ATTACH_ONLY) { VMCI_DEBUG_LOG(5, ("QP Create - attach only\n")); return VMCI_ERROR_NOT_FOUND; } /* * Creator's context ID should match handle's context ID or the creator * must allow the context in handle's context ID as the "peer". */ if (handle.context != contextId && handle.context != peer) { VMCI_DEBUG_LOG(5, ("QP Create - contextId fail, %x != %x, %x\n", handle.context, contextId, peer)); return VMCI_ERROR_NO_ACCESS; } if (VMCI_CONTEXT_IS_VM(contextId) && VMCI_CONTEXT_IS_VM(peer)) { VMCI_DEBUG_LOG(5, ("QP Create - VM2VM\n")); return VMCI_ERROR_DST_UNREACHABLE; } /* * Creator's context ID for local queue pairs should match the * peer, if a peer is specified. */ if (isLocal && peer != VMCI_INVALID_ID && contextId != peer) { VMCI_DEBUG_LOG(5, ("QP Create - peer %x, context %x\n", peer, contextId)); return VMCI_ERROR_NO_ACCESS; } entry = VMCI_AllocKernelMem(sizeof *entry, VMCI_MEMORY_ATOMIC); if (!entry) { VMCI_DEBUG_LOG(5, ("QP Create - no memory\n")); return VMCI_ERROR_NO_MEM; } if (VMCIContext_GetId(context) == VMCI_HOST_CONTEXT_ID && !isLocal) { /* * The queue pair broker entry stores values from the guest * point of view, so a creating host side endpoint should swap * produce and consume values -- unless it is a local queue * pair, in which case no swapping is necessary, since the local * attacher will swap queues. */ guestProduceSize = consumeSize; guestConsumeSize = produceSize; } else { guestProduceSize = produceSize; guestConsumeSize = consumeSize; } memset(entry, 0, sizeof *entry); entry->qp.handle = handle; entry->qp.peer = peer; entry->qp.flags = flags; entry->qp.produceSize = guestProduceSize; entry->qp.consumeSize = guestConsumeSize; entry->qp.refCount = 1; entry->createId = contextId; entry->attachId = VMCI_INVALID_ID; entry->state = VMCIQPB_NEW; entry->requireTrustedAttach = (context->privFlags & VMCI_PRIVILEGE_FLAG_RESTRICTED) ? TRUE : FALSE; entry->createdByTrusted = (privFlags & VMCI_PRIVILEGE_FLAG_TRUSTED) ? TRUE : FALSE; entry->vmciPageFiles = FALSE; entry->wakeupCB = wakeupCB; entry->clientData = clientData; entry->produceQ = VMCIHost_AllocQueue(guestProduceSize); if (entry->produceQ == NULL) { result = VMCI_ERROR_NO_MEM; VMCI_DEBUG_LOG(5, ("QP Create - no memory PQ\n")); goto error; } entry->consumeQ = VMCIHost_AllocQueue(guestConsumeSize); if (entry->consumeQ == NULL) { result = VMCI_ERROR_NO_MEM; VMCI_DEBUG_LOG(5, ("QP Create - no memory CQ\n")); goto error; } VMCI_InitQueueMutex(entry->produceQ, entry->consumeQ); VMCIList_InitEntry(&entry->qp.listItem); if (isLocal) { ASSERT(pageStore == NULL); entry->localMem = VMCI_AllocKernelMem(QPE_NUM_PAGES(entry->qp) * PAGE_SIZE, VMCI_MEMORY_NONPAGED); if (entry->localMem == NULL) { result = VMCI_ERROR_NO_MEM; VMCI_DEBUG_LOG(5, ("QP Create - no memory LM\n")); goto error; } entry->state = VMCIQPB_CREATED_MEM; entry->produceQ->qHeader = entry->localMem; entry->consumeQ->qHeader = (VMCIQueueHeader *)((uint8 *)entry->localMem + (CEILING(entry->qp.produceSize, PAGE_SIZE) + 1) * PAGE_SIZE); VMCIQueueHeader_Init(entry->produceQ->qHeader, handle); VMCIQueueHeader_Init(entry->consumeQ->qHeader, handle); } else if (pageStore) { ASSERT(entry->createId != VMCI_HOST_CONTEXT_ID || isLocal); /* * The VMX already initialized the queue pair headers, so no * need for the kernel side to do that. */ result = VMCIHost_RegisterUserMemory(pageStore, entry->produceQ, entry->consumeQ); if (result < VMCI_SUCCESS) { VMCI_DEBUG_LOG(5, ("QP Create - cannot register user memory\n")); goto error; } VMCIHost_MarkQueuesAvailable(entry->produceQ, entry->consumeQ); entry->state = VMCIQPB_CREATED_MEM; } else { /* * A create without a pageStore may be either a host side create (in which * case we are waiting for the guest side to supply the memory) or an old * style queue pair create (in which case we will expect a set page store * call as the next step). */ entry->state = VMCIQPB_CREATED_NO_MEM; } QueuePairList_AddEntry(&qpBrokerList, &entry->qp); if (ent != NULL) { *ent = entry; } VMCIContext_QueuePairCreate(context, handle); return VMCI_SUCCESS; error: if (entry != NULL) { if (entry->produceQ != NULL) { VMCIHost_FreeQueue(entry->produceQ, guestProduceSize); } if (entry->consumeQ != NULL) { VMCIHost_FreeQueue(entry->consumeQ, guestConsumeSize); } VMCI_FreeKernelMem(entry, sizeof *entry); } return result; } /* *----------------------------------------------------------------------------- * * VMCIQPBrokerAttach -- * * The second endpoint issuing a queue pair allocation will attach to the * queue pair registered with the queue pair broker. * * If the attacher is a guest, it will associate a VMX virtual address range * with the queue pair as specified by the pageStore. At this point, the * already attach host endpoint may start using the queue pair, and an * attach event is sent to it. For compatibility with older VMX'en, that * used a separate step to set the VMX virtual address range, the virtual * address range can be registered later using VMCIQPBroker_SetPageStore. In * that case, a pageStore of NULL should be used, and the attach event will * be generated once the actual page store has been set. * * If the attacher is the host, a pageStore of NULL should be used as well, * since the page store information is already set by the guest. * * For new VMX and host callers, the queue pair will be moved to the * VMCIQPB_ATTACHED_MEM state, and for older VMX callers, it will be * moved to the VMCOQPB_ATTACHED_NO_MEM state. * * Results: * VMCI_SUCCESS on success, appropriate error code otherwise. * * Side effects: * Memory will be allocated, and pages may be pinned. * *----------------------------------------------------------------------------- */ static int VMCIQPBrokerAttach(QPBrokerEntry *entry, // IN VMCIId peer, // IN uint32 flags, // IN VMCIPrivilegeFlags privFlags, // IN uint64 produceSize, // IN uint64 consumeSize, // IN QueuePairPageStore *pageStore, // IN/OUT VMCIContext *context, // IN: Caller VMCIEventReleaseCB wakeupCB, // IN void *clientData, // IN QPBrokerEntry **ent) // OUT { const VMCIId contextId = VMCIContext_GetId(context); Bool isLocal = flags & VMCI_QPFLAG_LOCAL; int result; UNREFERENCED_PARAMETER(peer); if (entry->state != VMCIQPB_CREATED_NO_MEM && entry->state != VMCIQPB_CREATED_MEM) { VMCI_DEBUG_LOG(5, ("QP Attach - state is %x\n", entry->state)); return VMCI_ERROR_UNAVAILABLE; } if (isLocal) { if (!(entry->qp.flags & VMCI_QPFLAG_LOCAL) || contextId != entry->createId) { VMCI_DEBUG_LOG(5, ("QP Attach - invalid args, ctx=%x, createId=%x\n", contextId, entry->createId)); return VMCI_ERROR_INVALID_ARGS; } } else if (contextId == entry->createId || contextId == entry->attachId) { VMCI_DEBUG_LOG(5, ("QP Attach - already, ctx=%x, create=%x, attach=%x\n", contextId, entry->createId, entry->attachId)); return VMCI_ERROR_ALREADY_EXISTS; } ASSERT(entry->qp.refCount < 2); ASSERT(entry->attachId == VMCI_INVALID_ID); if (VMCI_CONTEXT_IS_VM(contextId) && VMCI_CONTEXT_IS_VM(entry->createId)) { VMCI_DEBUG_LOG(5, ("QP Attach - VM2VM\n")); return VMCI_ERROR_DST_UNREACHABLE; } /* * If we are attaching from a restricted context then the queuepair * must have been created by a trusted endpoint. */ if (context->privFlags & VMCI_PRIVILEGE_FLAG_RESTRICTED) { if (!entry->createdByTrusted) { VMCI_DEBUG_LOG(5, ("QP Attach - restricted vs trusted\n")); return VMCI_ERROR_NO_ACCESS; } } /* * If we are attaching to a queuepair that was created by a restricted * context then we must be trusted. */ if (entry->requireTrustedAttach) { if (!(privFlags & VMCI_PRIVILEGE_FLAG_TRUSTED)) { VMCI_DEBUG_LOG(5, ("QP Attach - trusted attach required\n")); return VMCI_ERROR_NO_ACCESS; } } /* * If the creator specifies VMCI_INVALID_ID in "peer" field, access * control check is not performed. */ if (entry->qp.peer != VMCI_INVALID_ID && entry->qp.peer != contextId) { VMCI_DEBUG_LOG(5, ("QP Attach - bad peer id %x != %x\n", contextId, entry->qp.peer)); return VMCI_ERROR_NO_ACCESS; } if (entry->createId == VMCI_HOST_CONTEXT_ID) { /* * Do not attach if the caller doesn't support Host Queue Pairs * and a host created this queue pair. */ if (!VMCIContext_SupportsHostQP(context)) { VMCI_DEBUG_LOG(5, ("QP Attach - no attach to host qp\n")); return VMCI_ERROR_INVALID_RESOURCE; } } else if (contextId == VMCI_HOST_CONTEXT_ID) { VMCIContext *createContext; Bool supportsHostQP; /* * Do not attach a host to a user created queue pair if that * user doesn't support host queue pair end points. */ createContext = VMCIContext_Get(entry->createId); supportsHostQP = VMCIContext_SupportsHostQP(createContext); VMCIContext_Release(createContext); if (!supportsHostQP) { VMCI_DEBUG_LOG(5, ("QP Attach - no host attach to qp\n")); return VMCI_ERROR_INVALID_RESOURCE; } } if ((entry->qp.flags & ~VMCI_QP_ASYMM) != (flags & ~VMCI_QP_ASYMM_PEER)) { VMCI_DEBUG_LOG(5, ("QP Attach - flags mismatch\n")); return VMCI_ERROR_QUEUEPAIR_MISMATCH; } if (contextId != VMCI_HOST_CONTEXT_ID) { /* * The queue pair broker entry stores values from the guest * point of view, so an attaching guest should match the values * stored in the entry. */ if (entry->qp.produceSize != produceSize || entry->qp.consumeSize != consumeSize) { VMCI_DEBUG_LOG(5, ("QP Attach - queue size mismatch\n")); return VMCI_ERROR_QUEUEPAIR_MISMATCH; } } else if (entry->qp.produceSize != consumeSize || entry->qp.consumeSize != produceSize) { VMCI_DEBUG_LOG(5, ("QP Attach - host queue size mismatch\n")); return VMCI_ERROR_QUEUEPAIR_MISMATCH; } if (contextId != VMCI_HOST_CONTEXT_ID) { /* * If a guest attached to a queue pair, it will supply the backing memory. * If this is a pre NOVMVM vmx, the backing memory will be supplied by * calling VMCIQPBroker_SetPageStore() following the return of the * VMCIQPBroker_Alloc() call. If it is a vmx of version NOVMVM or later, * the page store must be supplied as part of the VMCIQPBroker_Alloc call. * Under all circumstances must the initially created queue pair not have * any memory associated with it already. */ if (entry->state != VMCIQPB_CREATED_NO_MEM) { VMCI_DEBUG_LOG(5, ("QP Attach - bad QP state for VM2VM, %x, %p\n", entry->state, pageStore)); return VMCI_ERROR_INVALID_ARGS; } if (pageStore != NULL) { /* * Patch up host state to point to guest supplied memory. The VMX * already initialized the queue pair headers, so no need for the * kernel side to do that. */ result = VMCIHost_RegisterUserMemory(pageStore, entry->produceQ, entry->consumeQ); if (result < VMCI_SUCCESS) { VMCI_DEBUG_LOG(5, ("QP Attach - cannot register memory\n")); return result; } VMCIHost_MarkQueuesAvailable(entry->produceQ, entry->consumeQ); if (entry->qp.flags & VMCI_QPFLAG_NONBLOCK) { result = VMCIHost_MapQueues(entry->produceQ, entry->consumeQ, entry->qp.flags); if (result < VMCI_SUCCESS) { VMCIHost_ReleaseUserMemory(entry->produceQ, entry->consumeQ); VMCI_DEBUG_LOG(5, ("QP Attach - cannot map queues\n")); return result; } } entry->state = VMCIQPB_ATTACHED_MEM; } else { entry->state = VMCIQPB_ATTACHED_NO_MEM; } } else if (entry->state == VMCIQPB_CREATED_NO_MEM) { /* * The host side is attempting to attach to a queue pair that doesn't have * any memory associated with it. This must be a pre NOVMVM vmx that hasn't * set the page store information yet, or a quiesced VM. */ VMCI_DEBUG_LOG(5, ("QP Attach - QP without memory\n")); return VMCI_ERROR_UNAVAILABLE; } else { /* * For non-blocking queue pairs, we cannot rely on enqueue/dequeue to map * in the pages on the host-side, since it may block, so we make an attempt * here. */ if (flags & VMCI_QPFLAG_NONBLOCK) { result = VMCIHost_MapQueues(entry->produceQ, entry->consumeQ, flags); if (result < VMCI_SUCCESS) { VMCI_DEBUG_LOG(5, ("QP Attach - cannot map queues for host\n")); return result; } entry->qp.flags |= flags & VMCI_QPFLAG_NONBLOCK; } /* * The host side has successfully attached to a queue pair. */ entry->state = VMCIQPB_ATTACHED_MEM; } if (entry->state == VMCIQPB_ATTACHED_MEM) { result = QueuePairNotifyPeer(TRUE, entry->qp.handle, contextId, entry->createId); if (result < VMCI_SUCCESS) { VMCI_WARNING((LGPFX"Failed to notify peer (ID=0x%x) of attach to queue " "pair (handle=0x%x:0x%x).\n", entry->createId, entry->qp.handle.context, entry->qp.handle.resource)); } } entry->attachId = contextId; entry->qp.refCount++; if (wakeupCB) { ASSERT(!entry->wakeupCB); entry->wakeupCB = wakeupCB; entry->clientData = clientData; } /* * When attaching to local queue pairs, the context already has * an entry tracking the queue pair, so don't add another one. */ if (!isLocal) { VMCIContext_QueuePairCreate(context, entry->qp.handle); } else { ASSERT(VMCIContext_QueuePairExists(context, entry->qp.handle)); } if (ent != NULL) { *ent = entry; } return VMCI_SUCCESS; } /* *----------------------------------------------------------------------------- * * VMCIQPBroker_SetPageStore -- * * VMX'en with versions lower than VMCI_VERSION_NOVMVM use a separate * step to add the UVAs of the VMX mapping of the queue pair. This function * provides backwards compatibility with such VMX'en, and takes care of * registering the page store for a queue pair previously allocated by the * VMX during create or attach. This function will move the queue pair state * to either from VMCIQBP_CREATED_NO_MEM to VMCIQBP_CREATED_MEM or * VMCIQBP_ATTACHED_NO_MEM to VMCIQBP_ATTACHED_MEM. If moving to the * attached state with memory, the queue pair is ready to be used by the * host peer, and an attached event will be generated. * * Assumes that the queue pair broker lock is held. * * This function is only used by the hosted platform, since there is no * issue with backwards compatibility for vmkernel. * * Results: * VMCI_SUCCESS on success, appropriate error code otherwise. * * Side effects: * Pages may get pinned. * *----------------------------------------------------------------------------- */ int VMCIQPBroker_SetPageStore(VMCIHandle handle, // IN VA64 produceUVA, // IN VA64 consumeUVA, // IN VMCIContext *context) // IN: Caller { QPBrokerEntry *entry; int result; const VMCIId contextId = VMCIContext_GetId(context); if (VMCI_HANDLE_INVALID(handle) || !context || contextId == VMCI_INVALID_ID) { return VMCI_ERROR_INVALID_ARGS; } /* * We only support guest to host queue pairs, so the VMX must * supply UVAs for the mapped page files. */ if (produceUVA == 0 || consumeUVA == 0) { return VMCI_ERROR_INVALID_ARGS; } VMCIQPBrokerLock(); if (!VMCIContext_QueuePairExists(context, handle)) { VMCI_WARNING((LGPFX"Context (ID=0x%x) not attached to queue pair " "(handle=0x%x:0x%x).\n", contextId, handle.context, handle.resource)); result = VMCI_ERROR_NOT_FOUND; goto out; } entry = (QPBrokerEntry *)QueuePairList_FindEntry(&qpBrokerList, handle); if (!entry) { result = VMCI_ERROR_NOT_FOUND; goto out; } /* * If I'm the owner then I can set the page store. * * Or, if a host created the QueuePair and I'm the attached peer * then I can set the page store. */ if (entry->createId != contextId && (entry->createId != VMCI_HOST_CONTEXT_ID || entry->attachId != contextId)) { result = VMCI_ERROR_QUEUEPAIR_NOTOWNER; goto out; } if (entry->state != VMCIQPB_CREATED_NO_MEM && entry->state != VMCIQPB_ATTACHED_NO_MEM) { result = VMCI_ERROR_UNAVAILABLE; goto out; } result = VMCIHost_GetUserMemory(produceUVA, consumeUVA, entry->produceQ, entry->consumeQ); if (result < VMCI_SUCCESS) { goto out; } VMCIHost_MarkQueuesAvailable(entry->produceQ, entry->consumeQ); result = VMCIHost_MapQueues(entry->produceQ, entry->consumeQ, FALSE); if (result < VMCI_SUCCESS) { VMCIHost_ReleaseUserMemory(entry->produceQ, entry->consumeQ); goto out; } if (entry->state == VMCIQPB_CREATED_NO_MEM) { entry->state = VMCIQPB_CREATED_MEM; } else { ASSERT(entry->state == VMCIQPB_ATTACHED_NO_MEM); entry->state = VMCIQPB_ATTACHED_MEM; } entry->vmciPageFiles = TRUE; if (entry->state == VMCIQPB_ATTACHED_MEM) { result = QueuePairNotifyPeer(TRUE, handle, contextId, entry->createId); if (result < VMCI_SUCCESS) { VMCI_WARNING((LGPFX"Failed to notify peer (ID=0x%x) of attach to queue " "pair (handle=0x%x:0x%x).\n", entry->createId, entry->qp.handle.context, entry->qp.handle.resource)); } } result = VMCI_SUCCESS; out: VMCIQPBrokerUnlock(); return result; } /* *----------------------------------------------------------------------------- * * VMCIQPBroker_Detach -- * * The main entry point for detaching from a queue pair registered with the * queue pair broker. If more than one endpoint is attached to the queue * pair, the first endpoint will mainly decrement a reference count and * generate a notification to its peer. The last endpoint will clean up * the queue pair state registered with the broker. * * When a guest endpoint detaches, it will unmap and unregister the guest * memory backing the queue pair. If the host is still attached, it will * no longer be able to access the queue pair content. * * If the queue pair is already in a state where there is no memory * registered for the queue pair (any *_NO_MEM state), it will transition to * the VMCIQPB_SHUTDOWN_NO_MEM state. This will also happen, if a guest * endpoint is the first of two endpoints to detach. If the host endpoint is * the first out of two to detach, the queue pair will move to the * VMCIQPB_SHUTDOWN_MEM state. * * Results: * VMCI_SUCCESS on success, appropriate error code otherwise. * * Side effects: * Memory may be freed, and pages may be unpinned. * *----------------------------------------------------------------------------- */ int VMCIQPBroker_Detach(VMCIHandle handle, // IN VMCIContext *context) // IN { QPBrokerEntry *entry; const VMCIId contextId = VMCIContext_GetId(context); VMCIId peerId; Bool isLocal = FALSE; int result; if (VMCI_HANDLE_INVALID(handle) || !context || contextId == VMCI_INVALID_ID) { return VMCI_ERROR_INVALID_ARGS; } VMCIQPBrokerLock(); if (!VMCIContext_QueuePairExists(context, handle)) { VMCI_DEBUG_LOG(4, (LGPFX"Context (ID=0x%x) not attached to queue pair " "(handle=0x%x:0x%x).\n", contextId, handle.context, handle.resource)); result = VMCI_ERROR_NOT_FOUND; goto out; } entry = (QPBrokerEntry *)QueuePairList_FindEntry(&qpBrokerList, handle); if (!entry) { VMCI_DEBUG_LOG(4, (LGPFX"Context (ID=0x%x) reports being attached to queue pair " "(handle=0x%x:0x%x) that isn't present in broker.\n", contextId, handle.context, handle.resource)); result = VMCI_ERROR_NOT_FOUND; goto out; } if (contextId != entry->createId && contextId != entry->attachId) { result = VMCI_ERROR_QUEUEPAIR_NOTATTACHED; goto out; } if (contextId == entry->createId) { peerId = entry->attachId; entry->createId = VMCI_INVALID_ID; } else { peerId = entry->createId; entry->attachId = VMCI_INVALID_ID; } entry->qp.refCount--; isLocal = entry->qp.flags & VMCI_QPFLAG_LOCAL; if (contextId != VMCI_HOST_CONTEXT_ID) { int result2; Bool headersMapped; ASSERT(!isLocal); /* * Pre NOVMVM vmx'en may detach from a queue pair before setting the page * store, and in that case there is no user memory to detach from. Also, * more recent VMX'en may detach from a queue pair in the quiesced state. */ VMCI_AcquireQueueMutex(entry->produceQ, TRUE); headersMapped = entry->produceQ->qHeader || entry->consumeQ->qHeader; if (QPBROKERSTATE_HAS_MEM(entry)) { result2 = VMCIHost_UnmapQueues(INVALID_VMCI_GUEST_MEM_ID, entry->produceQ, entry->consumeQ); if (result2 < VMCI_SUCCESS) { VMCI_WARNING((LGPFX"Failed to unmap queue headers for queue pair " "(handle=0x%x:0x%x,result2=%d).\n", handle.context, handle.resource, result2)); } VMCIHost_MarkQueuesUnavailable(entry->produceQ, entry->consumeQ); if (entry->vmciPageFiles) { VMCIHost_ReleaseUserMemory(entry->produceQ, entry->consumeQ); } else { VMCIHost_UnregisterUserMemory(entry->produceQ, entry->consumeQ); } } if (!headersMapped) { QueuePairResetSavedHeaders(entry); } VMCI_ReleaseQueueMutex(entry->produceQ); if (!headersMapped && entry->wakeupCB) { entry->wakeupCB(entry->clientData); } } else { if (entry->wakeupCB) { entry->wakeupCB = NULL; entry->clientData = NULL; } } if (entry->qp.refCount == 0) { QueuePairList_RemoveEntry(&qpBrokerList, &entry->qp); if (isLocal) { VMCI_FreeKernelMem(entry->localMem, QPE_NUM_PAGES(entry->qp) * PAGE_SIZE); } VMCI_CleanupQueueMutex(entry->produceQ, entry->consumeQ); VMCIHost_FreeQueue(entry->produceQ, entry->qp.produceSize); VMCIHost_FreeQueue(entry->consumeQ, entry->qp.consumeSize); VMCI_FreeKernelMem(entry, sizeof *entry); VMCIContext_QueuePairDestroy(context, handle); } else { ASSERT(peerId != VMCI_INVALID_ID); #if defined (VMKERNEL) entry->detachCause = context->quiesceCause; #endif QueuePairNotifyPeer(FALSE, handle, contextId, peerId); if (contextId == VMCI_HOST_CONTEXT_ID && QPBROKERSTATE_HAS_MEM(entry)) { entry->state = VMCIQPB_SHUTDOWN_MEM; } else { entry->state = VMCIQPB_SHUTDOWN_NO_MEM; } if (!isLocal) { VMCIContext_QueuePairDestroy(context, handle); } } result = VMCI_SUCCESS; out: VMCIQPBrokerUnlock(); return result; } /* *----------------------------------------------------------------------------- * * VMCIQPBroker_Map -- * * Establishes the necessary mappings for a queue pair given a * reference to the queue pair guest memory. This is usually * called when a guest is unquiesced and the VMX is allowed to * map guest memory once again. * * Results: * VMCI_SUCCESS on success, appropriate error code otherwise. * * Side effects: * Memory may be allocated, and pages may be pinned. * *----------------------------------------------------------------------------- */ int VMCIQPBroker_Map(VMCIHandle handle, // IN VMCIContext *context, // IN VMCIQPGuestMem guestMem) // IN { QPBrokerEntry *entry; const VMCIId contextId = VMCIContext_GetId(context); Bool isLocal = FALSE; int result; if (VMCI_HANDLE_INVALID(handle) || !context || contextId == VMCI_INVALID_ID) { return VMCI_ERROR_INVALID_ARGS; } VMCIQPBrokerLock(); if (!VMCIContext_QueuePairExists(context, handle)) { VMCI_DEBUG_LOG(4, (LGPFX"Context (ID=0x%x) not attached to queue pair " "(handle=0x%x:0x%x).\n", contextId, handle.context, handle.resource)); result = VMCI_ERROR_NOT_FOUND; goto out; } entry = (QPBrokerEntry *)QueuePairList_FindEntry(&qpBrokerList, handle); if (!entry) { VMCI_DEBUG_LOG(4, (LGPFX"Context (ID=0x%x) reports being attached to queue pair " "(handle=0x%x:0x%x) that isn't present in broker.\n", contextId, handle.context, handle.resource)); result = VMCI_ERROR_NOT_FOUND; goto out; } if (contextId != entry->createId && contextId != entry->attachId) { result = VMCI_ERROR_QUEUEPAIR_NOTATTACHED; goto out; } isLocal = entry->qp.flags & VMCI_QPFLAG_LOCAL; if (vmkernel) { /* * On vmkernel, the readiness of the queue pair can be signalled * immediately since the guest memory is already registered. */ VMCI_AcquireQueueMutex(entry->produceQ, TRUE); VMCIHost_MarkQueuesAvailable(entry->produceQ, entry->consumeQ); if (entry->qp.flags & VMCI_QPFLAG_NONBLOCK) { result = VMCIHost_MapQueues(entry->produceQ, entry->consumeQ, entry->qp.flags); } else { result = VMCI_SUCCESS; } if (result == VMCI_SUCCESS) { QueuePairResetSavedHeaders(entry); } VMCI_ReleaseQueueMutex(entry->produceQ); if (result == VMCI_SUCCESS) { if (entry->wakeupCB) { entry->wakeupCB(entry->clientData); } } } else if (contextId != VMCI_HOST_CONTEXT_ID) { QueuePairPageStore pageStore; ASSERT(entry->state == VMCIQPB_CREATED_NO_MEM || entry->state == VMCIQPB_SHUTDOWN_NO_MEM || entry->state == VMCIQPB_ATTACHED_NO_MEM); ASSERT(!isLocal); pageStore.pages = guestMem; pageStore.len = QPE_NUM_PAGES(entry->qp); VMCI_AcquireQueueMutex(entry->produceQ, TRUE); QueuePairResetSavedHeaders(entry); result = VMCIHost_RegisterUserMemory(&pageStore, entry->produceQ, entry->consumeQ); VMCIHost_MarkQueuesAvailable(entry->produceQ, entry->consumeQ); VMCI_ReleaseQueueMutex(entry->produceQ); if (result == VMCI_SUCCESS) { /* * Move state from *_NO_MEM to *_MEM. */ entry->state++; ASSERT(entry->state == VMCIQPB_CREATED_MEM || entry->state == VMCIQPB_SHUTDOWN_MEM || entry->state == VMCIQPB_ATTACHED_MEM); if (entry->wakeupCB) { entry->wakeupCB(entry->clientData); } } } else { result = VMCI_SUCCESS; } out: VMCIQPBrokerUnlock(); return result; } /* *----------------------------------------------------------------------------- * * QueuePairSaveHeaders -- * * Saves a snapshot of the queue headers for the given QP broker * entry. Should be used when guest memory is unmapped. * * Results: * VMCI_SUCCESS on success, appropriate error code if guest memory * can't be accessed.. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static int QueuePairSaveHeaders(QPBrokerEntry *entry) // IN { int result; if (entry->produceQ->savedHeader != NULL && entry->consumeQ->savedHeader != NULL) { /* * If the headers have already been saved, we don't need to do * it again, and we don't want to map in the headers * unnecessarily. */ return VMCI_SUCCESS; } if (NULL == entry->produceQ->qHeader || NULL == entry->consumeQ->qHeader) { result = VMCIHost_MapQueues(entry->produceQ, entry->consumeQ, FALSE); if (result < VMCI_SUCCESS) { return result; } #if defined(_WIN32) __assume(entry->produceQ->qHeader != NULL); __assume(entry->consumeQ->qHeader != NULL); #endif } memcpy(&entry->savedProduceQ, entry->produceQ->qHeader, sizeof entry->savedProduceQ); entry->produceQ->savedHeader = &entry->savedProduceQ; memcpy(&entry->savedConsumeQ, entry->consumeQ->qHeader, sizeof entry->savedConsumeQ); entry->consumeQ->savedHeader = &entry->savedConsumeQ; return VMCI_SUCCESS; } /* *----------------------------------------------------------------------------- * * QueuePairResetSavedHeaders -- * * Resets saved queue headers for the given QP broker * entry. Should be used when guest memory becomes available * again, or the guest detaches. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static void QueuePairResetSavedHeaders(QPBrokerEntry *entry) // IN { if (vmkernel) { VMCI_LockQueueHeader(entry->produceQ); } entry->produceQ->savedHeader = NULL; entry->consumeQ->savedHeader = NULL; if (vmkernel) { VMCI_UnlockQueueHeader(entry->produceQ); } } /* *----------------------------------------------------------------------------- * * VMCIQPBroker_Unmap -- * * Removes all references to the guest memory of a given queue pair, and * will move the queue pair from state *_MEM to *_NO_MEM. It is usually * called when a VM is being quiesced where access to guest memory should * avoided. * * Results: * VMCI_SUCCESS on success, appropriate error code otherwise. * * Side effects: * Memory may be freed, and pages may be unpinned. * *----------------------------------------------------------------------------- */ int VMCIQPBroker_Unmap(VMCIHandle handle, // IN VMCIContext *context, // IN VMCIGuestMemID gid) // IN { QPBrokerEntry *entry; const VMCIId contextId = VMCIContext_GetId(context); Bool isLocal = FALSE; int result; if (VMCI_HANDLE_INVALID(handle) || !context || contextId == VMCI_INVALID_ID) { return VMCI_ERROR_INVALID_ARGS; } VMCIQPBrokerLock(); if (!VMCIContext_QueuePairExists(context, handle)) { VMCI_DEBUG_LOG(4, (LGPFX"Context (ID=0x%x) not attached to queue pair " "(handle=0x%x:0x%x).\n", contextId, handle.context, handle.resource)); result = VMCI_ERROR_NOT_FOUND; goto out; } entry = (QPBrokerEntry *)QueuePairList_FindEntry(&qpBrokerList, handle); if (!entry) { VMCI_DEBUG_LOG(4, (LGPFX"Context (ID=0x%x) reports being attached to queue pair " "(handle=0x%x:0x%x) that isn't present in broker.\n", contextId, handle.context, handle.resource)); result = VMCI_ERROR_NOT_FOUND; goto out; } if (contextId != entry->createId && contextId != entry->attachId) { result = VMCI_ERROR_QUEUEPAIR_NOTATTACHED; goto out; } isLocal = entry->qp.flags & VMCI_QPFLAG_LOCAL; if (contextId != VMCI_HOST_CONTEXT_ID) { ASSERT(entry->state != VMCIQPB_CREATED_NO_MEM && entry->state != VMCIQPB_SHUTDOWN_NO_MEM && entry->state != VMCIQPB_ATTACHED_NO_MEM); ASSERT(!isLocal); VMCI_AcquireQueueMutex(entry->produceQ, TRUE); result = QueuePairSaveHeaders(entry); if (result < VMCI_SUCCESS) { VMCI_WARNING((LGPFX"Failed to save queue headers for queue pair " "(handle=0x%x:0x%x,result=%d).\n", handle.context, handle.resource, result)); } VMCIHost_UnmapQueues(gid, entry->produceQ, entry->consumeQ); VMCIHost_MarkQueuesUnavailable(entry->produceQ, entry->consumeQ); if (!vmkernel) { /* * On hosted, when we unmap queue pairs, the VMX will also * unmap the guest memory, so we invalidate the previously * registered memory. If the queue pair is mapped again at a * later point in time, we will need to reregister the user * memory with a possibly new user VA. */ VMCIHost_UnregisterUserMemory(entry->produceQ, entry->consumeQ); /* * Move state from *_MEM to *_NO_MEM. */ entry->state--; } VMCI_ReleaseQueueMutex(entry->produceQ); } result = VMCI_SUCCESS; out: VMCIQPBrokerUnlock(); return result; } #if defined(VMKERNEL) /* *----------------------------------------------------------------------------- * * VMCIQPBroker_Revalidate -- * * Revalidates the guest memory mappings of a given queue pair. * * Results: * VMCI_SUCCESS on success, appropriate error code otherwise. * * Side effects: * Nond. * *----------------------------------------------------------------------------- */ int VMCIQPBroker_Revalidate(VMCIHandle handle, // IN VMCIContext *context) // IN { QPBrokerEntry *entry; const VMCIId contextId = VMCIContext_GetId(context); int result = VMCI_SUCCESS; ASSERT(!VMCI_HANDLE_INVALID(handle) && contextId != VMCI_INVALID_ID); VMCIQPBrokerLock(); if (!VMCIContext_QueuePairExists(context, handle)) { VMCI_DEBUG_LOG(4, (LGPFX"Context (ID=0x%x) not attached to queue pair " "(handle=0x%x:0x%x).\n", contextId, handle.context, handle.resource)); result = VMCI_ERROR_NOT_FOUND; goto out; } entry = (QPBrokerEntry *)QueuePairList_FindEntry(&qpBrokerList, handle); if (entry == NULL) { VMCI_DEBUG_LOG(4, (LGPFX"Context (ID=0x%x) reports being attached to " "queue pair (handle=0x%x:0x%x) that isn't present in " "broker.\n", contextId, handle.context, handle.resource)); result = VMCI_ERROR_NOT_FOUND; goto out; } if (contextId != entry->createId && contextId != entry->attachId) { result = VMCI_ERROR_QUEUEPAIR_NOTATTACHED; goto out; } if (contextId != VMCI_HOST_CONTEXT_ID) { ASSERT(entry->state != VMCIQPB_CREATED_NO_MEM && entry->state != VMCIQPB_SHUTDOWN_NO_MEM && entry->state != VMCIQPB_ATTACHED_NO_MEM); ASSERT((entry->qp.flags & VMCI_QPFLAG_LOCAL) == 0); VMCI_AcquireQueueMutex(entry->produceQ, TRUE); result = VMCIHost_RevalidateQueues(entry->produceQ, entry->consumeQ); VMCI_ReleaseQueueMutex(entry->produceQ); } out: VMCIQPBrokerUnlock(); return result; } #endif #if !defined(VMKERNEL) /* *----------------------------------------------------------------------------- * * VMCIQPGuestEndpoints_Init -- * * Initalizes data structure state keeping track of queue pair * guest endpoints. * * Results: * VMCI_SUCCESS on success and appropriate failure code otherwise. * * Side effects: * None. * *----------------------------------------------------------------------------- */ int VMCIQPGuestEndpoints_Init(void) { int err; err = QueuePairList_Init(&qpGuestEndpoints); if (err < VMCI_SUCCESS) { return err; } hibernateFailedList = VMCIHandleArray_Create(0); if (NULL == hibernateFailedList) { QueuePairList_Destroy(&qpGuestEndpoints); return VMCI_ERROR_NO_MEM; } /* * The lock rank must be lower than subscriberLock in vmciEvent, * since we hold the hibernateFailedListLock while generating * detach events. */ err = VMCI_InitLock(&hibernateFailedListLock, "VMCIQPHibernateFailed", VMCI_LOCK_RANK_QPHIBERNATE); if (err < VMCI_SUCCESS) { VMCIHandleArray_Destroy(hibernateFailedList); hibernateFailedList = NULL; QueuePairList_Destroy(&qpGuestEndpoints); } return err; } /* *----------------------------------------------------------------------------- * * VMCIQPGuestEndpoints_Exit -- * * Destroys all guest queue pair endpoints. If active guest queue * pairs still exist, hypercalls to attempt detach from these * queue pairs will be made. Any failure to detach is silently * ignored. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ void VMCIQPGuestEndpoints_Exit(void) { QPGuestEndpoint *entry; VMCIMutex_Acquire(&qpGuestEndpoints.mutex); while ((entry = (QPGuestEndpoint *)QueuePairList_GetHead(&qpGuestEndpoints)) != NULL) { /* * Don't make a hypercall for local QueuePairs. */ if (!(entry->qp.flags & VMCI_QPFLAG_LOCAL)) { VMCIQueuePairDetachHypercall(entry->qp.handle); } /* * We cannot fail the exit, so let's reset refCount. */ entry->qp.refCount = 0; QueuePairList_RemoveEntry(&qpGuestEndpoints, &entry->qp); QPGuestEndpointDestroy(entry); } Atomic_Write(&qpGuestEndpoints.hibernate, 0); VMCIMutex_Release(&qpGuestEndpoints.mutex); QueuePairList_Destroy(&qpGuestEndpoints); VMCI_CleanupLock(&hibernateFailedListLock); VMCIHandleArray_Destroy(hibernateFailedList); } /* *----------------------------------------------------------------------------- * * VMCIQPGuestEndpoints_Sync -- * * Use this as a synchronization point when setting globals, for example, * during device shutdown. * * Results: * TRUE. * * Side effects: * None. * *----------------------------------------------------------------------------- */ void VMCIQPGuestEndpoints_Sync(void) { VMCIMutex_Acquire(&qpGuestEndpoints.mutex); VMCIMutex_Release(&qpGuestEndpoints.mutex); } /* *----------------------------------------------------------------------------- * * QPGuestEndpointCreate -- * * Allocates and initializes a QPGuestEndpoint structure. * Allocates a QueuePair rid (and handle) iff the given entry has * an invalid handle. 0 through VMCI_RESERVED_RESOURCE_ID_MAX * are reserved handles. Assumes that the QP list mutex is held * by the caller. * * Results: * Pointer to structure intialized. * * Side effects: * None. * *----------------------------------------------------------------------------- */ QPGuestEndpoint * QPGuestEndpointCreate(VMCIHandle handle, // IN VMCIId peer, // IN uint32 flags, // IN uint64 produceSize, // IN uint64 consumeSize, // IN void *produceQ, // IN void *consumeQ) // IN { static VMCIId queuePairRID = VMCI_RESERVED_RESOURCE_ID_MAX + 1; QPGuestEndpoint *entry; const uint64 numPPNs = CEILING(produceSize, PAGE_SIZE) + CEILING(consumeSize, PAGE_SIZE) + 2; /* One page each for the queue headers. */ ASSERT((produceSize || consumeSize) && produceQ && consumeQ); if (VMCI_HANDLE_INVALID(handle)) { VMCIId contextID = vmci_get_context_id(); VMCIId oldRID = queuePairRID; /* * Generate a unique QueuePair rid. Keep on trying until we wrap around * in the RID space. */ ASSERT(oldRID > VMCI_RESERVED_RESOURCE_ID_MAX); do { handle = VMCI_MAKE_HANDLE(contextID, queuePairRID); entry = (QPGuestEndpoint *)QueuePairList_FindEntry(&qpGuestEndpoints, handle); queuePairRID++; if (UNLIKELY(!queuePairRID)) { /* * Skip the reserved rids. */ queuePairRID = VMCI_RESERVED_RESOURCE_ID_MAX + 1; } } while (entry && queuePairRID != oldRID); if (UNLIKELY(entry != NULL)) { ASSERT(queuePairRID == oldRID); /* * We wrapped around --- no rids were free. */ return NULL; } } ASSERT(!VMCI_HANDLE_INVALID(handle) && QueuePairList_FindEntry(&qpGuestEndpoints, handle) == NULL); entry = VMCI_AllocKernelMem(sizeof *entry, VMCI_MEMORY_NORMAL); if (entry) { entry->qp.handle = handle; entry->qp.peer = peer; entry->qp.flags = flags; entry->qp.produceSize = produceSize; entry->qp.consumeSize = consumeSize; entry->qp.refCount = 0; entry->numPPNs = numPPNs; memset(&entry->ppnSet, 0, sizeof entry->ppnSet); entry->produceQ = produceQ; entry->consumeQ = consumeQ; VMCIList_InitEntry(&entry->qp.listItem); } return entry; } /* *----------------------------------------------------------------------------- * * QPGuestEndpointDestroy -- * * Frees a QPGuestEndpoint structure. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ void QPGuestEndpointDestroy(QPGuestEndpoint *entry) // IN { ASSERT(entry); ASSERT(entry->qp.refCount == 0); VMCI_FreePPNSet(&entry->ppnSet); VMCI_CleanupQueueMutex(entry->produceQ, entry->consumeQ); VMCI_FreeQueue(entry->produceQ, entry->qp.produceSize); VMCI_FreeQueue(entry->consumeQ, entry->qp.consumeSize); VMCI_FreeKernelMem(entry, sizeof *entry); } /* *----------------------------------------------------------------------------- * * VMCIQueuePairAllocHypercall -- * * Helper to make a QueuePairAlloc hypercall when the driver is * supporting a guest device. * * Results: * Result of the hypercall. * * Side effects: * Memory is allocated & freed. * *----------------------------------------------------------------------------- */ static int VMCIQueuePairAllocHypercall(const QPGuestEndpoint *entry) // IN { VMCIQueuePairAllocMsg *allocMsg; size_t msgSize; int result; if (!entry || entry->numPPNs <= 2) { return VMCI_ERROR_INVALID_ARGS; } ASSERT(!(entry->qp.flags & VMCI_QPFLAG_LOCAL)); msgSize = sizeof *allocMsg + (size_t)entry->numPPNs * sizeof(PPN); allocMsg = VMCI_AllocKernelMem(msgSize, VMCI_MEMORY_NONPAGED); if (!allocMsg) { return VMCI_ERROR_NO_MEM; } allocMsg->hdr.dst = VMCI_MAKE_HANDLE(VMCI_HYPERVISOR_CONTEXT_ID, VMCI_QUEUEPAIR_ALLOC); allocMsg->hdr.src = VMCI_ANON_SRC_HANDLE; allocMsg->hdr.payloadSize = msgSize - VMCI_DG_HEADERSIZE; allocMsg->handle = entry->qp.handle; allocMsg->peer = entry->qp.peer; allocMsg->flags = entry->qp.flags; allocMsg->produceSize = entry->qp.produceSize; allocMsg->consumeSize = entry->qp.consumeSize; allocMsg->numPPNs = entry->numPPNs; result = VMCI_PopulatePPNList((uint8 *)allocMsg + sizeof *allocMsg, &entry->ppnSet); if (result == VMCI_SUCCESS) { result = VMCI_SendDatagram((VMCIDatagram *)allocMsg); } VMCI_FreeKernelMem(allocMsg, msgSize); return result; } /* *----------------------------------------------------------------------------- * * VMCIQueuePairAllocGuestWork -- * * This functions handles the actual allocation of a VMCI queue * pair guest endpoint. Allocates physical pages for the queue * pair. It makes OS dependent calls through generic wrappers. * * Results: * Success or failure. * * Side effects: * Memory is allocated. * *----------------------------------------------------------------------------- */ static int VMCIQueuePairAllocGuestWork(VMCIHandle *handle, // IN/OUT VMCIQueue **produceQ, // OUT uint64 produceSize, // IN VMCIQueue **consumeQ, // OUT uint64 consumeSize, // IN VMCIId peer, // IN uint32 flags, // IN VMCIPrivilegeFlags privFlags) // IN { const uint64 numProducePages = CEILING(produceSize, PAGE_SIZE) + 1; const uint64 numConsumePages = CEILING(consumeSize, PAGE_SIZE) + 1; void *myProduceQ = NULL; void *myConsumeQ = NULL; int result; QPGuestEndpoint *queuePairEntry = NULL; /* * XXX Check for possible overflow of 'size' arguments when passed to * compat_get_order (after some arithmetic ops). */ ASSERT(handle && produceQ && consumeQ && (produceSize || consumeSize)); if (privFlags != VMCI_NO_PRIVILEGE_FLAGS) { return VMCI_ERROR_NO_ACCESS; } VMCIMutex_Acquire(&qpGuestEndpoints.mutex); /* Check if creation/attachment of a queuepair is allowed. */ if (!VMCI_CanCreate()) { result = VMCI_ERROR_UNAVAILABLE; goto error; } if ((Atomic_Read(&qpGuestEndpoints.hibernate) == 1) && !(flags & VMCI_QPFLAG_LOCAL)) { /* * While guest OS is in hibernate state, creating non-local * queue pairs is not allowed after the point where the VMCI * guest driver converted the existing queue pairs to local * ones. */ result = VMCI_ERROR_UNAVAILABLE; goto error; } if ((queuePairEntry = (QPGuestEndpoint *) QueuePairList_FindEntry(&qpGuestEndpoints, *handle)) != NULL) { if (queuePairEntry->qp.flags & VMCI_QPFLAG_LOCAL) { /* Local attach case. */ if (queuePairEntry->qp.refCount > 1) { VMCI_DEBUG_LOG(4, (LGPFX"Error attempting to attach more than " "once.\n")); result = VMCI_ERROR_UNAVAILABLE; goto errorKeepEntry; } if (queuePairEntry->qp.produceSize != consumeSize || queuePairEntry->qp.consumeSize != produceSize || queuePairEntry->qp.flags != (flags & ~VMCI_QPFLAG_ATTACH_ONLY)) { VMCI_DEBUG_LOG(4, (LGPFX"Error mismatched queue pair in local " "attach.\n")); result = VMCI_ERROR_QUEUEPAIR_MISMATCH; goto errorKeepEntry; } /* * Do a local attach. We swap the consume and produce queues for the * attacher and deliver an attach event. */ result = QueuePairNotifyPeerLocal(TRUE, *handle); if (result < VMCI_SUCCESS) { goto errorKeepEntry; } myProduceQ = queuePairEntry->consumeQ; myConsumeQ = queuePairEntry->produceQ; goto out; } result = VMCI_ERROR_ALREADY_EXISTS; goto errorKeepEntry; } myProduceQ = VMCI_AllocQueue(produceSize, flags); if (!myProduceQ) { VMCI_WARNING((LGPFX"Error allocating pages for produce queue.\n")); result = VMCI_ERROR_NO_MEM; goto error; } myConsumeQ = VMCI_AllocQueue(consumeSize, flags); if (!myConsumeQ) { VMCI_WARNING((LGPFX"Error allocating pages for consume queue.\n")); result = VMCI_ERROR_NO_MEM; goto error; } queuePairEntry = QPGuestEndpointCreate(*handle, peer, flags, produceSize, consumeSize, myProduceQ, myConsumeQ); if (!queuePairEntry) { VMCI_WARNING((LGPFX"Error allocating memory in %s.\n", __FUNCTION__)); result = VMCI_ERROR_NO_MEM; goto error; } result = VMCI_AllocPPNSet(myProduceQ, numProducePages, myConsumeQ, numConsumePages, &queuePairEntry->ppnSet); if (result < VMCI_SUCCESS) { VMCI_WARNING((LGPFX"VMCI_AllocPPNSet failed.\n")); goto error; } /* * It's only necessary to notify the host if this queue pair will be * attached to from another context. */ if (queuePairEntry->qp.flags & VMCI_QPFLAG_LOCAL) { /* Local create case. */ VMCIId contextId = vmci_get_context_id(); /* * Enforce similar checks on local queue pairs as we do for regular ones. * The handle's context must match the creator or attacher context id * (here they are both the current context id) and the attach-only flag * cannot exist during create. We also ensure specified peer is this * context or an invalid one. */ if (queuePairEntry->qp.handle.context != contextId || (queuePairEntry->qp.peer != VMCI_INVALID_ID && queuePairEntry->qp.peer != contextId)) { result = VMCI_ERROR_NO_ACCESS; goto error; } if (queuePairEntry->qp.flags & VMCI_QPFLAG_ATTACH_ONLY) { result = VMCI_ERROR_NOT_FOUND; goto error; } } else { result = VMCIQueuePairAllocHypercall(queuePairEntry); if (result < VMCI_SUCCESS) { VMCI_WARNING((LGPFX"VMCIQueuePairAllocHypercall result = %d.\n", result)); goto error; } } VMCI_InitQueueMutex((VMCIQueue *)myProduceQ, (VMCIQueue *)myConsumeQ); QueuePairList_AddEntry(&qpGuestEndpoints, &queuePairEntry->qp); out: queuePairEntry->qp.refCount++; *handle = queuePairEntry->qp.handle; *produceQ = (VMCIQueue *)myProduceQ; *consumeQ = (VMCIQueue *)myConsumeQ; /* * We should initialize the queue pair header pages on a local queue pair * create. For non-local queue pairs, the hypervisor initializes the header * pages in the create step. */ if ((queuePairEntry->qp.flags & VMCI_QPFLAG_LOCAL) && queuePairEntry->qp.refCount == 1) { VMCIQueueHeader_Init((*produceQ)->qHeader, *handle); VMCIQueueHeader_Init((*consumeQ)->qHeader, *handle); } VMCIMutex_Release(&qpGuestEndpoints.mutex); return VMCI_SUCCESS; error: VMCIMutex_Release(&qpGuestEndpoints.mutex); if (queuePairEntry) { /* The queues will be freed inside the destroy routine. */ QPGuestEndpointDestroy(queuePairEntry); } else { if (myProduceQ) { VMCI_FreeQueue(myProduceQ, produceSize); } if (myConsumeQ) { VMCI_FreeQueue(myConsumeQ, consumeSize); } } return result; errorKeepEntry: /* This path should only be used when an existing entry was found. */ ASSERT(queuePairEntry->qp.refCount > 0); VMCIMutex_Release(&qpGuestEndpoints.mutex); return result; } /* *----------------------------------------------------------------------------- * * VMCIQueuePairDetachHypercall -- * * Helper to make a QueuePairDetach hypercall when the driver is * supporting a guest device. * * Results: * Result of the hypercall. * * Side effects: * None. * *----------------------------------------------------------------------------- */ int VMCIQueuePairDetachHypercall(VMCIHandle handle) // IN { VMCIQueuePairDetachMsg detachMsg; detachMsg.hdr.dst = VMCI_MAKE_HANDLE(VMCI_HYPERVISOR_CONTEXT_ID, VMCI_QUEUEPAIR_DETACH); detachMsg.hdr.src = VMCI_ANON_SRC_HANDLE; detachMsg.hdr.payloadSize = sizeof handle; detachMsg.handle = handle; return VMCI_SendDatagram((VMCIDatagram *)&detachMsg); } /* *----------------------------------------------------------------------------- * * VMCIQueuePairDetachGuestWork -- * * Helper for VMCI QueuePair detach interface. Frees the physical * pages for the queue pair. * * Results: * Success or failure. * * Side effects: * Memory may be freed. * *----------------------------------------------------------------------------- */ static int VMCIQueuePairDetachGuestWork(VMCIHandle handle) // IN { int result; QPGuestEndpoint *entry; uint32 refCount; ASSERT(!VMCI_HANDLE_INVALID(handle)); VMCIMutex_Acquire(&qpGuestEndpoints.mutex); entry = (QPGuestEndpoint *)QueuePairList_FindEntry(&qpGuestEndpoints, handle); if (!entry) { VMCIMutex_Release(&qpGuestEndpoints.mutex); return VMCI_ERROR_NOT_FOUND; } ASSERT(entry->qp.refCount >= 1); if (entry->qp.flags & VMCI_QPFLAG_LOCAL) { result = VMCI_SUCCESS; if (entry->qp.refCount > 1) { result = QueuePairNotifyPeerLocal(FALSE, handle); /* * We can fail to notify a local queuepair because we can't allocate. * We still want to release the entry if that happens, so don't bail * out yet. */ } } else { result = VMCIQueuePairDetachHypercall(handle); if (entry->hibernateFailure) { if (result == VMCI_ERROR_NOT_FOUND) { /* * If a queue pair detach failed when entering * hibernation, the guest driver and the device may * disagree on its existence when coming out of * hibernation. The guest driver will regard it as a * non-local queue pair, but the device state is gone, * since the device has been powered off. In this case, we * treat the queue pair as a local queue pair with no * peer. */ ASSERT(entry->qp.refCount == 1); result = VMCI_SUCCESS; } if (result == VMCI_SUCCESS) { VMCIQPUnmarkHibernateFailed(entry); } } if (result < VMCI_SUCCESS) { /* * We failed to notify a non-local queuepair. That other queuepair * might still be accessing the shared memory, so don't release the * entry yet. It will get cleaned up by VMCIQueuePair_Exit() * if necessary (assuming we are going away, otherwise why did this * fail?). */ VMCIMutex_Release(&qpGuestEndpoints.mutex); return result; } } /* * If we get here then we either failed to notify a local queuepair, or * we succeeded in all cases. Release the entry if required. */ entry->qp.refCount--; if (entry->qp.refCount == 0) { QueuePairList_RemoveEntry(&qpGuestEndpoints, &entry->qp); } /* If we didn't remove the entry, this could change once we unlock. */ refCount = entry ? entry->qp.refCount : 0xffffffff; /* * Value does not matter, silence the * compiler. */ VMCIMutex_Release(&qpGuestEndpoints.mutex); if (refCount == 0) { QPGuestEndpointDestroy(entry); } return result; } /* *---------------------------------------------------------------------------- * * QueuePairNotifyPeerLocal -- * * Dispatches a queue pair event message directly into the local event * queue. * * Results: * VMCI_SUCCESS on success, error code otherwise * * Side effects: * None. * *---------------------------------------------------------------------------- */ static int QueuePairNotifyPeerLocal(Bool attach, // IN: attach or detach? VMCIHandle handle) // IN: queue pair handle { VMCIEventMsg *eMsg; VMCIEventPayload_QP *ePayload; /* buf is only 48 bytes. */ char buf[sizeof *eMsg + sizeof *ePayload]; VMCIId contextId = vmci_get_context_id(); eMsg = (VMCIEventMsg *)buf; ePayload = VMCIEventMsgPayload(eMsg); eMsg->hdr.dst = VMCI_MAKE_HANDLE(contextId, VMCI_EVENT_HANDLER); eMsg->hdr.src = VMCI_MAKE_HANDLE(VMCI_HYPERVISOR_CONTEXT_ID, VMCI_CONTEXT_RESOURCE_ID); eMsg->hdr.payloadSize = sizeof *eMsg + sizeof *ePayload - sizeof eMsg->hdr; eMsg->eventData.event = attach ? VMCI_EVENT_QP_PEER_ATTACH : VMCI_EVENT_QP_PEER_DETACH; ePayload->peerId = contextId; ePayload->handle = handle; return VMCIEvent_Dispatch((VMCIDatagram *)eMsg); } /* *----------------------------------------------------------------------------- * * VMCIQPMarkHibernateFailed -- * * Helper function that marks a queue pair entry as not being * converted to a local version during hibernation. Must be * called with the queue pair list mutex held. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static void VMCIQPMarkHibernateFailed(QPGuestEndpoint *entry) // IN { VMCILockFlags flags; VMCIHandle handle; /* * entry->handle is located in paged memory, so it can't be * accessed while holding a spinlock. */ handle = entry->qp.handle; entry->hibernateFailure = TRUE; VMCI_GrabLock_BH(&hibernateFailedListLock, &flags); VMCIHandleArray_AppendEntry(&hibernateFailedList, handle); VMCI_ReleaseLock_BH(&hibernateFailedListLock, flags); } /* *----------------------------------------------------------------------------- * * VMCIQPUnmarkHibernateFailed -- * * Helper function that removes a queue pair entry from the group * of handles marked as having failed hibernation. Must be called * with the queue pair list lock held. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static void VMCIQPUnmarkHibernateFailed(QPGuestEndpoint *entry) // IN { VMCILockFlags flags; VMCIHandle handle; /* * entry->handle is located in paged memory, so it can't be * accessed while holding a spinlock. */ handle = entry->qp.handle; entry->hibernateFailure = FALSE; VMCI_GrabLock_BH(&hibernateFailedListLock, &flags); VMCIHandleArray_RemoveEntry(hibernateFailedList, handle); VMCI_ReleaseLock_BH(&hibernateFailedListLock, flags); } /* *---------------------------------------------------------------------------- * * VMCIQPGuestEndpoints_Convert -- * * Guest queue pair endpoints may be converted to local ones in * two cases: when entering hibernation or when the device is * powered off before entering a sleep mode. Below we first * discuss the case of hibernation and then the case of entering * sleep state. * * When the guest enters hibernation, any non-local queue pairs * will disconnect no later than at the time the VMCI device * powers off. To preserve the content of the non-local queue * pairs for this guest, we make a local copy of the content and * disconnect from the queue pairs. This will ensure that the * peer doesn't continue to update the queue pair state while the * guest OS is checkpointing the memory (otherwise we might end * up with a inconsistent snapshot where the pointers of the * consume queue are checkpointed later than the data pages they * point to, possibly indicating that non-valid data is * valid). While we are in hibernation mode, we block the * allocation of new non-local queue pairs. Note that while we * are doing the conversion to local queue pairs, we are holding * the queue pair list lock, which will prevent concurrent * creation of additional non-local queue pairs. * * The hibernation cannot fail, so if we are unable to either * save the queue pair state or detach from a queue pair, we deal * with it by keeping the queue pair around, and converting it to * a local queue pair when going out of hibernation. Since * failing a detach is highly unlikely (it would require a queue * pair being actively used as part of a DMA operation), this is * an acceptable fall back. Once we come back from hibernation, * these queue pairs will no longer be external, so we simply * mark them as local at that point. * * For the sleep state, the VMCI device will also be put into the * D3 power state, which may make the device inaccessible to the * guest driver (Windows unmaps the I/O space). When entering * sleep state, the hypervisor is likely to suspend the guest as * well, which will again convert all queue pairs to local ones. * However, VMCI device clients, e.g., VMCI Sockets, may attempt * to use queue pairs after the device has been put into the D3 * power state, so we convert the queue pairs to local ones in * that case as well. When exiting the sleep states, the device * has not been reset, so all device state is still in sync with * the device driver, so no further processing is necessary at * that point. * * Results: * None. * * Side effects: * Queue pairs are detached. * *---------------------------------------------------------------------------- */ void VMCIQPGuestEndpoints_Convert(Bool toLocal, // IN Bool deviceReset) // IN { if (toLocal) { VMCIListItem *next; VMCIMutex_Acquire(&qpGuestEndpoints.mutex); VMCIList_Scan(next, &qpGuestEndpoints.head) { QPGuestEndpoint *entry = (QPGuestEndpoint *)VMCIList_Entry( next, QueuePairEntry, listItem); if (!(entry->qp.flags & VMCI_QPFLAG_LOCAL)) { UNUSED_PARAM(VMCIQueue *prodQ); // Only used on Win32 UNUSED_PARAM(VMCIQueue *consQ); // Only used on Win32 void *oldProdQ; UNUSED_PARAM(void *oldConsQ); // Only used on Win32 int result; prodQ = (VMCIQueue *)entry->produceQ; consQ = (VMCIQueue *)entry->consumeQ; oldConsQ = oldProdQ = NULL; VMCI_AcquireQueueMutex(prodQ, TRUE); result = VMCI_ConvertToLocalQueue(consQ, prodQ, entry->qp.consumeSize, TRUE, &oldConsQ); if (result != VMCI_SUCCESS) { VMCI_WARNING((LGPFX"Hibernate failed to create local consume " "queue from handle %x:%x (error: %d)\n", entry->qp.handle.context, entry->qp.handle.resource, result)); VMCI_ReleaseQueueMutex(prodQ); VMCIQPMarkHibernateFailed(entry); continue; } result = VMCI_ConvertToLocalQueue(prodQ, consQ, entry->qp.produceSize, FALSE, &oldProdQ); if (result != VMCI_SUCCESS) { VMCI_WARNING((LGPFX"Hibernate failed to create local produce " "queue from handle %x:%x (error: %d)\n", entry->qp.handle.context, entry->qp.handle.resource, result)); VMCI_RevertToNonLocalQueue(consQ, oldConsQ, entry->qp.consumeSize); VMCI_ReleaseQueueMutex(prodQ); VMCIQPMarkHibernateFailed(entry); continue; } /* * Now that the contents of the queue pair has been saved, * we can detach from the non-local queue pair. This will * discard the content of the non-local queues. */ result = VMCIQueuePairDetachHypercall(entry->qp.handle); if (result < VMCI_SUCCESS) { VMCI_WARNING((LGPFX"Hibernate failed to detach from handle " "%x:%x\n", entry->qp.handle.context, entry->qp.handle.resource)); VMCI_RevertToNonLocalQueue(consQ, oldConsQ, entry->qp.consumeSize); VMCI_RevertToNonLocalQueue(prodQ, oldProdQ, entry->qp.produceSize); VMCI_ReleaseQueueMutex(prodQ); VMCIQPMarkHibernateFailed(entry); continue; } entry->qp.flags |= VMCI_QPFLAG_LOCAL; VMCI_ReleaseQueueMutex(prodQ); VMCI_FreeQueueBuffer(oldProdQ, entry->qp.produceSize); VMCI_FreeQueueBuffer(oldConsQ, entry->qp.consumeSize); QueuePairNotifyPeerLocal(FALSE, entry->qp.handle); } } Atomic_Write(&qpGuestEndpoints.hibernate, 1); VMCIMutex_Release(&qpGuestEndpoints.mutex); } else { VMCILockFlags flags; VMCIHandle handle; /* * When a guest enters hibernation, there may be queue pairs * around, that couldn't be converted to local queue * pairs. When coming out of hibernation, these queue pairs * will be restored as part of the guest main mem by the OS * hibernation code and they can now be regarded as local * versions. Since they are no longer connected, detach * notifications are sent to the local endpoint. */ VMCI_GrabLock_BH(&hibernateFailedListLock, &flags); while (VMCIHandleArray_GetSize(hibernateFailedList) > 0) { handle = VMCIHandleArray_RemoveTail(hibernateFailedList); if (deviceReset) { QueuePairNotifyPeerLocal(FALSE, handle); } } VMCI_ReleaseLock_BH(&hibernateFailedListLock, flags); Atomic_Write(&qpGuestEndpoints.hibernate, 0); } } #endif /* !VMKERNEL */ vmci-only/common/vmciResource.h 0000444 0000000 0000000 00000005147 13432725347 015617 0 ustar root root /********************************************************* * Copyright (C) 2006-2013 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 * *********************************************************/ /* * vmciResource.h -- * * VMCI Resource Access Control API. */ #ifndef _VMCI_RESOURCE_H_ #define _VMCI_RESOURCE_H_ #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMCORE #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMKERNEL #include "includeCheck.h" #include "vmci_defs.h" #include "vmci_kernel_if.h" #include "vmciHashtable.h" #include "vmciContext.h" #define RESOURCE_CONTAINER(ptr, type, member) \ ((type *)((char *)(ptr) - offsetof(type, member))) typedef void(*VMCIResourceFreeCB)(void *resource); typedef enum { VMCI_RESOURCE_TYPE_ANY, VMCI_RESOURCE_TYPE_API, VMCI_RESOURCE_TYPE_GROUP, VMCI_RESOURCE_TYPE_DATAGRAM, VMCI_RESOURCE_TYPE_DOORBELL, } VMCIResourceType; typedef struct VMCIResource { VMCIHashEntry hashEntry; VMCIResourceType type; VMCIResourceFreeCB containerFreeCB; // Callback to free container // object when refCount is 0. void *containerObject; // Container object reference. } VMCIResource; int VMCIResource_Init(void); void VMCIResource_Exit(void); void VMCIResource_Sync(void); VMCIId VMCIResource_GetID(VMCIId contextID); int VMCIResource_Add(VMCIResource *resource, VMCIResourceType resourceType, VMCIHandle resourceHandle, VMCIResourceFreeCB containerFreeCB, void *containerObject); void VMCIResource_Remove(VMCIHandle resourceHandle, VMCIResourceType resourceType); VMCIResource *VMCIResource_Get(VMCIHandle resourceHandle, VMCIResourceType resourceType); void VMCIResource_Hold(VMCIResource *resource); int VMCIResource_Release(VMCIResource *resource); VMCIHandle VMCIResource_Handle(VMCIResource *resource); #endif // _VMCI_RESOURCE_H_ vmci-only/common/vmciDatagram.h 0000444 0000000 0000000 00000003354 13432725347 015546 0 ustar root root /********************************************************* * Copyright (C) 2006 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 * *********************************************************/ /* * vmciDatagram.h -- * * Internal functions in the VMCI Simple Datagram API. */ #ifndef _VMCI_DATAGRAM_H_ #define _VMCI_DATAGRAM_H_ #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMCORE #define INCLUDE_ALLOW_VMKERNEL #include "includeCheck.h" #include "vmciContext.h" #include "vmci_call_defs.h" #ifndef VMX86_SERVER #include "vmci_iocontrols.h" #endif // !VMX86_SERVER #define VMCI_MAX_DELAYED_DG_HOST_QUEUE_SIZE 256 /* Init functions. */ int VMCIDatagram_Init(void); void VMCIDatagram_Exit(void); /* Datagram API for non-public use. */ int VMCIDatagram_Dispatch(VMCIId contextID, VMCIDatagram *dg, Bool fromGuest); int VMCIDatagram_InvokeGuestHandler(VMCIDatagram *dg); int VMCIDatagram_GetPrivFlags(VMCIHandle handle, VMCIPrivilegeFlags *privFlags); /* Misc. */ void VMCIDatagram_Sync(void); Bool VMCIDatagram_CheckHostCapabilities(void); #endif // _VMCI_DATAGRAM_H_ vmci-only/common/vmciDoorbell.c 0000444 0000000 0000000 00000102325 13432725347 015561 0 ustar root root /********************************************************* * Copyright (C) 2010 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 * *********************************************************/ /* * vmciDoorbell.c -- * * This file implements the VMCI doorbell API on the host. */ #include "vmci_kernel_if.h" #include "vm_assert.h" #include "vmci_defs.h" #include "vmci_infrastructure.h" #include "vmciCommonInt.h" #include "vmciDatagram.h" #include "vmciDoorbell.h" #include "vmciDriver.h" #include "vmciKernelAPI.h" #include "vmciResource.h" #include "vmciRoute.h" #if defined(VMKERNEL) # include "vmciVmkInt.h" # include "vm_libc.h" # include "helper_ext.h" #endif #define LGPFX "VMCIDoorbell: " #if !defined(__APPLE__) #define VMCI_DOORBELL_INDEX_TABLE_SIZE 64 #define VMCI_DOORBELL_HASH(_idx) \ VMCI_HashId((_idx), VMCI_DOORBELL_INDEX_TABLE_SIZE) /* * DoorbellEntry describes the a doorbell notification handle allocated by the * host. */ typedef struct VMCIDoorbellEntry { VMCIResource resource; uint32 idx; VMCIListItem idxListItem; VMCIPrivilegeFlags privFlags; Bool isDoorbell; Bool runDelayed; VMCICallback notifyCB; void *clientData; VMCIEvent destroyEvent; Atomic_uint32 active; // Only used by guest personality } VMCIDoorbellEntry; typedef struct VMCIDoorbellIndexTable { VMCILock lock; VMCIList entries[VMCI_DOORBELL_INDEX_TABLE_SIZE]; } VMCIDoorbellIndexTable; /* The VMCI index table keeps track of currently registered doorbells. */ static VMCIDoorbellIndexTable vmciDoorbellIT; /* * The maxNotifyIdx is one larger than the currently known bitmap index in * use, and is used to determine how much of the bitmap needs to be scanned. */ static uint32 maxNotifyIdx; /* * The notifyIdxCount is used for determining whether there are free entries * within the bitmap (if notifyIdxCount + 1 < maxNotifyIdx). */ static uint32 notifyIdxCount; /* * The lastNotifyIdxReserved is used to track the last index handed out - in * the case where multiple handles share a notification index, we hand out * indexes round robin based on lastNotifyIdxReserved. */ static uint32 lastNotifyIdxReserved; /* This is a one entry cache used to by the index allocation. */ static uint32 lastNotifyIdxReleased = PAGE_SIZE; static void VMCIDoorbellFreeCB(void *clientData); static int VMCIDoorbellReleaseCB(void *clientData); static void VMCIDoorbellDelayedDispatchCB(void *data); /* *------------------------------------------------------------------------------ * * VMCIDoorbell_Init -- * * General init code. * * Result: * VMCI_SUCCESS on success, lock allocation error otherwise. * * Side effects: * None. * *------------------------------------------------------------------------------ */ int VMCIDoorbell_Init(void) { uint32 bucket; for (bucket = 0; bucket < ARRAYSIZE(vmciDoorbellIT.entries); ++bucket) { VMCIList_Init(&vmciDoorbellIT.entries[bucket]); } return VMCI_InitLock(&vmciDoorbellIT.lock, "VMCIDoorbellIndexTableLock", VMCI_LOCK_RANK_DOORBELL); } /* *------------------------------------------------------------------------------ * * VMCIDoorbell_Exit -- * * General init code. * * Result: * None. * * Side effects: * None. * *------------------------------------------------------------------------------ */ void VMCIDoorbell_Exit(void) { VMCI_CleanupLock(&vmciDoorbellIT.lock); } /* *------------------------------------------------------------------------------ * * VMCIDoorbellFreeCB -- * * Callback to free doorbell entry structure when resource is no longer used, * ie. the reference count reached 0. The entry is freed in * VMCIDoorbell_Destroy(), which is waiting on the signal that gets fired * here. * * Result: * None. * * Side effects: * Signals VMCI event. * *------------------------------------------------------------------------------ */ static void VMCIDoorbellFreeCB(void *clientData) // IN { VMCIDoorbellEntry *entry = (VMCIDoorbellEntry *)clientData; ASSERT(entry); VMCI_SignalEvent(&entry->destroyEvent); } /* *------------------------------------------------------------------------------ * * VMCIDoorbellReleaseCB -- * * Callback to release the resource reference. It is called by the * VMCI_WaitOnEvent function before it blocks. * * Result: * Always 0. * * Side effects: * None. * *------------------------------------------------------------------------------ */ static int VMCIDoorbellReleaseCB(void *clientData) // IN: doorbell entry { VMCIDoorbellEntry *entry = (VMCIDoorbellEntry *)clientData; ASSERT(entry); VMCIResource_Release(&entry->resource); return 0; } /* *------------------------------------------------------------------------------ * * VMCIDoorbellGetPrivFlags -- * * Utility function that retrieves the privilege flags associated * with a given doorbell handle. For guest endpoints, the * privileges are determined by the context ID, but for host * endpoints privileges are associated with the complete * handle. Hypervisor endpoints are not yet supported. * * Result: * VMCI_SUCCESS on success, * VMCI_ERROR_NOT_FOUND if handle isn't found, * VMCI_ERROR_INVALID_ARGS if handle is invalid. * * Side effects: * None. * *------------------------------------------------------------------------------ */ int VMCIDoorbellGetPrivFlags(VMCIHandle handle, // IN VMCIPrivilegeFlags *privFlags) // OUT { if (privFlags == NULL || handle.context == VMCI_INVALID_ID) { return VMCI_ERROR_INVALID_ARGS; } if (handle.context == VMCI_HOST_CONTEXT_ID) { VMCIDoorbellEntry *entry; VMCIResource *resource; resource = VMCIResource_Get(handle, VMCI_RESOURCE_TYPE_DOORBELL); if (resource == NULL) { return VMCI_ERROR_NOT_FOUND; } entry = RESOURCE_CONTAINER(resource, VMCIDoorbellEntry, resource); *privFlags = entry->privFlags; VMCIResource_Release(resource); } else if (handle.context == VMCI_HYPERVISOR_CONTEXT_ID) { /* Hypervisor endpoints for notifications are not supported (yet). */ return VMCI_ERROR_INVALID_ARGS; } else { *privFlags = vmci_context_get_priv_flags(handle.context); } return VMCI_SUCCESS; } /* *----------------------------------------------------------------------------- * * VMCIDoorbellIndexTableFind -- * * Find doorbell entry by bitmap index. * * Results: * Entry if found, NULL if not. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static VMCIDoorbellEntry * VMCIDoorbellIndexTableFind(uint32 idx) // IN { uint32 bucket = VMCI_DOORBELL_HASH(idx); VMCIListItem *iter; ASSERT(VMCI_GuestPersonalityActive()); VMCIList_Scan(iter, &vmciDoorbellIT.entries[bucket]) { VMCIDoorbellEntry *cur = VMCIList_Entry(iter, VMCIDoorbellEntry, idxListItem); ASSERT(cur); if (idx == cur->idx) { return cur; } } return NULL; } /* *------------------------------------------------------------------------------ * * VMCIDoorbellIndexTableAdd -- * * Add the given entry to the index table. This will hold() the entry's * resource so that the entry is not deleted before it is removed from the * table. * * Results: * None. * * Side effects: * None. * *------------------------------------------------------------------------------ */ static void VMCIDoorbellIndexTableAdd(VMCIDoorbellEntry *entry) // IN/OUT { uint32 bucket; uint32 newNotifyIdx; VMCILockFlags flags; ASSERT(entry); ASSERT(VMCI_GuestPersonalityActive()); VMCIResource_Hold(&entry->resource); VMCI_GrabLock_BH(&vmciDoorbellIT.lock, &flags); /* * Below we try to allocate an index in the notification bitmap with "not * too much" sharing between resources. If we use less that the full bitmap, * we either add to the end if there are no unused flags within the * currently used area, or we search for unused ones. If we use the full * bitmap, we allocate the index round robin. */ if (maxNotifyIdx < PAGE_SIZE || notifyIdxCount < PAGE_SIZE) { if (lastNotifyIdxReleased < maxNotifyIdx && !VMCIDoorbellIndexTableFind(lastNotifyIdxReleased)) { newNotifyIdx = lastNotifyIdxReleased; lastNotifyIdxReleased = PAGE_SIZE; } else { Bool reused = FALSE; newNotifyIdx = lastNotifyIdxReserved; if (notifyIdxCount + 1 < maxNotifyIdx) { do { if (!VMCIDoorbellIndexTableFind(newNotifyIdx)) { reused = TRUE; break; } newNotifyIdx = (newNotifyIdx + 1) % maxNotifyIdx; } while(newNotifyIdx != lastNotifyIdxReleased); } if (!reused) { newNotifyIdx = maxNotifyIdx; maxNotifyIdx++; } } } else { newNotifyIdx = (lastNotifyIdxReserved + 1) % PAGE_SIZE; } lastNotifyIdxReserved = newNotifyIdx; notifyIdxCount++; entry->idx = newNotifyIdx; bucket = VMCI_DOORBELL_HASH(entry->idx); VMCIList_Insert(&entry->idxListItem, &vmciDoorbellIT.entries[bucket]); VMCI_ReleaseLock_BH(&vmciDoorbellIT.lock, flags); } /* *------------------------------------------------------------------------------ * * VMCIDoorbellIndexTableRemove -- * * Remove the given entry from the index table. This will release() the * entry's resource. * * Results: * None. * * Side effects: * None. * *------------------------------------------------------------------------------ */ static void VMCIDoorbellIndexTableRemove(VMCIDoorbellEntry *entry) // IN/OUT { VMCILockFlags flags; ASSERT(entry); ASSERT(VMCI_GuestPersonalityActive()); VMCI_GrabLock_BH(&vmciDoorbellIT.lock, &flags); VMCIList_Remove(&entry->idxListItem); notifyIdxCount--; if (entry->idx == maxNotifyIdx - 1) { /* * If we delete an entry with the maximum known notification index, we * take the opportunity to prune the current max. As there might be other * unused indices immediately below, we lower the maximum until we hit an * index in use. */ while (maxNotifyIdx > 0 && !VMCIDoorbellIndexTableFind(maxNotifyIdx - 1)) { maxNotifyIdx--; } } lastNotifyIdxReleased = entry->idx; VMCI_ReleaseLock_BH(&vmciDoorbellIT.lock, flags); VMCIResource_Release(&entry->resource); } /* *------------------------------------------------------------------------------ * * VMCIDoorbellLink -- * * Creates a link between the given doorbell handle and the given * index in the bitmap in the device backend. * * Results: * VMCI_SUCCESS if success, appropriate error code otherwise. * * Side effects: * Notification state is created in hypervisor. * *------------------------------------------------------------------------------ */ static int VMCIDoorbellLink(VMCIHandle handle, // IN Bool isDoorbell, // IN uint32 notifyIdx) // IN { #if defined(VMKERNEL) VMCI_WARNING((LGPFX"Cannot send down to host from VMKERNEL.\n")); return VMCI_ERROR_DST_UNREACHABLE; #else // VMKERNEL VMCIId resourceID; VMCIDoorbellLinkMsg linkMsg; ASSERT(!VMCI_HANDLE_INVALID(handle)); ASSERT(VMCI_GuestPersonalityActive()); if (isDoorbell) { resourceID = VMCI_DOORBELL_LINK; } else { ASSERT(FALSE); return VMCI_ERROR_UNAVAILABLE; } linkMsg.hdr.dst = VMCI_MAKE_HANDLE(VMCI_HYPERVISOR_CONTEXT_ID, resourceID); linkMsg.hdr.src = VMCI_ANON_SRC_HANDLE; linkMsg.hdr.payloadSize = sizeof linkMsg - VMCI_DG_HEADERSIZE; linkMsg.handle = handle; linkMsg.notifyIdx = notifyIdx; return VMCI_SendDatagram((VMCIDatagram *)&linkMsg); #endif // VMKERNEL } /* *------------------------------------------------------------------------------ * * VMCIDoorbellUnlink -- * * Unlinks the given doorbell handle from an index in the bitmap in * the device backend. * * Results: * VMCI_SUCCESS if success, appropriate error code otherwise. * * Side effects: * Notification state is destroyed in hypervisor. * *------------------------------------------------------------------------------ */ static int VMCIDoorbellUnlink(VMCIHandle handle, // IN Bool isDoorbell) // IN { #if defined(VMKERNEL) VMCI_WARNING((LGPFX"Cannot send down to host from VMKERNEL.\n")); return VMCI_ERROR_DST_UNREACHABLE; #else // VMKERNEL VMCIId resourceID; VMCIDoorbellUnlinkMsg unlinkMsg; ASSERT(!VMCI_HANDLE_INVALID(handle)); ASSERT(VMCI_GuestPersonalityActive()); if (isDoorbell) { resourceID = VMCI_DOORBELL_UNLINK; } else { ASSERT(FALSE); return VMCI_ERROR_UNAVAILABLE; } unlinkMsg.hdr.dst = VMCI_MAKE_HANDLE(VMCI_HYPERVISOR_CONTEXT_ID, resourceID); unlinkMsg.hdr.src = VMCI_ANON_SRC_HANDLE; unlinkMsg.hdr.payloadSize = sizeof unlinkMsg - VMCI_DG_HEADERSIZE; unlinkMsg.handle = handle; return VMCI_SendDatagram((VMCIDatagram *)&unlinkMsg); #endif // VMKERNEL } /* *------------------------------------------------------------------------------ * * vmci_doorbell_create -- * * Creates a doorbell with the given callback. If the handle is * VMCI_INVALID_HANDLE, a free handle will be assigned, if * possible. The callback can be run immediately (potentially with * locks held - the default) or delayed (in a kernel thread) by * specifying the flag VMCI_FLAG_DELAYED_CB. If delayed execution * is selected, a given callback may not be run if the kernel is * unable to allocate memory for the delayed execution (highly * unlikely). * * Results: * VMCI_SUCCESS on success, appropriate error code otherwise. * * Side effects: * None. * *------------------------------------------------------------------------------ */ VMCI_EXPORT_SYMBOL(vmci_doorbell_create) int vmci_doorbell_create(VMCIHandle *handle, // IN/OUT uint32 flags, // IN VMCIPrivilegeFlags privFlags, // IN VMCICallback notifyCB, // IN void *clientData) // IN { VMCIDoorbellEntry *entry; VMCIHandle newHandle; int result; if (!handle || !notifyCB || flags & ~VMCI_FLAG_DELAYED_CB || privFlags & ~VMCI_PRIVILEGE_ALL_FLAGS) { return VMCI_ERROR_INVALID_ARGS; } entry = VMCI_AllocKernelMem(sizeof *entry, VMCI_MEMORY_NONPAGED); if (entry == NULL) { VMCI_WARNING((LGPFX"Failed allocating memory for datagram entry.\n")); return VMCI_ERROR_NO_MEM; } if (!VMCI_CanScheduleDelayedWork() && (flags & VMCI_FLAG_DELAYED_CB)) { result = VMCI_ERROR_INVALID_ARGS; goto freeMem; } if (VMCI_HANDLE_INVALID(*handle)) { VMCIId contextID = vmci_get_context_id(); VMCIId resourceID = VMCIResource_GetID(contextID); if (resourceID == VMCI_INVALID_ID) { result = VMCI_ERROR_NO_HANDLE; goto freeMem; } newHandle = VMCI_MAKE_HANDLE(contextID, resourceID); } else { Bool validContext; /* * Validate the handle. We must do both of the checks below * because we can be acting as both a host and a guest at the * same time. We always allow the host context ID, since the * host functionality is in practice always there with the * unified driver. */ validContext = FALSE; if (VMCI_HOST_CONTEXT_ID == handle->context) { validContext = TRUE; } if (VMCI_GuestPersonalityActive() && vmci_get_context_id() == handle->context) { validContext = TRUE; } if (!validContext || VMCI_INVALID_ID == handle->resource) { VMCI_DEBUG_LOG(4, (LGPFX"Invalid argument (handle=0x%x:0x%x).\n", handle->context, handle->resource)); result = VMCI_ERROR_INVALID_ARGS; goto freeMem; } newHandle = *handle; } entry->idx = 0; VMCIList_Init(&entry->idxListItem); entry->privFlags = privFlags; entry->isDoorbell = TRUE; entry->runDelayed = (flags & VMCI_FLAG_DELAYED_CB) ? TRUE : FALSE; entry->notifyCB = notifyCB; entry->clientData = clientData; Atomic_Write(&entry->active, 0); VMCI_CreateEvent(&entry->destroyEvent); result = VMCIResource_Add(&entry->resource, VMCI_RESOURCE_TYPE_DOORBELL, newHandle, VMCIDoorbellFreeCB, entry); if (result != VMCI_SUCCESS) { VMCI_WARNING((LGPFX"Failed to add new resource (handle=0x%x:0x%x).\n", newHandle.context, newHandle.resource)); if (result == VMCI_ERROR_DUPLICATE_ENTRY) { result = VMCI_ERROR_ALREADY_EXISTS; } goto destroy; } if (VMCI_GuestPersonalityActive()) { VMCIDoorbellIndexTableAdd(entry); result = VMCIDoorbellLink(newHandle, entry->isDoorbell, entry->idx); if (VMCI_SUCCESS != result) { goto destroyResource; } Atomic_Write(&entry->active, 1); } if (VMCI_HANDLE_INVALID(*handle)) { *handle = newHandle; } return result; destroyResource: VMCIDoorbellIndexTableRemove(entry); VMCIResource_Remove(newHandle, VMCI_RESOURCE_TYPE_DOORBELL); destroy: VMCI_DestroyEvent(&entry->destroyEvent); freeMem: VMCI_FreeKernelMem(entry, sizeof *entry); return result; } /* *------------------------------------------------------------------------------ * * vmci_doorbell_destroy -- * * Destroys a doorbell previously created with * vmci_doorbell_create. This operation may block waiting for a * callback to finish. * * Results: * VMCI_SUCCESS on success, appropriate error code otherwise. * * Side effects: * May block. * *------------------------------------------------------------------------------ */ VMCI_EXPORT_SYMBOL(vmci_doorbell_destroy) int vmci_doorbell_destroy(VMCIHandle handle) // IN { VMCIDoorbellEntry *entry; VMCIResource *resource; if (VMCI_HANDLE_INVALID(handle)) { return VMCI_ERROR_INVALID_ARGS; } resource = VMCIResource_Get(handle, VMCI_RESOURCE_TYPE_DOORBELL); if (resource == NULL) { VMCI_DEBUG_LOG(4, (LGPFX"Failed to destroy doorbell (handle=0x%x:0x%x).\n", handle.context, handle.resource)); return VMCI_ERROR_NOT_FOUND; } entry = RESOURCE_CONTAINER(resource, VMCIDoorbellEntry, resource); if (VMCI_GuestPersonalityActive()) { int result; VMCIDoorbellIndexTableRemove(entry); result = VMCIDoorbellUnlink(handle, entry->isDoorbell); if (VMCI_SUCCESS != result) { /* * The only reason this should fail would be an inconsistency between * guest and hypervisor state, where the guest believes it has an * active registration whereas the hypervisor doesn't. One case where * this may happen is if a doorbell is unregistered following a * hibernation at a time where the doorbell state hasn't been restored * on the hypervisor side yet. Since the handle has now been removed * in the guest, we just print a warning and return success. */ VMCI_DEBUG_LOG(4, (LGPFX"Unlink of %s (handle=0x%x:0x%x) unknown by " "hypervisor (error=%d).\n", entry->isDoorbell ? "doorbell" : "queuepair", handle.context, handle.resource, result)); } } /* * Now remove the resource from the table. It might still be in use * after this, in a callback or still on the delayed work queue. */ VMCIResource_Remove(handle, VMCI_RESOURCE_TYPE_DOORBELL); /* * We now wait on the destroyEvent and release the reference we got * above. */ VMCI_WaitOnEvent(&entry->destroyEvent, VMCIDoorbellReleaseCB, entry); /* * We know that we are now the only reference to the above entry so * can safely free it. */ VMCI_DestroyEvent(&entry->destroyEvent); VMCI_FreeKernelMem(entry, sizeof *entry); return VMCI_SUCCESS; } /* *------------------------------------------------------------------------------ * * VMCIDoorbellNotifyAsGuest -- * * Notify another guest or the host. We send a datagram down to the * host via the hypervisor with the notification info. * * Results: * VMCI_SUCCESS on success, appropriate error code otherwise. * * Side effects: * May do a hypercall. * *------------------------------------------------------------------------------ */ static int VMCIDoorbellNotifyAsGuest(VMCIHandle handle, // IN VMCIPrivilegeFlags privFlags) // IN { #if defined(VMKERNEL) VMCI_WARNING((LGPFX"Cannot send down to host from VMKERNEL.\n")); return VMCI_ERROR_DST_UNREACHABLE; #else // VMKERNEL VMCIDoorbellNotifyMsg notifyMsg; UNREFERENCED_PARAMETER(privFlags); ASSERT(VMCI_GuestPersonalityActive()); notifyMsg.hdr.dst = VMCI_MAKE_HANDLE(VMCI_HYPERVISOR_CONTEXT_ID, VMCI_DOORBELL_NOTIFY); notifyMsg.hdr.src = VMCI_ANON_SRC_HANDLE; notifyMsg.hdr.payloadSize = sizeof notifyMsg - VMCI_DG_HEADERSIZE; notifyMsg.handle = handle; return VMCI_SendDatagram((VMCIDatagram *)¬ifyMsg); #endif // VMKERNEL } /* *------------------------------------------------------------------------------ * * vmci_doorbell_notify -- * * Generates a notification on the doorbell identified by the * handle. For host side generation of notifications, the caller * can specify what the privilege of the calling side is. * * Results: * VMCI_SUCCESS on success, appropriate error code otherwise. * * Side effects: * May do a hypercall. * *------------------------------------------------------------------------------ */ VMCI_EXPORT_SYMBOL(vmci_doorbell_notify) int vmci_doorbell_notify(VMCIHandle dst, // IN VMCIPrivilegeFlags privFlags) // IN { int retval; VMCIRoute route; VMCIHandle src; if (VMCI_HANDLE_INVALID(dst) || (privFlags & ~VMCI_PRIVILEGE_ALL_FLAGS)) { return VMCI_ERROR_INVALID_ARGS; } src = VMCI_INVALID_HANDLE; retval = VMCI_Route(&src, &dst, FALSE, &route); if (retval < VMCI_SUCCESS) { return retval; } if (VMCI_ROUTE_AS_HOST == route) { return VMCIContext_NotifyDoorbell(VMCI_HOST_CONTEXT_ID, dst, privFlags); } if (VMCI_ROUTE_AS_GUEST == route) { return VMCIDoorbellNotifyAsGuest(dst, privFlags); } VMCI_WARNING((LGPFX"Unknown route (%d) for doorbell.\n", route)); return VMCI_ERROR_DST_UNREACHABLE; } /* *------------------------------------------------------------------------------ * * VMCIDoorbellDelayedDispatchCB -- * * Calls the specified callback in a delayed context. * * Results: * None. * * Side effects: * None. * *------------------------------------------------------------------------------ */ static void VMCIDoorbellDelayedDispatchCB(void *data) // IN { VMCIDoorbellEntry *entry = (VMCIDoorbellEntry *)data; ASSERT(data); entry->notifyCB(entry->clientData); VMCIResource_Release(&entry->resource); } /* *------------------------------------------------------------------------------ * * VMCIDoorbellHostContextNotify -- * * Dispatches a doorbell notification to the host context. * * Results: * VMCI_SUCCESS on success. Appropriate error code otherwise. * * Side effects: * None. * *------------------------------------------------------------------------------ */ int VMCIDoorbellHostContextNotify(VMCIId srcCID, // IN VMCIHandle handle) // IN { VMCIDoorbellEntry *entry; VMCIResource *resource; int result; UNREFERENCED_PARAMETER(srcCID); ASSERT(VMCI_HostPersonalityActive()); if (VMCI_HANDLE_INVALID(handle)) { VMCI_DEBUG_LOG(4, (LGPFX"Notifying an invalid doorbell (handle=0x%x:0x%x).\n", handle.context, handle.resource)); return VMCI_ERROR_INVALID_ARGS; } resource = VMCIResource_Get(handle, VMCI_RESOURCE_TYPE_DOORBELL); if (resource == NULL) { VMCI_DEBUG_LOG(4, (LGPFX"Notifying an unknown doorbell (handle=0x%x:0x%x).\n", handle.context, handle.resource)); return VMCI_ERROR_NOT_FOUND; } entry = RESOURCE_CONTAINER(resource, VMCIDoorbellEntry, resource); if (entry->runDelayed) { result = VMCI_ScheduleDelayedWork(VMCIDoorbellDelayedDispatchCB, entry); if (result < VMCI_SUCCESS) { /* * If we failed to schedule the delayed work, we need to * release the resource immediately. Otherwise, the resource * will be released once the delayed callback has been * completed. */ VMCI_DEBUG_LOG(10, (LGPFX"Failed to schedule delayed doorbell " "notification (result=%d).\n", result)); VMCIResource_Release(resource); } } else { entry->notifyCB(entry->clientData); VMCIResource_Release(resource); result = VMCI_SUCCESS; } return result; } /* *------------------------------------------------------------------------------ * * VMCIDoorbell_Hibernate -- * * When a guest leaves hibernation, the device driver state is out of sync * with the device state, since the driver state has doorbells registered * that aren't known to the device. This function takes care of * reregistering any doorbells. In case an error occurs during * reregistration (this is highly unlikely since 1) it succeeded the first * time 2) the device driver is the only source of doorbell registrations), * we simply log the error. The doorbell can still be destroyed using * VMCIDoorbell_Destroy. * * Results: * None. * * Side effects: * None. * *------------------------------------------------------------------------------ */ void VMCIDoorbell_Hibernate(Bool enterHibernate) { uint32 bucket; VMCIListItem *iter; VMCILockFlags flags; if (!VMCI_GuestPersonalityActive() || enterHibernate) { return; } VMCI_GrabLock_BH(&vmciDoorbellIT.lock, &flags); for (bucket = 0; bucket < ARRAYSIZE(vmciDoorbellIT.entries); bucket++) { VMCIList_Scan(iter, &vmciDoorbellIT.entries[bucket]) { int result; VMCIHandle h; VMCIDoorbellEntry *cur; cur = VMCIList_Entry(iter, VMCIDoorbellEntry, idxListItem); h = VMCIResource_Handle(&cur->resource); result = VMCIDoorbellLink(h, cur->isDoorbell, cur->idx); if (result != VMCI_SUCCESS && result != VMCI_ERROR_DUPLICATE_ENTRY) { VMCI_WARNING((LGPFX"Failed to reregister doorbell " "(handle=0x%x:0x%x) of resource %s to index " "(error=%d).\n", h.context, h.resource, cur->isDoorbell ? "doorbell" : "queue pair", result)); } } } VMCI_ReleaseLock_BH(&vmciDoorbellIT.lock, flags); } /* *------------------------------------------------------------------------------ * * VMCIDoorbell_Sync -- * * Use this as a synchronization point when setting globals, for example, * during device shutdown. * * Results: * None. * * Side effects: * None. * *------------------------------------------------------------------------------ */ void VMCIDoorbell_Sync(void) { VMCILockFlags flags; VMCI_GrabLock_BH(&vmciDoorbellIT.lock, &flags); VMCI_ReleaseLock_BH(&vmciDoorbellIT.lock, flags); VMCIResource_Sync(); } /* *------------------------------------------------------------------------------ * * VMCI_RegisterNotificationBitmap -- * * Register the notification bitmap with the host. * * Results: * TRUE if the bitmap is registered successfully with the device, FALSE * otherwise. * * Side effects: * None. * *------------------------------------------------------------------------------ */ Bool VMCI_RegisterNotificationBitmap(PPN bitmapPPN) { int result; VMCINotifyBitmapSetMsg bitmapSetMsg; /* * Do not ASSERT() on the guest device here. This function can get called * during device initialization, so the ASSERT() will fail even though * the device is (almost) up. */ bitmapSetMsg.hdr.dst = VMCI_MAKE_HANDLE(VMCI_HYPERVISOR_CONTEXT_ID, VMCI_SET_NOTIFY_BITMAP); bitmapSetMsg.hdr.src = VMCI_ANON_SRC_HANDLE; bitmapSetMsg.hdr.payloadSize = sizeof bitmapSetMsg - VMCI_DG_HEADERSIZE; bitmapSetMsg.bitmapPPN = bitmapPPN; result = VMCI_SendDatagram((VMCIDatagram *)&bitmapSetMsg); if (result != VMCI_SUCCESS) { VMCI_DEBUG_LOG(4, (LGPFX"Failed to register (PPN=%u) as " "notification bitmap (error=%d).\n", bitmapPPN, result)); return FALSE; } return TRUE; } /* *------------------------------------------------------------------------- * * VMCIDoorbellFireEntries -- * * Executes or schedules the handlers for a given notify index. * * Result: * Notification hash entry if found. NULL otherwise. * * Side effects: * Whatever the side effects of the handlers are. * *------------------------------------------------------------------------- */ static void VMCIDoorbellFireEntries(uint32 notifyIdx) // IN { uint32 bucket = VMCI_DOORBELL_HASH(notifyIdx); VMCIListItem *iter; VMCILockFlags flags; ASSERT(VMCI_GuestPersonalityActive()); VMCI_GrabLock_BH(&vmciDoorbellIT.lock, &flags); VMCIList_Scan(iter, &vmciDoorbellIT.entries[bucket]) { VMCIDoorbellEntry *cur = VMCIList_Entry(iter, VMCIDoorbellEntry, idxListItem); ASSERT(cur); if (cur->idx == notifyIdx && Atomic_Read(&cur->active) == 1) { ASSERT(cur->notifyCB); if (cur->runDelayed) { int err; VMCIResource_Hold(&cur->resource); err = VMCI_ScheduleDelayedWork(VMCIDoorbellDelayedDispatchCB, cur); if (err != VMCI_SUCCESS) { VMCIResource_Release(&cur->resource); goto out; } } else { cur->notifyCB(cur->clientData); } } } out: VMCI_ReleaseLock_BH(&vmciDoorbellIT.lock, flags); } /* *------------------------------------------------------------------------------ * * VMCI_ScanNotificationBitmap -- * * Scans the notification bitmap, collects pending notifications, * resets the bitmap and invokes appropriate callbacks. * * Results: * None. * * Side effects: * May schedule tasks, allocate memory and run callbacks. * *------------------------------------------------------------------------------ */ void VMCI_ScanNotificationBitmap(uint8 *bitmap) { uint32 idx; ASSERT(bitmap); ASSERT(VMCI_GuestPersonalityActive()); for (idx = 0; idx < maxNotifyIdx; idx++) { if (bitmap[idx] & 0x1) { bitmap[idx] &= ~1; VMCIDoorbellFireEntries(idx); } } } #else // __APPLE__ /* *----------------------------------------------------------------------------- * * VMCIDoorbell_Create/VMCIDoorbell_Destroy/VMCIDoorbell_Notify/ * VMCIDoorbellHostContextNotify/VMCIDoorbellGetPrivFlags/ * VMCIDoorbell_Init/VMCIDoorbell_Exit -- * * The doorbell functions have yet to be implemented for Solaris * and Mac OS X guest drivers. * * Results: * VMCI_ERROR_UNAVAILABLE. * * Side effects: * None. * *----------------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(VMCIDoorbell_Create) int VMCIDoorbell_Create(VMCIHandle *handle, // IN uint32 flags, // IN VMCIPrivilegeFlags privFlags, // IN VMCICallback notifyCB, // IN void *clientData) // IN { return VMCI_ERROR_UNAVAILABLE; } VMCI_EXPORT_SYMBOL(VMCIDoorbell_Destroy) int VMCIDoorbell_Destroy(VMCIHandle handle) // IN { return VMCI_ERROR_UNAVAILABLE; } VMCI_EXPORT_SYMBOL(VMCIDoorbell_Notify) int VMCIDoorbell_Notify(VMCIHandle handle, // IN VMCIPrivilegeFlags privFlags) // IN { return VMCI_ERROR_UNAVAILABLE; } int VMCIDoorbellHostContextNotify(VMCIId srcCID, // IN VMCIHandle handle) // IN { return VMCI_ERROR_UNAVAILABLE; } int VMCIDoorbellGetPrivFlags(VMCIHandle handle, // IN VMCIPrivilegeFlags *privFlags) // OUT { return VMCI_ERROR_UNAVAILABLE; } int VMCIDoorbell_Init(void) { return VMCI_SUCCESS; } void VMCIDoorbell_Exit(void) { } #endif // __APPLE__ vmci-only/common/vmciContext.h 0000555 0000000 0000000 00000012705 13432725347 015455 0 ustar root root /********************************************************* * Copyright (C) 2006-2013,2015,2017 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 * *********************************************************/ /* * vmciContext.h -- * * VMCI state to enable sending calls between VMs. */ #ifndef _VMCI_CONTEXT_H_ #define _VMCI_CONTEXT_H_ #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMCORE #define INCLUDE_ALLOW_VMKERNEL #include "includeCheck.h" #include "vmci_defs.h" #include "vmci_call_defs.h" #include "vmci_handle_array.h" #include "vmci_infrastructure.h" #include "vmci_kernel_if.h" #include "vmciCommonInt.h" #define MAX_QUEUED_GUESTCALLS_PER_VM 100 typedef struct VMCIContext VMCIContext; int VMCIContext_Init(void); void VMCIContext_Exit(void); int VMCIContext_InitContext(VMCIId cid, VMCIPrivilegeFlags flags, uintptr_t eventHnd, int version, VMCIHostUser *user, VMCIContext **context); #ifdef VMKERNEL void VMCIContext_SetQuiesceState(VMCIContext *context, Bool isQuiesced, VMCIId migrateCid, uintptr_t eventHnd, uint8 cause, Bool isLocked); VMCIContext *VMCIContext_FindAndUpdateSrcFSR(VMCIId migrateCid, uintptr_t eventHnd, uintptr_t *srcEventHnd); Bool VMCIContext_IsActiveHnd(VMCIContext *context, uintptr_t eventHnd); uintptr_t VMCIContext_GetActiveHnd(VMCIContext *context); void VMCIContext_SetInactiveHnd(VMCIContext *context, uintptr_t eventHnd); Bool VMCIContext_RemoveHnd(VMCIContext *context, uintptr_t eventHnd, uint32 *numOld, uint32 *numNew); void VMCIContext_ClearDatagrams(VMCIContext *context); void VMCIContext_SetId(VMCIContext *context, VMCIId cid); void VMCIContext_NotifyGuestPaused(VMCIId cid, Bool paused); void VMCIContext_NotifyMemoryAccess(VMCIId cid, Bool on); Bool VMCIContext_RevalidateMappings(VMCIContext *context); #endif Bool VMCIContext_SupportsHostQP(VMCIContext *context); void VMCIContext_ReleaseContext(VMCIContext *context); int VMCIContext_EnqueueDatagram(VMCIId cid, VMCIDatagram *dg, Bool notify); int VMCIContext_DequeueDatagram(VMCIContext *context, size_t *maxSize, VMCIDatagram **dg); int VMCIContext_PendingDatagrams(VMCIId cid, uint32 *pending); VMCIContext *VMCIContext_Get(VMCIId cid); void VMCIContext_Release(VMCIContext *context); Bool VMCIContext_Exists(VMCIId cid); VMCIId VMCIContext_GetId(VMCIContext *context); int VMCIContext_AddNotification(VMCIId contextID, VMCIId remoteCID); int VMCIContext_RemoveNotification(VMCIId contextID, VMCIId remoteCID); int VMCIContext_GetCheckpointState(VMCIId contextID, uint32 cptType, uint32 *numCIDs, char **cptBufPtr); int VMCIContext_SetCheckpointState(VMCIId contextID, uint32 cptType, uint32 numCIDs, char *cptBuf); void VMCIContext_RegisterGuestMem(VMCIContext *context, VMCIGuestMemID gid); void VMCIContext_ReleaseGuestMem(VMCIContext *context, VMCIGuestMemID gid, Bool powerOff); int VMCIContext_QueuePairCreate(VMCIContext *context, VMCIHandle handle); int VMCIContext_QueuePairDestroy(VMCIContext *context, VMCIHandle handle); Bool VMCIContext_QueuePairExists(VMCIContext *context, VMCIHandle handle); #ifndef VMX86_SERVER void VMCIContext_CheckAndSignalNotify(VMCIContext *context); # ifdef __linux__ /* TODO Windows and Mac OS. */ void VMCIUnsetNotify(VMCIContext *context); # endif #endif int VMCIContext_DoorbellCreate(VMCIId contextID, VMCIHandle handle); int VMCIContext_DoorbellDestroy(VMCIId contextID, VMCIHandle handle); int VMCIContext_DoorbellDestroyAll(VMCIId contextID); int VMCIContext_NotifyDoorbell(VMCIId cid, VMCIHandle handle, VMCIPrivilegeFlags srcPrivFlags); int VMCIContext_ReceiveNotificationsGet(VMCIId contextID, VMCIHandleArray **dbHandleArray, VMCIHandleArray **qpHandleArray); void VMCIContext_ReceiveNotificationsRelease(VMCIId contextID, VMCIHandleArray *dbHandleArray, VMCIHandleArray *qpHandleArray, Bool success); #if defined(VMKERNEL) void VMCIContext_SignalPendingDoorbells(VMCIId contextID); void VMCIContext_SignalPendingDatagrams(VMCIId contextID); int VMCIContext_FilterSet(VMCIId cid, VMCIFilterState *filterState); int VMCI_Uuid2ContextId(const char *uuidString, VMCIId *contextID); #endif // VMKERNEL #endif // _VMCI_CONTEXT_H_ vmci-only/common/vmciHashtable.h 0000444 0000000 0000000 00000004211 13432725347 015712 0 ustar root root /********************************************************* * Copyright (C) 2006-2013 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 * *********************************************************/ /* * vmciHashtable.h -- * * Hash table for use in the APIs. */ #ifndef _VMCI_HASHTABLE_H_ #define _VMCI_HASHTABLE_H_ #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMCORE #define INCLUDE_ALLOW_VMKERNEL #include "includeCheck.h" #include "vmci_kernel_if.h" #include "vmci_defs.h" typedef struct VMCIHashEntry { VMCIHandle handle; int refCount; struct VMCIHashEntry *next; } VMCIHashEntry; typedef struct VMCIHashTable { VMCIHashEntry **entries; int size; // Number of buckets in above array. VMCILock lock; } VMCIHashTable; VMCIHashTable *VMCIHashTable_Create(int size); void VMCIHashTable_Destroy(VMCIHashTable *table); void VMCIHashTable_InitEntry(VMCIHashEntry *entry, VMCIHandle handle); int VMCIHashTable_AddEntry(VMCIHashTable *table, VMCIHashEntry *entry); int VMCIHashTable_RemoveEntry(VMCIHashTable *table, VMCIHashEntry *entry); VMCIHashEntry *VMCIHashTable_GetEntry(VMCIHashTable *table, VMCIHandle handle); void VMCIHashTable_HoldEntry(VMCIHashTable *table, VMCIHashEntry *entry); int VMCIHashTable_ReleaseEntry(VMCIHashTable *table, VMCIHashEntry *entry); Bool VMCIHashTable_EntryExists(VMCIHashTable *table, VMCIHandle handle); void VMCIHashTable_Sync(VMCIHashTable *table); #endif // _VMCI_HASHTABLE_H_ vmci-only/common/vmciQueuePair.h 0000444 0000000 0000000 00000007477 13432725347 015740 0 ustar root root /********************************************************* * Copyright (C) 2007,2016,2017 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 * *********************************************************/ /* * vmciQueuePair.h -- * * VMCI QueuePair API implementation in the host driver. */ #ifndef _VMCI_QUEUE_PAIR_H_ #define _VMCI_QUEUE_PAIR_H_ #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMCORE #define INCLUDE_ALLOW_VMKERNEL #include "includeCheck.h" #include "vmci_defs.h" #include "vmci_iocontrols.h" #include "vmci_kernel_if.h" #include "vmciContext.h" #include "vmciQueue.h" /* * QueuePairPageStore describes how the memory of a given queue pair * is backed. When the queue pair is between the host and a guest, the * page store consists of references to the guest pages. On vmkernel, * this is a list of PPNs, and on hosted, it is a user VA where the * queue pair is mapped into the VMX address space. */ typedef struct QueuePairPageStore { VMCIQPGuestMem pages; // Reference to pages backing the queue pair. uint32 len; // Length of pageList/virtual addres range (in pages). } QueuePairPageStore; /* *------------------------------------------------------------------------------ * * VMCI_QP_PAGESTORE_IS_WELLFORMED -- * * Utility function that checks whether the fields of the page * store contain valid values. * * Result: * TRUE if the page store is wellformed. FALSE otherwise. * * Side effects: * None. * *------------------------------------------------------------------------------ */ static INLINE Bool VMCI_QP_PAGESTORE_IS_WELLFORMED(QueuePairPageStore *pageStore) // IN { return pageStore->len >= 2; } int VMCIQPBroker_Init(void); void VMCIQPBroker_Exit(void); int VMCIQPBroker_Alloc(VMCIHandle handle, VMCIId peer, uint32 flags, VMCIPrivilegeFlags privFlags, uint64 produceSize, uint64 consumeSize, QueuePairPageStore *pageStore, VMCIContext *context); int VMCIQPBroker_SetPageStore(VMCIHandle handle, VA64 produceUVA, VA64 consumeUVA, VMCIContext *context); int VMCIQPBroker_Detach(VMCIHandle handle, VMCIContext *context); int VMCIQPGuestEndpoints_Init(void); void VMCIQPGuestEndpoints_Exit(void); void VMCIQPGuestEndpoints_Sync(void); void VMCIQPGuestEndpoints_Convert(Bool toLocal, Bool deviceReset); int VMCIQueuePair_Alloc(VMCIHandle *handle, VMCIQueue **produceQ, uint64 produceSize, VMCIQueue **consumeQ, uint64 consumeSize, VMCIId peer, uint32 flags, VMCIPrivilegeFlags privFlags, Bool guestEndpoint, VMCIEventReleaseCB wakeupCB, void *clientData); int VMCIQueuePair_Detach(VMCIHandle handle, Bool guestEndpoint); int VMCIQPBroker_Map(VMCIHandle handle, VMCIContext *context, VMCIQPGuestMem guestMem); int VMCIQPBroker_Unmap(VMCIHandle handle, VMCIContext *context, VMCIGuestMemID gid); #ifdef VMKERNEL int VMCIQPBroker_Revalidate(VMCIHandle handle, VMCIContext *context); int VMCIQueuePair_GetDetachCause(VMCIHandle handle, uint8 *cause); #endif #endif /* !_VMCI_QUEUE_PAIR_H_ */ vmci-only/common/vmciDatagram.c 0000444 0000000 0000000 00000065263 13432725347 015550 0 ustar root root /********************************************************* * Copyright (C) 2006-2011,2014 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 * *********************************************************/ /* * vmciDatagram.c -- * * This file implements the VMCI Simple Datagram API on the host. */ #include "vmci_kernel_if.h" #include "vm_assert.h" #include "vmci_defs.h" #include "vmci_infrastructure.h" #include "vmciCommonInt.h" #include "vmciContext.h" #include "vmciDatagram.h" #include "vmciDriver.h" #include "vmciEvent.h" #include "vmciHashtable.h" #include "vmciKernelAPI.h" #include "vmciResource.h" #include "vmciRoute.h" #if defined(VMKERNEL) # include "vmciVmkInt.h" # include "vm_libc.h" # include "helper_ext.h" #endif #define LGPFX "VMCIDatagram: " /* * DatagramEntry describes the datagram entity. It is used for datagram * entities created only on the host. */ typedef struct DatagramEntry { VMCIResource resource; uint32 flags; Bool runDelayed; VMCIDatagramRecvCB recvCB; void *clientData; VMCIEvent destroyEvent; VMCIPrivilegeFlags privFlags; } DatagramEntry; typedef struct VMCIDelayedDatagramInfo { Bool inDGHostQueue; DatagramEntry *entry; VMCIDatagram msg; } VMCIDelayedDatagramInfo; static Atomic_uint32 delayedDGHostQueueSize; static int VMCIDatagramGetPrivFlagsInt(VMCIId contextID, VMCIHandle handle, VMCIPrivilegeFlags *privFlags); static void DatagramFreeCB(void *resource); static int DatagramReleaseCB(void *clientData); /*------------------------------ Helper functions ----------------------------*/ /* *------------------------------------------------------------------------------ * * DatagramFreeCB -- * Callback to free datagram structure when resource is no longer used, * ie. the reference count reached 0. * * Result: * None. * *------------------------------------------------------------------------------ */ static void DatagramFreeCB(void *clientData) { DatagramEntry *entry = (DatagramEntry *)clientData; ASSERT(entry); VMCI_SignalEvent(&entry->destroyEvent); /* * The entry is freed in VMCIDatagram_DestroyHnd, who is waiting for the * above signal. */ } /* *------------------------------------------------------------------------------ * * DatagramReleaseCB -- * * Callback to release the resource reference. It is called by the * VMCI_WaitOnEvent function before it blocks. * * Result: * None. * *------------------------------------------------------------------------------ */ static int DatagramReleaseCB(void *clientData) { DatagramEntry *entry = (DatagramEntry *)clientData; ASSERT(entry); VMCIResource_Release(&entry->resource); return 0; } /* *------------------------------------------------------------------------------ * * DatagramCreateHnd -- * * Internal function to create a datagram entry given a handle. * * Results: * VMCI_SUCCESS if created, negative errno value otherwise. * * Side effects: * None. * *------------------------------------------------------------------------------ */ static int DatagramCreateHnd(VMCIId resourceID, // IN: uint32 flags, // IN: VMCIPrivilegeFlags privFlags, // IN: VMCIDatagramRecvCB recvCB, // IN: void *clientData, // IN: VMCIHandle *outHandle) // OUT: { int result; VMCIId contextID; VMCIHandle handle; DatagramEntry *entry; ASSERT(recvCB != NULL); ASSERT(outHandle != NULL); ASSERT(!(privFlags & ~VMCI_PRIVILEGE_ALL_FLAGS)); if ((flags & VMCI_FLAG_WELLKNOWN_DG_HND) != 0) { return VMCI_ERROR_INVALID_ARGS; } else { if ((flags & VMCI_FLAG_ANYCID_DG_HND) != 0) { contextID = VMCI_INVALID_ID; } else { contextID = vmci_get_context_id(); if (contextID == VMCI_INVALID_ID) { return VMCI_ERROR_NO_RESOURCES; } } if (resourceID == VMCI_INVALID_ID) { resourceID = VMCIResource_GetID(contextID); if (resourceID == VMCI_INVALID_ID) { return VMCI_ERROR_NO_HANDLE; } } handle = VMCI_MAKE_HANDLE(contextID, resourceID); } entry = VMCI_AllocKernelMem(sizeof *entry, VMCI_MEMORY_NONPAGED); if (entry == NULL) { VMCI_WARNING((LGPFX"Failed allocating memory for datagram entry.\n")); return VMCI_ERROR_NO_MEM; } if (!VMCI_CanScheduleDelayedWork()) { if (flags & VMCI_FLAG_DG_DELAYED_CB) { VMCI_FreeKernelMem(entry, sizeof *entry); return VMCI_ERROR_INVALID_ARGS; } entry->runDelayed = FALSE; } else { entry->runDelayed = (flags & VMCI_FLAG_DG_DELAYED_CB) ? TRUE : FALSE; } entry->flags = flags; entry->recvCB = recvCB; entry->clientData = clientData; VMCI_CreateEvent(&entry->destroyEvent); entry->privFlags = privFlags; /* Make datagram resource live. */ result = VMCIResource_Add(&entry->resource, VMCI_RESOURCE_TYPE_DATAGRAM, handle, DatagramFreeCB, entry); if (result != VMCI_SUCCESS) { VMCI_WARNING((LGPFX"Failed to add new resource (handle=0x%x:0x%x).\n", handle.context, handle.resource)); VMCI_DestroyEvent(&entry->destroyEvent); VMCI_FreeKernelMem(entry, sizeof *entry); return result; } *outHandle = handle; return VMCI_SUCCESS; } /*------------------------------ Init functions ----------------------------*/ /* *------------------------------------------------------------------------------ * * VMCIDatagram_Init -- * * Initialize Datagram API, ie. register the API functions with their * corresponding vectors. * * Result: * None. * * Side effects: * None. * *------------------------------------------------------------------------------ */ int VMCIDatagram_Init(void) { Atomic_Write(&delayedDGHostQueueSize, 0); return VMCI_SUCCESS; } /* *------------------------------------------------------------------------------ * * VMCIDatagram_Exit -- * * Cleanup Datagram API. * * Result: * None. * * Side effects: * None. * *------------------------------------------------------------------------------ */ void VMCIDatagram_Exit(void) { } /*------------------------------ Public API functions ------------------------*/ /* *------------------------------------------------------------------------------ * * vmci_datagram_create_handle -- * * Creates a host context datagram endpoint and returns a handle to it. * * Results: * VMCI_SUCCESS if created, negative errno value otherwise. * * Side effects: * None. * *------------------------------------------------------------------------------ */ VMCI_EXPORT_SYMBOL(vmci_datagram_create_handle) int vmci_datagram_create_handle( VMCIId resourceID, // IN: Optional, generated if VMCI_INVALID_ID uint32 flags, // IN: VMCIDatagramRecvCB recvCB, // IN: void *clientData, // IN: VMCIHandle *outHandle) // OUT: newly created handle { if (outHandle == NULL) { return VMCI_ERROR_INVALID_ARGS; } if (recvCB == NULL) { VMCI_DEBUG_LOG(4, (LGPFX"Client callback needed when creating datagram.\n")); return VMCI_ERROR_INVALID_ARGS; } return DatagramCreateHnd(resourceID, flags, VMCI_DEFAULT_PROC_PRIVILEGE_FLAGS, recvCB, clientData, outHandle); } /* *------------------------------------------------------------------------------ * * vmci_datagram_create_handle_priv -- * * Creates a host context datagram endpoint and returns a handle to it. * * Results: * VMCI_SUCCESS if created, negative errno value otherwise. * * Side effects: * None. * *------------------------------------------------------------------------------ */ VMCI_EXPORT_SYMBOL(vmci_datagram_create_handle_priv) int vmci_datagram_create_handle_priv( VMCIId resourceID, // IN: Optional, generated if VMCI_INVALID_ID uint32 flags, // IN: VMCIPrivilegeFlags privFlags, // IN: VMCIDatagramRecvCB recvCB, // IN: void *clientData, // IN: VMCIHandle *outHandle) // OUT: newly created handle { if (outHandle == NULL) { return VMCI_ERROR_INVALID_ARGS; } if (recvCB == NULL) { VMCI_DEBUG_LOG(4, (LGPFX"Client callback needed when creating datagram.\n")); return VMCI_ERROR_INVALID_ARGS; } if (privFlags & ~VMCI_PRIVILEGE_ALL_FLAGS) { return VMCI_ERROR_INVALID_ARGS; } return DatagramCreateHnd(resourceID, flags, privFlags, recvCB, clientData, outHandle); } /* *------------------------------------------------------------------------------ * * vmci_datagram_destroy_handle -- * * Destroys a handle. * * Results: * None. * * Side effects: * None. * *------------------------------------------------------------------------------ */ VMCI_EXPORT_SYMBOL(vmci_datagram_destroy_handle) int vmci_datagram_destroy_handle(VMCIHandle handle) // IN { DatagramEntry *entry; VMCIResource *resource = VMCIResource_Get(handle, VMCI_RESOURCE_TYPE_DATAGRAM); if (resource == NULL) { VMCI_DEBUG_LOG(4, (LGPFX"Failed to destroy datagram (handle=0x%x:0x%x).\n", handle.context, handle.resource)); return VMCI_ERROR_NOT_FOUND; } entry = RESOURCE_CONTAINER(resource, DatagramEntry, resource); VMCIResource_Remove(handle, VMCI_RESOURCE_TYPE_DATAGRAM); /* * We now wait on the destroyEvent and release the reference we got * above. */ VMCI_WaitOnEvent(&entry->destroyEvent, DatagramReleaseCB, entry); /* * We know that we are now the only reference to the above entry so * can safely free it. */ VMCI_DestroyEvent(&entry->destroyEvent); VMCI_FreeKernelMem(entry, sizeof *entry); return VMCI_SUCCESS; } /* *------------------------------------------------------------------------------ * * VMCIDatagramGetPrivFlagsInt -- * * Internal utilility function with the same purpose as * VMCIDatagram_GetPrivFlags that also takes a contextID. * * Result: * VMCI_SUCCESS on success, VMCI_ERROR_INVALID_ARGS if handle is invalid. * * Side effects: * None. * *------------------------------------------------------------------------------ */ static int VMCIDatagramGetPrivFlagsInt(VMCIId contextID, // IN VMCIHandle handle, // IN VMCIPrivilegeFlags *privFlags) // OUT { ASSERT(privFlags); ASSERT(contextID != VMCI_INVALID_ID); if (contextID == VMCI_HOST_CONTEXT_ID) { DatagramEntry *srcEntry; VMCIResource *resource; resource = VMCIResource_Get(handle, VMCI_RESOURCE_TYPE_DATAGRAM); if (resource == NULL) { return VMCI_ERROR_INVALID_ARGS; } srcEntry = RESOURCE_CONTAINER(resource, DatagramEntry, resource); *privFlags = srcEntry->privFlags; VMCIResource_Release(resource); } else if (contextID == VMCI_HYPERVISOR_CONTEXT_ID) { *privFlags = VMCI_MAX_PRIVILEGE_FLAGS; } else { *privFlags = vmci_context_get_priv_flags(contextID); } return VMCI_SUCCESS; } /* *------------------------------------------------------------------------------ * * VMCIDatagram_GetPrivFlags -- * * Utilility function that retrieves the privilege flags * associated with a given datagram handle. For hypervisor and * guest endpoints, the privileges are determined by the context * ID, but for host endpoints privileges are associated with the * complete handle. * * Result: * VMCI_SUCCESS on success, VMCI_ERROR_INVALID_ARGS if handle is invalid. * * Side effects: * None. * *------------------------------------------------------------------------------ */ int VMCIDatagram_GetPrivFlags(VMCIHandle handle, // IN VMCIPrivilegeFlags *privFlags) // OUT { if (privFlags == NULL || handle.context == VMCI_INVALID_ID) { return VMCI_ERROR_INVALID_ARGS; } return VMCIDatagramGetPrivFlagsInt(handle.context, handle, privFlags); } /* *----------------------------------------------------------------------------- * * VMCIDatagramDelayedDispatchCB -- * * Calls the specified callback in a delayed context. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static void VMCIDatagramDelayedDispatchCB(void *data) // IN { Bool inDGHostQueue; VMCIDelayedDatagramInfo *dgInfo = (VMCIDelayedDatagramInfo *)data; ASSERT(data); dgInfo->entry->recvCB(dgInfo->entry->clientData, &dgInfo->msg); VMCIResource_Release(&dgInfo->entry->resource); inDGHostQueue = dgInfo->inDGHostQueue; VMCI_FreeKernelMem(dgInfo, sizeof *dgInfo + (size_t)dgInfo->msg.payloadSize); if (inDGHostQueue) { Atomic_Dec(&delayedDGHostQueueSize); } } /* *------------------------------------------------------------------------------ * * VMCIDatagramDispatchAsHost -- * * Dispatch datagram as a host, to the host or other vm context. This * function cannot dispatch to hypervisor context handlers. This should * have been handled before we get here by VMCIDatagramDispatch. * * Result: * Number of bytes sent on success, appropriate error code otherwise. * * Side effects: * None. * *------------------------------------------------------------------------------ */ static int VMCIDatagramDispatchAsHost(VMCIId contextID, // IN: VMCIDatagram *dg) // IN: { int retval; size_t dgSize; VMCIPrivilegeFlags srcPrivFlags; ASSERT(dg); ASSERT(VMCI_HostPersonalityActive()); dgSize = VMCI_DG_SIZE(dg); if (contextID == VMCI_HOST_CONTEXT_ID && dg->dst.context == VMCI_HYPERVISOR_CONTEXT_ID) { VMCI_DEBUG_LOG(4, (LGPFX"Host cannot talk to hypervisor\n")); return VMCI_ERROR_DST_UNREACHABLE; } ASSERT(dg->dst.context != VMCI_HYPERVISOR_CONTEXT_ID); /* Chatty. */ // VMCI_DEBUG_LOG(10, (LGPFX"Sending from (handle=0x%x:0x%x) to " // "(handle=0x%x:0x%x) (size=%u bytes).\n", // dg->src.context, dg->src.resource, // dg->dst.context, dg->dst.resource, (uint32)dgSize)); /* * Check that source handle matches sending context. */ if (dg->src.context != contextID) { VMCI_DEBUG_LOG(4, (LGPFX"Sender context (ID=0x%x) is not owner of src " "datagram entry (handle=0x%x:0x%x).\n", contextID, dg->src.context, dg->src.resource)); return VMCI_ERROR_NO_ACCESS; } /* * Get hold of privileges of sending endpoint. */ retval = VMCIDatagramGetPrivFlagsInt(contextID, dg->src, &srcPrivFlags); if (retval != VMCI_SUCCESS) { VMCI_WARNING((LGPFX"Couldn't get privileges (handle=0x%x:0x%x).\n", dg->src.context, dg->src.resource)); return retval; } /* Determine if we should route to host or guest destination. */ if (dg->dst.context == VMCI_HOST_CONTEXT_ID) { /* Route to host datagram entry. */ DatagramEntry *dstEntry; VMCIResource *resource; if (dg->src.context == VMCI_HYPERVISOR_CONTEXT_ID && dg->dst.resource == VMCI_EVENT_HANDLER) { return VMCIEvent_Dispatch(dg); } resource = VMCIResource_Get(dg->dst, VMCI_RESOURCE_TYPE_DATAGRAM); if (resource == NULL) { VMCI_DEBUG_LOG(4, (LGPFX"Sending to invalid destination " "(handle=0x%x:0x%x).\n", dg->dst.context, dg->dst.resource)); return VMCI_ERROR_INVALID_RESOURCE; } dstEntry = RESOURCE_CONTAINER(resource, DatagramEntry, resource); if (VMCIDenyInteraction(srcPrivFlags, dstEntry->privFlags)) { VMCIResource_Release(resource); return VMCI_ERROR_NO_ACCESS; } ASSERT(dstEntry->recvCB); /* * If a VMCI datagram destined for the host is also sent by the * host, we always run it delayed. This ensures that no locks * are held when the datagram callback runs. */ if (dstEntry->runDelayed || (dg->src.context == VMCI_HOST_CONTEXT_ID && VMCI_CanScheduleDelayedWork())) { VMCIDelayedDatagramInfo *dgInfo; if (Atomic_ReadInc32(&delayedDGHostQueueSize) == VMCI_MAX_DELAYED_DG_HOST_QUEUE_SIZE) { Atomic_Dec(&delayedDGHostQueueSize); VMCIResource_Release(resource); return VMCI_ERROR_NO_MEM; } dgInfo = VMCI_AllocKernelMem(sizeof *dgInfo + (size_t)dg->payloadSize, (VMCI_MEMORY_ATOMIC | VMCI_MEMORY_NONPAGED)); if (NULL == dgInfo) { Atomic_Dec(&delayedDGHostQueueSize); VMCIResource_Release(resource); return VMCI_ERROR_NO_MEM; } dgInfo->inDGHostQueue = TRUE; dgInfo->entry = dstEntry; memcpy(&dgInfo->msg, dg, dgSize); retval = VMCI_ScheduleDelayedWork(VMCIDatagramDelayedDispatchCB, dgInfo); if (retval < VMCI_SUCCESS) { VMCI_WARNING((LGPFX"Failed to schedule delayed work for datagram " "(result=%d).\n", retval)); VMCI_FreeKernelMem(dgInfo, sizeof *dgInfo + (size_t)dg->payloadSize); VMCIResource_Release(resource); Atomic_Dec(&delayedDGHostQueueSize); return retval; } } else { retval = dstEntry->recvCB(dstEntry->clientData, dg); VMCIResource_Release(resource); if (retval < VMCI_SUCCESS) { return retval; } } } else { /* * Route to destination VM context. */ VMCIDatagram *newDG; if (contextID != dg->dst.context) { if (VMCIDenyInteraction(srcPrivFlags, vmci_context_get_priv_flags(dg->dst.context))) { VMCI_DEBUG_LOG(4, (LGPFX"Interaction denied (%X/%X - %X/%X)\n", contextID, srcPrivFlags, dg->dst.context, vmci_context_get_priv_flags(dg->dst.context))); return VMCI_ERROR_NO_ACCESS; } else if (VMCI_CONTEXT_IS_VM(contextID)) { /* * If the sending context is a VM, it cannot reach another VM. */ VMCI_DEBUG_LOG(4, (LGPFX"Datagram communication between VMs not " "supported (src=0x%x, dst=0x%x).\n", contextID, dg->dst.context)); return VMCI_ERROR_DST_UNREACHABLE; } } /* We make a copy to enqueue. */ newDG = VMCI_AllocKernelMem(dgSize, VMCI_MEMORY_NORMAL); if (newDG == NULL) { VMCI_DEBUG_LOG(4, (LGPFX"No memory for datagram\n")); return VMCI_ERROR_NO_MEM; } memcpy(newDG, dg, dgSize); retval = VMCIContext_EnqueueDatagram(dg->dst.context, newDG, TRUE); if (retval < VMCI_SUCCESS) { VMCI_FreeKernelMem(newDG, dgSize); VMCI_DEBUG_LOG(4, (LGPFX"Enqueue failed\n")); return retval; } } /* The datagram is freed when the context reads it. */ /* Chatty. */ // VMCI_DEBUG_LOG(10, (LGPFX"Sent datagram (size=%u bytes).\n", // (uint32)dgSize)); /* * We currently truncate the size to signed 32 bits. This doesn't * matter for this handler as it only support 4Kb messages. */ return (int)dgSize; } /* *------------------------------------------------------------------------------ * * VMCIDatagramDispatchAsGuest -- * * Dispatch datagram as a guest, down through the VMX and potentially to * the host. * * Result: * Number of bytes sent on success, appropriate error code otherwise. * * Side effects: * None. * *------------------------------------------------------------------------------ */ static int VMCIDatagramDispatchAsGuest(VMCIDatagram *dg) { #if defined(VMKERNEL) VMCI_WARNING((LGPFX"Cannot send down to host from VMKERNEL.\n")); return VMCI_ERROR_DST_UNREACHABLE; #else // VMKERNEL int retval; VMCIResource *resource; resource = VMCIResource_Get(dg->src, VMCI_RESOURCE_TYPE_DATAGRAM); if (NULL == resource) { return VMCI_ERROR_NO_HANDLE; } retval = VMCI_SendDatagram(dg); VMCIResource_Release(resource); return retval; #endif // VMKERNEL } /* *------------------------------------------------------------------------------ * * VMCIDatagram_Dispatch -- * * Dispatch datagram. This will determine the routing for the datagram * and dispatch it accordingly. * * Result: * Number of bytes sent on success, appropriate error code otherwise. * * Side effects: * None. * *------------------------------------------------------------------------------ */ int VMCIDatagram_Dispatch(VMCIId contextID, VMCIDatagram *dg, Bool fromGuest) { int retval; VMCIRoute route; ASSERT(dg); ASSERT_ON_COMPILE(sizeof(VMCIDatagram) == 24); if (VMCI_DG_SIZE(dg) > VMCI_MAX_DG_SIZE) { VMCI_DEBUG_LOG(4, (LGPFX"Payload (size=%"FMT64"u bytes) too big to " "send.\n", dg->payloadSize)); return VMCI_ERROR_INVALID_ARGS; } retval = VMCI_Route(&dg->src, &dg->dst, fromGuest, &route); if (retval < VMCI_SUCCESS) { VMCI_DEBUG_LOG(4, (LGPFX"Failed to route datagram (src=0x%x, dst=0x%x, " "err=%d)\n.", dg->src.context, dg->dst.context, retval)); return retval; } if (VMCI_ROUTE_AS_HOST == route) { if (VMCI_INVALID_ID == contextID) { contextID = VMCI_HOST_CONTEXT_ID; } return VMCIDatagramDispatchAsHost(contextID, dg); } if (VMCI_ROUTE_AS_GUEST == route) { return VMCIDatagramDispatchAsGuest(dg); } VMCI_WARNING((LGPFX"Unknown route (%d) for datagram.\n", route)); return VMCI_ERROR_DST_UNREACHABLE; } /* *------------------------------------------------------------------------------ * * VMCIDatagram_InvokeGuestHandler -- * * Invoke the handler for the given datagram. This is intended to be * called only when acting as a guest and receiving a datagram from the * virtual device. * * Result: * VMCI_SUCCESS on success, other error values on failure. * * Side effects: * None. * *------------------------------------------------------------------------------ */ int VMCIDatagram_InvokeGuestHandler(VMCIDatagram *dg) // IN { #if defined(VMKERNEL) VMCI_WARNING((LGPFX"Cannot dispatch within guest in VMKERNEL.\n")); return VMCI_ERROR_DST_UNREACHABLE; #else // VMKERNEL int retval; VMCIResource *resource; DatagramEntry *dstEntry; ASSERT(dg); if (dg->payloadSize > VMCI_MAX_DG_PAYLOAD_SIZE) { VMCI_DEBUG_LOG(4, (LGPFX"Payload (size=%"FMT64"u bytes) too large to " "deliver.\n", dg->payloadSize)); return VMCI_ERROR_PAYLOAD_TOO_LARGE; } resource = VMCIResource_Get(dg->dst, VMCI_RESOURCE_TYPE_DATAGRAM); if (NULL == resource) { VMCI_DEBUG_LOG(4, (LGPFX"destination (handle=0x%x:0x%x) doesn't exist.\n", dg->dst.context, dg->dst.resource)); return VMCI_ERROR_NO_HANDLE; } dstEntry = RESOURCE_CONTAINER(resource, DatagramEntry, resource); if (dstEntry->runDelayed) { VMCIDelayedDatagramInfo *dgInfo; dgInfo = VMCI_AllocKernelMem(sizeof *dgInfo + (size_t)dg->payloadSize, (VMCI_MEMORY_ATOMIC | VMCI_MEMORY_NONPAGED)); if (NULL == dgInfo) { VMCIResource_Release(resource); retval = VMCI_ERROR_NO_MEM; goto exit; } dgInfo->inDGHostQueue = FALSE; dgInfo->entry = dstEntry; memcpy(&dgInfo->msg, dg, VMCI_DG_SIZE(dg)); retval = VMCI_ScheduleDelayedWork(VMCIDatagramDelayedDispatchCB, dgInfo); if (retval < VMCI_SUCCESS) { VMCI_WARNING((LGPFX"Failed to schedule delayed work for datagram " "(result=%d).\n", retval)); VMCI_FreeKernelMem(dgInfo, sizeof *dgInfo + (size_t)dg->payloadSize); VMCIResource_Release(resource); dgInfo = NULL; goto exit; } } else { dstEntry->recvCB(dstEntry->clientData, dg); VMCIResource_Release(resource); retval = VMCI_SUCCESS; } exit: return retval; #endif // VMKERNEL } /* *------------------------------------------------------------------------------ * * vmci_datagram_send -- * * Sends the payload to the destination datagram handle. * * Results: * Returns number of bytes sent if success, or error code if failure. * * Side effects: * None. * *------------------------------------------------------------------------------ */ VMCI_EXPORT_SYMBOL(vmci_datagram_send) int vmci_datagram_send(VMCIDatagram *msg) // IN { if (msg == NULL) { return VMCI_ERROR_INVALID_ARGS; } return VMCIDatagram_Dispatch(VMCI_INVALID_ID, msg, FALSE); } /* *----------------------------------------------------------------------------- * * VMCIDatagram_Sync -- * * Use this as a synchronization point when setting globals, for example, * during device shutdown. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ void VMCIDatagram_Sync(void) { VMCIResource_Sync(); } /* *----------------------------------------------------------------------------- * * VMCIDatagram_CheckHostCapabilities -- * * Verify that the host supports the resources we need. * None are required for datagrams since they are implicitly supported. * * Results: * TRUE. * * Side effects: * None. * *----------------------------------------------------------------------------- */ Bool VMCIDatagram_CheckHostCapabilities(void) { return TRUE; } vmci-only/common/vmciQPair.c 0000444 0000000 0000000 00000123626 13432725347 015042 0 ustar root root /********************************************************* * Copyright (C) 2010-2017 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 * *********************************************************/ /* * vmciQPair.c -- * * This file implements Queue accessor methods. * * VMCIQPair is a new interface that hides the queue pair internals. * Rather than access each queue in a pair directly, operations are now * performed on the queue as a whole. This is simpler and less * error-prone, and allows for future queue pair features to be added * under the hood with no change to the client code. * * This also helps in a particular case on Windows hosts, where the memory * allocated by the client (e.g., VMX) will disappear when the client does * (e.g., abnormal termination). The kernel can't lock user memory into * its address space indefinitely. By guarding access to the queue * contents we can correctly handle the case where the client disappears. * * On code style: * * + This entire file started its life as a cut-and-paste of the * static INLINE functions in bora/public/vmci_queue_pair.h. * From there, new copies of the routines were made named * without the prefix VMCI, without the underscore (the one * that followed VMCIQueue_). The no-underscore versions of * the routines require that the mutexes are held. * * + The code -always- uses the xyzLocked() version of any given * routine even when the wrapped function is a one-liner. The * reason for this decision was to ensure that we didn't have * copies of logic lying around that needed to be maintained. * * + Note that we still pass around 'const VMCIQueue *'s. * * + Note that mutex is a field within VMCIQueue. We skirt the * issue of passing around a const VMCIQueue, even though the * mutex field (__mutex, specifically) will get modified by not * ever referring to the mutex -itself- except during * initialization. Beyond that, the code only passes the * pointer to the mutex, which is also a member of VMCIQueue, * obviously, and which doesn't change after initialization. * This eliminates having to redefine all the functions that * are currently taking const VMCIQueue's so that these * functions are compatible with those definitions. */ #include "vmci_kernel_if.h" #include "vm_assert.h" #include "vmci_handle_array.h" #include "vmci_defs.h" #include "vmciKernelAPI.h" #include "vmciQueue.h" #include "vmciQueuePair.h" #include "vmciRoute.h" /* * VMCIQPair * * This structure is opaque to the clients. */ struct VMCIQPair { VMCIHandle handle; VMCIQueue *produceQ; VMCIQueue *consumeQ; uint64 produceQSize; uint64 consumeQSize; VMCIId peer; uint32 flags; VMCIPrivilegeFlags privFlags; Bool guestEndpoint; uint32 blocked; VMCIEvent event; }; static int VMCIQPairMapQueueHeaders(VMCIQueue *produceQ, VMCIQueue *consumeQ, Bool canBlock); static int VMCIQPairGetQueueHeaders(const VMCIQPair *qpair, VMCIQueueHeader **produceQHeader, VMCIQueueHeader **consumeQHeader); static int VMCIQPairWakeupCB(void *clientData); static int VMCIQPairReleaseMutexCB(void *clientData); static Bool VMCIQPairWaitForReadyQueue(VMCIQPair *qpair); /* *----------------------------------------------------------------------------- * * VMCIQPairLock -- * * Helper routine that will lock the QPair before subsequent operations. * * Results: * VMCI_SUCCESS if lock acquired. VMCI_ERROR_WOULD_BLOCK if queue mutex * couldn't be acquired and qpair isn't allowed to block. * * Side effects: * May block. * *----------------------------------------------------------------------------- */ static INLINE int VMCIQPairLock(const VMCIQPair *qpair) // IN { #if !defined VMX86_VMX return VMCI_AcquireQueueMutex(qpair->produceQ, !(qpair->flags & VMCI_QPFLAG_NONBLOCK)); #else return VMCI_SUCCESS #endif } /* *----------------------------------------------------------------------------- * * VMCIQPairUnlock -- * * Helper routine that will unlock the QPair after various operations. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE void VMCIQPairUnlock(const VMCIQPair *qpair) // IN { #if !defined VMX86_VMX VMCI_ReleaseQueueMutex(qpair->produceQ); #endif } /* *----------------------------------------------------------------------------- * * VMCIQPairHeaderLock -- * * Helper routine that will lock the queue pair header before subsequent * operations. If the queue pair is non blocking, a spinlock will be used. * Otherwise, a regular mutex locking the complete queue pair will be used. * * Results: * None. * * Side effects: * May block. * *----------------------------------------------------------------------------- */ static INLINE void VMCIQPairLockHeader(const VMCIQPair *qpair) // IN { #if !defined VMX86_VMX if (qpair->flags & VMCI_QPFLAG_NONBLOCK) { VMCI_LockQueueHeader(qpair->produceQ); } else { (void)VMCI_AcquireQueueMutex(qpair->produceQ, !(qpair->flags & VMCI_QPFLAG_NONBLOCK)); } #endif } /* *----------------------------------------------------------------------------- * * VMCIQPairUnlockHeader -- * * Helper routine that unlocks the queue pair header after calling * VMCIQPairHeaderLock. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE void VMCIQPairUnlockHeader(const VMCIQPair *qpair) // IN { #if !defined VMX86_VMX if (qpair->flags & VMCI_QPFLAG_NONBLOCK) { VMCI_UnlockQueueHeader(qpair->produceQ); } else { VMCI_ReleaseQueueMutex(qpair->produceQ); } #endif } /* *----------------------------------------------------------------------------- * * VMCIQueueAddProducerTail() -- * * Helper routine to increment the Producer Tail. * * Results: * VMCI_ERROR_NOT_FOUND if the vmmWorld registered with the queue * cannot be found. Otherwise VMCI_SUCCESS. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE int VMCIQueueAddProducerTail(VMCIQueue *queue, // IN/OUT size_t add, // IN uint64 queueSize) // IN { VMCIQueueHeader_AddProducerTail(queue->qHeader, add, queueSize); return VMCI_QueueHeaderUpdated(queue); } /* *----------------------------------------------------------------------------- * * VMCIQueueAddConsumerHead() -- * * Helper routine to increment the Consumer Head. * * Results: * VMCI_ERROR_NOT_FOUND if the vmmWorld registered with the queue * cannot be found. Otherwise VMCI_SUCCESS. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE int VMCIQueueAddConsumerHead(VMCIQueue *queue, // IN/OUT size_t add, // IN uint64 queueSize) // IN { VMCIQueueHeader_AddConsumerHead(queue->qHeader, add, queueSize); return VMCI_QueueHeaderUpdated(queue); } /* *----------------------------------------------------------------------------- * * VMCIQPairGetQueueHeaders -- * * Helper routine that will retrieve the produce and consume * headers of a given queue pair. If the guest memory of the * queue pair is currently not available, the saved queue headers * will be returned, if these are available. * * Results: * VMCI_SUCCESS if either current or saved queue headers are found. * Appropriate error code otherwise. * * Side effects: * May block. * *----------------------------------------------------------------------------- */ static int VMCIQPairGetQueueHeaders(const VMCIQPair *qpair, // IN VMCIQueueHeader **produceQHeader, // OUT VMCIQueueHeader **consumeQHeader) // OUT { int result; result = VMCIQPairMapQueueHeaders(qpair->produceQ, qpair->consumeQ, !(qpair->flags & VMCI_QPFLAG_NONBLOCK)); if (result == VMCI_SUCCESS) { *produceQHeader = qpair->produceQ->qHeader; *consumeQHeader = qpair->consumeQ->qHeader; } else if (qpair->produceQ->savedHeader && qpair->consumeQ->savedHeader) { ASSERT(!qpair->guestEndpoint); *produceQHeader = qpair->produceQ->savedHeader; *consumeQHeader = qpair->consumeQ->savedHeader; result = VMCI_SUCCESS; } return result; } /* *----------------------------------------------------------------------------- * * VMCIQPairMapQueueHeaders -- * * The queue headers may not be mapped at all times. If a queue is * currently not mapped, it will be attempted to do so. * * Results: * VMCI_SUCCESS if queues were validated, appropriate error code otherwise. * * Side effects: * May attempt to map in guest memory. * *----------------------------------------------------------------------------- */ static int VMCIQPairMapQueueHeaders(VMCIQueue *produceQ, // IN VMCIQueue *consumeQ, // IN Bool canBlock) // IN { int result; if (NULL == produceQ->qHeader || NULL == consumeQ->qHeader) { if (canBlock) { result = VMCIHost_MapQueues(produceQ, consumeQ, 0); } else { result = VMCI_ERROR_QUEUEPAIR_NOT_READY; } if (result < VMCI_SUCCESS) { if (produceQ->savedHeader && consumeQ->savedHeader) { return VMCI_ERROR_QUEUEPAIR_NOT_READY; } else { return VMCI_ERROR_QUEUEPAIR_NOTATTACHED; } } } return VMCI_SUCCESS; } /* *----------------------------------------------------------------------------- * * VMCIQPairWakeupCB -- * * Callback from VMCI queue pair broker indicating that a queue * pair that was previously not ready, now either is ready or * gone forever. * * Results: * VMCI_SUCCESS always. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static int VMCIQPairWakeupCB(void *clientData) { VMCIQPair *qpair = (VMCIQPair *)clientData; ASSERT(qpair); VMCIQPairLock(qpair); while (qpair->blocked > 0) { qpair->blocked--; VMCI_SignalEvent(&qpair->event); } VMCIQPairUnlock(qpair); return VMCI_SUCCESS; } /* *----------------------------------------------------------------------------- * * VMCIQPairReleaseMutexCB -- * * Callback from VMCI_WaitOnEvent releasing the queue pair mutex * protecting the queue pair header state. * * Results: * 0 always. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static int VMCIQPairReleaseMutexCB(void *clientData) { VMCIQPair *qpair = (VMCIQPair *)clientData; ASSERT(qpair); VMCIQPairUnlock(qpair); return 0; } /* *----------------------------------------------------------------------------- * * VMCIQPairWaitForReadyQueue -- * * Makes the calling thread wait for the queue pair to become * ready for host side access. * * Results: * TRUE when thread is woken up after queue pair state change. * FALSE otherwise. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static Bool VMCIQPairWaitForReadyQueue(VMCIQPair *qpair) { if (UNLIKELY(qpair->guestEndpoint)) { ASSERT(FALSE); return FALSE; } if (qpair->flags & VMCI_QPFLAG_NONBLOCK) { return FALSE; } qpair->blocked++; VMCI_WaitOnEvent(&qpair->event, VMCIQPairReleaseMutexCB, qpair); VMCIQPairLock(qpair); return TRUE; } /* *----------------------------------------------------------------------------- * * vmci_qpair_alloc -- * * This is the client interface for allocating the memory for a * VMCIQPair structure and then attaching to the underlying * queue. If an error occurs allocating the memory for the * VMCIQPair structure, no attempt is made to attach. If an * error occurs attaching, then there's the VMCIQPair structure * is freed. * * Results: * An err, if < 0. * * Side effects: * Windows blocking call. * *----------------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_qpair_alloc) int vmci_qpair_alloc(VMCIQPair **qpair, // OUT VMCIHandle *handle, // OUT uint64 produceQSize, // IN uint64 consumeQSize, // IN VMCIId peer, // IN uint32 flags, // IN VMCIPrivilegeFlags privFlags) // IN { VMCIQPair *myQPair; int retval; VMCIHandle src = VMCI_INVALID_HANDLE; VMCIHandle dst = VMCI_MAKE_HANDLE(peer, VMCI_INVALID_ID); VMCIRoute route; VMCIEventReleaseCB wakeupCB; void *clientData; /* * Restrict the size of a queuepair. The device already enforces a limit * on the total amount of memory that can be allocated to queuepairs for a * guest. However, we try to allocate this memory before we make the * queuepair allocation hypercall. On Windows and Mac OS, we request a * single, continguous block, and it will fail if the OS cannot satisfy the * request. On Linux, we allocate each page separately, which means rather * than fail, the guest will thrash while it tries to allocate, and will * become increasingly unresponsive to the point where it appears to be hung. * So we place a limit on the size of an individual queuepair here, and * leave the device to enforce the restriction on total queuepair memory. * (Note that this doesn't prevent all cases; a user with only this much * physical memory could still get into trouble.) The error used by the * device is NO_RESOURCES, so use that here too. */ if (produceQSize + consumeQSize < MAX(produceQSize, consumeQSize) || produceQSize + consumeQSize > VMCI_MAX_GUEST_QP_MEMORY) { return VMCI_ERROR_NO_RESOURCES; } retval = VMCI_Route(&src, &dst, FALSE, &route); if (retval < VMCI_SUCCESS) { if (VMCI_GuestPersonalityActive()) { route = VMCI_ROUTE_AS_GUEST; } else { route = VMCI_ROUTE_AS_HOST; } } if (flags & VMCI_QPFLAG_NONBLOCK && !vmkernel) { return VMCI_ERROR_INVALID_ARGS; } myQPair = VMCI_AllocKernelMem(sizeof *myQPair, VMCI_MEMORY_NONPAGED); if (!myQPair) { return VMCI_ERROR_NO_MEM; } myQPair->produceQSize = produceQSize; myQPair->consumeQSize = consumeQSize; myQPair->peer = peer; myQPair->flags = flags; myQPair->privFlags = privFlags; clientData = NULL; wakeupCB = NULL; if (VMCI_ROUTE_AS_HOST == route) { myQPair->guestEndpoint = FALSE; if (!(flags & VMCI_QPFLAG_LOCAL)) { myQPair->blocked = 0; VMCI_CreateEvent(&myQPair->event); wakeupCB = VMCIQPairWakeupCB; clientData = (void *)myQPair; } } else { myQPair->guestEndpoint = TRUE; } retval = VMCIQueuePair_Alloc(handle, &myQPair->produceQ, myQPair->produceQSize, &myQPair->consumeQ, myQPair->consumeQSize, myQPair->peer, myQPair->flags, myQPair->privFlags, myQPair->guestEndpoint, wakeupCB, clientData); if (retval < VMCI_SUCCESS) { if (VMCI_ROUTE_AS_HOST == route && !(flags & VMCI_QPFLAG_LOCAL)) { VMCI_DestroyEvent(&myQPair->event); } VMCI_FreeKernelMem(myQPair, sizeof *myQPair); return retval; } *qpair = myQPair; myQPair->handle = *handle; return retval; } /* *----------------------------------------------------------------------------- * * vmci_qpair_detach -- * * This is the client interface for detaching from a VMCIQPair. * Note that this routine will free the memory allocated for the * VMCIQPair structure, too. * * Results: * An error, if < 0. * * Side effects: * Will clear the caller's pointer to the VMCIQPair structure. * *----------------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_qpair_detach) int vmci_qpair_detach(VMCIQPair **qpair) // IN/OUT { int result; VMCIQPair *oldQPair; if (!qpair || !(*qpair)) { return VMCI_ERROR_INVALID_ARGS; } oldQPair = *qpair; result = VMCIQueuePair_Detach(oldQPair->handle, oldQPair->guestEndpoint); /* * The guest can fail to detach for a number of reasons, and if it does so, * it will cleanup the entry (if there is one). The host can fail too, but * it won't cleanup the entry immediately, it will do that later when the * context is freed. Either way, we need to release the qpair struct here; * there isn't much the caller can do, and we don't want to leak. */ if (!(oldQPair->guestEndpoint || (oldQPair->flags & VMCI_QPFLAG_LOCAL))) { VMCI_DestroyEvent(&oldQPair->event); } VMCI_FreeKernelMem(oldQPair, sizeof *oldQPair); *qpair = NULL; return result; } /* *----------------------------------------------------------------------------- * * vmci_qpair_get_detach_cause -- * * This is the client interface for retrieving the cause of a * peer detach from a queue pair. * * Results: * An error, if < 0. * * Side effects: * None. * *----------------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_qpair_get_detach_cause) int vmci_qpair_get_detach_cause(VMCIQPair *qpair, // IN uint8 *cause) // OUT { #if defined(VMKERNEL) if (!qpair) { return VMCI_ERROR_INVALID_ARGS; } return VMCIQueuePair_GetDetachCause(qpair->handle, cause); #else UNREFERENCED_PARAMETER(qpair); UNREFERENCED_PARAMETER(cause); return VMCI_ERROR_UNAVAILABLE; #endif } /* *----------------------------------------------------------------------------- * * vmci_qpair_get_produce_indexes -- * * This is the client interface for getting the current indexes of the * QPair from the point of the view of the caller as the producer. * * Results: * err, if < 0 * Success otherwise. * * Side effects: * Windows blocking call. * *----------------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_qpair_get_produce_indexes) int vmci_qpair_get_produce_indexes(const VMCIQPair *qpair, // IN uint64 *producerTail, // OUT uint64 *consumerHead) // OUT { VMCIQueueHeader *produceQHeader; VMCIQueueHeader *consumeQHeader; int result; if (!qpair) { return VMCI_ERROR_INVALID_ARGS; } VMCIQPairLockHeader(qpair); result = VMCIQPairGetQueueHeaders(qpair, &produceQHeader, &consumeQHeader); if (result == VMCI_SUCCESS) { VMCIQueueHeader_GetPointers(produceQHeader, consumeQHeader, producerTail, consumerHead); } VMCIQPairUnlockHeader(qpair); if (result == VMCI_SUCCESS && ((producerTail && *producerTail >= qpair->produceQSize) || (consumerHead && *consumerHead >= qpair->produceQSize))) { return VMCI_ERROR_INVALID_SIZE; } return result; } /* *----------------------------------------------------------------------------- * * vmci_qpair_get_consume_indexes -- * * This is the client interface for getting the current indexes of the * QPair from the point of the view of the caller as the consumer. * * Results: * err, if < 0 * Success otherwise. * * Side effects: * Windows blocking call. * *----------------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_qpair_get_consume_indexes) int vmci_qpair_get_consume_indexes(const VMCIQPair *qpair, // IN uint64 *consumerTail, // OUT uint64 *producerHead) // OUT { VMCIQueueHeader *produceQHeader; VMCIQueueHeader *consumeQHeader; int result; if (!qpair) { return VMCI_ERROR_INVALID_ARGS; } VMCIQPairLockHeader(qpair); result = VMCIQPairGetQueueHeaders(qpair, &produceQHeader, &consumeQHeader); if (result == VMCI_SUCCESS) { VMCIQueueHeader_GetPointers(consumeQHeader, produceQHeader, consumerTail, producerHead); } VMCIQPairUnlockHeader(qpair); if (result == VMCI_SUCCESS && ((consumerTail && *consumerTail >= qpair->consumeQSize) || (producerHead && *producerHead >= qpair->consumeQSize))) { return VMCI_ERROR_INVALID_SIZE; } return result; } /* *----------------------------------------------------------------------------- * * vmci_qpair_produce_free_space -- * * This is the client interface for getting the amount of free * space in the QPair from the point of the view of the caller as * the producer which is the common case. * * Results: * Err, if < 0. * Full queue if = 0. * Number of available bytes into which data can be enqueued if > 0. * * Side effects: * Windows blocking call. * *----------------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_qpair_produce_free_space) int64 vmci_qpair_produce_free_space(const VMCIQPair *qpair) // IN { VMCIQueueHeader *produceQHeader; VMCIQueueHeader *consumeQHeader; int64 result; if (!qpair) { return VMCI_ERROR_INVALID_ARGS; } VMCIQPairLockHeader(qpair); result = VMCIQPairGetQueueHeaders(qpair, &produceQHeader, &consumeQHeader); if (result == VMCI_SUCCESS) { result = VMCIQueueHeader_FreeSpace(produceQHeader, consumeQHeader, qpair->produceQSize); } else { result = 0; } VMCIQPairUnlockHeader(qpair); return result; } /* *----------------------------------------------------------------------------- * * vmci_qpair_consume_free_space -- * * This is the client interface for getting the amount of free * space in the QPair from the point of the view of the caller as * the consumer which is not the common case (see * VMCIQPair_ProduceFreeSpace(), above). * * Results: * Err, if < 0. * Full queue if = 0. * Number of available bytes into which data can be enqueued if > 0. * * Side effects: * Windows blocking call. * *----------------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_qpair_consume_free_space) int64 vmci_qpair_consume_free_space(const VMCIQPair *qpair) // IN { VMCIQueueHeader *produceQHeader; VMCIQueueHeader *consumeQHeader; int64 result; if (!qpair) { return VMCI_ERROR_INVALID_ARGS; } VMCIQPairLockHeader(qpair); result = VMCIQPairGetQueueHeaders(qpair, &produceQHeader, &consumeQHeader); if (result == VMCI_SUCCESS) { result = VMCIQueueHeader_FreeSpace(consumeQHeader, produceQHeader, qpair->consumeQSize); } else { result = 0; } VMCIQPairUnlockHeader(qpair); return result; } /* *----------------------------------------------------------------------------- * * vmci_qpair_produce_buf_ready -- * * This is the client interface for getting the amount of * enqueued data in the QPair from the point of the view of the * caller as the producer which is not the common case (see * VMCIQPair_ConsumeBufReady(), above). * * Results: * Err, if < 0. * Empty queue if = 0. * Number of bytes ready to be dequeued if > 0. * * Side effects: * Windows blocking call. * *----------------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_qpair_produce_buf_ready) int64 vmci_qpair_produce_buf_ready(const VMCIQPair *qpair) // IN { VMCIQueueHeader *produceQHeader; VMCIQueueHeader *consumeQHeader; int64 result; if (!qpair) { return VMCI_ERROR_INVALID_ARGS; } VMCIQPairLockHeader(qpair); result = VMCIQPairGetQueueHeaders(qpair, &produceQHeader, &consumeQHeader); if (result == VMCI_SUCCESS) { result = VMCIQueueHeader_BufReady(produceQHeader, consumeQHeader, qpair->produceQSize); } else { result = 0; } VMCIQPairUnlockHeader(qpair); return result; } /* *----------------------------------------------------------------------------- * * vmci_qpair_consume_buf_ready -- * * This is the client interface for getting the amount of * enqueued data in the QPair from the point of the view of the * caller as the consumer which is the normal case. * * Results: * Err, if < 0. * Empty queue if = 0. * Number of bytes ready to be dequeued if > 0. * * Side effects: * Windows blocking call. * *----------------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_qpair_consume_buf_ready) int64 vmci_qpair_consume_buf_ready(const VMCIQPair *qpair) // IN { VMCIQueueHeader *produceQHeader; VMCIQueueHeader *consumeQHeader; int64 result; if (!qpair) { return VMCI_ERROR_INVALID_ARGS; } VMCIQPairLockHeader(qpair); result = VMCIQPairGetQueueHeaders(qpair, &produceQHeader, &consumeQHeader); if (result == VMCI_SUCCESS) { result = VMCIQueueHeader_BufReady(consumeQHeader, produceQHeader, qpair->consumeQSize); } else { result = 0; } VMCIQPairUnlockHeader(qpair); return result; } /* *----------------------------------------------------------------------------- * * EnqueueLocked -- * * Enqueues a given buffer to the produce queue using the provided * function. As many bytes as possible (space available in the queue) * are enqueued. * * Assumes the queue->mutex has been acquired. * * Results: * VMCI_ERROR_QUEUEPAIR_NOSPACE if no space was available to enqueue data. * VMCI_ERROR_INVALID_SIZE, if any queue pointer is outside the queue * (as defined by the queue size). * VMCI_ERROR_INVALID_ARGS, if an error occured when accessing the buffer. * VMCI_ERROR_QUEUEPAIR_NOTATTACHED, if the queue pair pages aren't * available. * VMCI_ERROR_NOT_FOUND, if the vmmWorld registered with the queue pair * cannot be found. * Otherwise, the number of bytes written to the queue is returned. * * Side effects: * Updates the tail pointer of the produce queue. * *----------------------------------------------------------------------------- */ static ssize_t EnqueueLocked(VMCIQueue *produceQ, // IN VMCIQueue *consumeQ, // IN const uint64 produceQSize, // IN const void *buf, // IN size_t bufSize, // IN int bufType, // IN VMCIMemcpyToQueueFunc memcpyToQueue, // IN Bool canBlock) // IN { int64 freeSpace; uint64 tail; size_t written; ssize_t result; #if !defined VMX86_VMX if (UNLIKELY(VMCI_EnqueueToDevNull(produceQ))) { return (ssize_t) bufSize; } result = VMCIQPairMapQueueHeaders(produceQ, consumeQ, canBlock); if (UNLIKELY(result != VMCI_SUCCESS)) { return result; } #endif freeSpace = VMCIQueueHeader_FreeSpace(produceQ->qHeader, consumeQ->qHeader, produceQSize); if (freeSpace == 0) { return VMCI_ERROR_QUEUEPAIR_NOSPACE; } if (freeSpace < VMCI_SUCCESS) { return (ssize_t)freeSpace; } written = (size_t)(freeSpace > bufSize ? bufSize : freeSpace); tail = VMCIQueueHeader_ProducerTail(produceQ->qHeader); if (LIKELY(tail + written < produceQSize)) { result = memcpyToQueue(produceQ, tail, buf, 0, written, bufType, canBlock); } else { /* Tail pointer wraps around. */ const size_t tmp = (size_t)(produceQSize - tail); result = memcpyToQueue(produceQ, tail, buf, 0, tmp, bufType, canBlock); if (result >= VMCI_SUCCESS) { result = memcpyToQueue(produceQ, 0, buf, tmp, written - tmp, bufType, canBlock); } } if (result < VMCI_SUCCESS) { return result; } result = VMCIQueueAddProducerTail(produceQ, written, produceQSize); if (result < VMCI_SUCCESS) { return result; } return written; } /* *----------------------------------------------------------------------------- * * DequeueLocked -- * * Dequeues data (if available) from the given consume queue. Writes data * to the user provided buffer using the provided function. * * Assumes the queue->mutex has been acquired. * * Results: * VMCI_ERROR_QUEUEPAIR_NODATA if no data was available to dequeue. * VMCI_ERROR_INVALID_SIZE, if any queue pointer is outside the queue * (as defined by the queue size). * VMCI_ERROR_INVALID_ARGS, if an error occured when accessing the buffer. * VMCI_ERROR_NOT_FOUND, if the vmmWorld registered with the queue pair * cannot be found. * Otherwise the number of bytes dequeued is returned. * * Side effects: * Updates the head pointer of the consume queue. * *----------------------------------------------------------------------------- */ static ssize_t DequeueLocked(VMCIQueue *produceQ, // IN VMCIQueue *consumeQ, // IN const uint64 consumeQSize, // IN void *buf, // IN size_t bufSize, // IN int bufType, // IN VMCIMemcpyFromQueueFunc memcpyFromQueue, // IN Bool updateConsumer, // IN Bool canBlock) // IN { int64 bufReady; uint64 head; size_t read; ssize_t result; #if !defined VMX86_VMX result = VMCIQPairMapQueueHeaders(produceQ, consumeQ, canBlock); if (UNLIKELY(result != VMCI_SUCCESS)) { return result; } #endif bufReady = VMCIQueueHeader_BufReady(consumeQ->qHeader, produceQ->qHeader, consumeQSize); if (bufReady == 0) { return VMCI_ERROR_QUEUEPAIR_NODATA; } if (bufReady < VMCI_SUCCESS) { return (ssize_t)bufReady; } read = (size_t)(bufReady > bufSize ? bufSize : bufReady); head = VMCIQueueHeader_ConsumerHead(produceQ->qHeader); if (LIKELY(head + read < consumeQSize)) { result = memcpyFromQueue(buf, 0, consumeQ, head, read, bufType, canBlock); } else { /* Head pointer wraps around. */ const size_t tmp = (size_t)(consumeQSize - head); result = memcpyFromQueue(buf, 0, consumeQ, head, tmp, bufType, canBlock); if (result >= VMCI_SUCCESS) { result = memcpyFromQueue(buf, tmp, consumeQ, 0, read - tmp, bufType, canBlock); } } if (result < VMCI_SUCCESS) { return result; } if (updateConsumer) { result = VMCIQueueAddConsumerHead(produceQ, read, consumeQSize); if (result < VMCI_SUCCESS) { return result; } } return read; } /* *----------------------------------------------------------------------------- * * vmci_qpair_enqueue -- * * This is the client interface for enqueueing data into the queue. * * Results: * Err, if < 0. * Number of bytes enqueued if >= 0. * * Side effects: * Windows blocking call. * *----------------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_qpair_enqueue) ssize_t vmci_qpair_enqueue(VMCIQPair *qpair, // IN const void *buf, // IN size_t bufSize, // IN int bufType) // IN { ssize_t result; if (!qpair || !buf) { return VMCI_ERROR_INVALID_ARGS; } result = VMCIQPairLock(qpair); if (result != VMCI_SUCCESS) { return result; } do { result = EnqueueLocked(qpair->produceQ, qpair->consumeQ, qpair->produceQSize, buf, bufSize, bufType, qpair->flags & VMCI_QPFLAG_LOCAL? VMCIMemcpyToQueueLocal: VMCIMemcpyToQueue, !(qpair->flags & VMCI_QPFLAG_NONBLOCK)); if (result == VMCI_ERROR_QUEUEPAIR_NOT_READY) { if (!VMCIQPairWaitForReadyQueue(qpair)) { result = VMCI_ERROR_WOULD_BLOCK; } } } while (result == VMCI_ERROR_QUEUEPAIR_NOT_READY); VMCIQPairUnlock(qpair); return result; } /* *----------------------------------------------------------------------------- * * vmci_qpair_dequeue -- * * This is the client interface for dequeueing data from the queue. * * Results: * Err, if < 0. * Number of bytes dequeued if >= 0. * * Side effects: * Windows blocking call. * *----------------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_qpair_dequeue) ssize_t vmci_qpair_dequeue(VMCIQPair *qpair, // IN void *buf, // IN size_t bufSize, // IN int bufType) // IN { ssize_t result; if (!qpair || !buf) { return VMCI_ERROR_INVALID_ARGS; } result = VMCIQPairLock(qpair); if (result != VMCI_SUCCESS) { return result; } do { result = DequeueLocked(qpair->produceQ, qpair->consumeQ, qpair->consumeQSize, buf, bufSize, bufType, qpair->flags & VMCI_QPFLAG_LOCAL? VMCIMemcpyFromQueueLocal: VMCIMemcpyFromQueue, TRUE, !(qpair->flags & VMCI_QPFLAG_NONBLOCK)); if (result == VMCI_ERROR_QUEUEPAIR_NOT_READY) { if (!VMCIQPairWaitForReadyQueue(qpair)) { result = VMCI_ERROR_WOULD_BLOCK; } } } while (result == VMCI_ERROR_QUEUEPAIR_NOT_READY); VMCIQPairUnlock(qpair); return result; } /* *----------------------------------------------------------------------------- * * vmci_qpair_peek -- * * This is the client interface for peeking into a queue. (I.e., * copy data from the queue without updating the head pointer.) * * Results: * Err, if < 0. * Number of bytes peeked, if >= 0. * * Side effects: * Windows blocking call. * *----------------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_qpair_peek) ssize_t vmci_qpair_peek(VMCIQPair *qpair, // IN void *buf, // IN size_t bufSize, // IN int bufType) // IN { ssize_t result; if (!qpair || !buf) { return VMCI_ERROR_INVALID_ARGS; } result = VMCIQPairLock(qpair); if (result != VMCI_SUCCESS) { return result; } do { result = DequeueLocked(qpair->produceQ, qpair->consumeQ, qpair->consumeQSize, buf, bufSize, bufType, qpair->flags & VMCI_QPFLAG_LOCAL? VMCIMemcpyFromQueueLocal: VMCIMemcpyFromQueue, FALSE, !(qpair->flags & VMCI_QPFLAG_NONBLOCK)); if (result == VMCI_ERROR_QUEUEPAIR_NOT_READY) { if (!VMCIQPairWaitForReadyQueue(qpair)) { result = VMCI_ERROR_WOULD_BLOCK; } } } while (result == VMCI_ERROR_QUEUEPAIR_NOT_READY); VMCIQPairUnlock(qpair); return result; } #if (defined(__APPLE__) && !defined (VMX86_TOOLS)) || \ (defined(__linux__) && defined(__KERNEL__)) || \ (defined(_WIN32) && defined(WINNT_DDK)) /* *----------------------------------------------------------------------------- * * vmci_qpair_enquev -- * * This is the client interface for enqueueing data into the queue. * * Results: * Err, if < 0. * Number of bytes enqueued if >= 0. * * Side effects: * Windows blocking call. * *----------------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_qpair_enquev) ssize_t vmci_qpair_enquev(VMCIQPair *qpair, // IN void *iov, // IN size_t iovSize, // IN int bufType) // IN { ssize_t result; if (!qpair || !iov) { return VMCI_ERROR_INVALID_ARGS; } result = VMCIQPairLock(qpair); if (result != VMCI_SUCCESS) { return result; } do { result = EnqueueLocked(qpair->produceQ, qpair->consumeQ, qpair->produceQSize, iov, iovSize, bufType, qpair->flags & VMCI_QPFLAG_LOCAL? VMCIMemcpyToQueueVLocal: VMCIMemcpyToQueueV, !(qpair->flags & VMCI_QPFLAG_NONBLOCK)); if (result == VMCI_ERROR_QUEUEPAIR_NOT_READY) { if (!VMCIQPairWaitForReadyQueue(qpair)) { result = VMCI_ERROR_WOULD_BLOCK; } } } while (result == VMCI_ERROR_QUEUEPAIR_NOT_READY); VMCIQPairUnlock(qpair); return result; } /* *----------------------------------------------------------------------------- * * vmci_qpair_dequev -- * * This is the client interface for dequeueing data from the queue. * * Results: * Err, if < 0. * Number of bytes dequeued if >= 0. * * Side effects: * Windows blocking call. * *----------------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_qpair_dequev) ssize_t vmci_qpair_dequev(VMCIQPair *qpair, // IN void *iov, // IN size_t iovSize, // IN int bufType) // IN { ssize_t result; if (!qpair || !iov) { return VMCI_ERROR_INVALID_ARGS; } result = VMCIQPairLock(qpair); if (result != VMCI_SUCCESS) { return result; } do { result = DequeueLocked(qpair->produceQ, qpair->consumeQ, qpair->consumeQSize, iov, iovSize, bufType, qpair->flags & VMCI_QPFLAG_LOCAL? VMCIMemcpyFromQueueVLocal: VMCIMemcpyFromQueueV, TRUE, !(qpair->flags & VMCI_QPFLAG_NONBLOCK)); if (result == VMCI_ERROR_QUEUEPAIR_NOT_READY) { if (!VMCIQPairWaitForReadyQueue(qpair)) { result = VMCI_ERROR_WOULD_BLOCK; } } } while (result == VMCI_ERROR_QUEUEPAIR_NOT_READY); VMCIQPairUnlock(qpair); return result; } /* *----------------------------------------------------------------------------- * * vmci_qpair_peekv -- * * This is the client interface for peeking into a queue. (I.e., * copy data from the queue without updating the head pointer.) * * Results: * Err, if < 0. * Number of bytes peeked, if >= 0. * * Side effects: * Windows blocking call. * *----------------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_qpair_peekv) ssize_t vmci_qpair_peekv(VMCIQPair *qpair, // IN void *iov, // IN size_t iovSize, // IN int bufType) // IN { ssize_t result; if (!qpair || !iov) { return VMCI_ERROR_INVALID_ARGS; } result = VMCIQPairLock(qpair); if (result != VMCI_SUCCESS) { return result; } do { result = DequeueLocked(qpair->produceQ, qpair->consumeQ, qpair->consumeQSize, iov, iovSize, bufType, qpair->flags & VMCI_QPFLAG_LOCAL? VMCIMemcpyFromQueueVLocal: VMCIMemcpyFromQueueV, FALSE, !(qpair->flags & VMCI_QPFLAG_NONBLOCK)); if (result == VMCI_ERROR_QUEUEPAIR_NOT_READY) { if (!VMCIQPairWaitForReadyQueue(qpair)) { result = VMCI_ERROR_WOULD_BLOCK; } } } while (result == VMCI_ERROR_QUEUEPAIR_NOT_READY); VMCIQPairUnlock(qpair); return result; } #endif /* Systems that support struct iovec */ vmci-only/common/vmciContext.c 0000444 0000000 0000000 00000241042 13432725347 015443 0 ustar root root /********************************************************* * Copyright (C) 2006-2012,2014-2017 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 * *********************************************************/ /* * vmciContext.c -- * * Platform independent routines for VMCI calls. */ #include "vmci_kernel_if.h" #include "vm_assert.h" #include "vmci_defs.h" #include "vmci_infrastructure.h" #include "vmciCommonInt.h" #include "vmciContext.h" #include "vmciDatagram.h" #include "vmciDoorbell.h" #include "vmciDriver.h" #include "vmciEvent.h" #include "vmciKernelAPI.h" #include "vmciQueuePair.h" #if defined(_WIN32) # include "kernelStubsSal.h" #elif defined(VMKERNEL) # include "vmciVmkInt.h" # include "vm_libc.h" # include "helper_ext.h" # include "migrate_defs.h" #endif #define LGPFX "VMCIContext: " static void VMCIContextFreeContext(VMCIContext *context); static Bool VMCIContextExists(VMCIId cid); static int VMCIContextFireNotification(VMCIId contextID, VMCIPrivilegeFlags privFlags); #if defined(VMKERNEL) static void VMCIContextReleaseGuestMemLocked(VMCIContext *context, VMCIGuestMemID gid, Bool powerOff); static void VMCIContextInFilterCleanup(VMCIContext *context); #endif /* * List of current VMCI contexts. */ static struct { VMCIList head; VMCILock lock; VMCILock firingLock; } contextList; /* *---------------------------------------------------------------------- * * VMCIContextSignalNotify -- * * Sets the notify flag to TRUE. Assumes that the context lock is * held. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ static INLINE void VMCIContextSignalNotify(VMCIContext *context) // IN: { #ifndef VMX86_SERVER if (context->notify) { *context->notify = TRUE; } #endif } /* *---------------------------------------------------------------------- * * VMCIContextClearNotify -- * * Sets the notify flag to FALSE. Assumes that the context lock is * held. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ static INLINE void VMCIContextClearNotify(VMCIContext *context) // IN: { #ifndef VMX86_SERVER if (context->notify) { *context->notify = FALSE; } #endif } /* *---------------------------------------------------------------------- * * VMCIContextClearNotifyAndCall -- * * If nothing requires the attention of the guest, clears both * notify flag and call. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ static INLINE void VMCIContextClearNotifyAndCall(VMCIContext *context) // IN: { if (context->pendingDatagrams == 0 && VMCIHandleArray_GetSize(context->pendingDoorbellArray) == 0) { VMCIHost_ClearCall(&context->hostContext); VMCIContextClearNotify(context); } } #ifndef VMX86_SERVER /* *---------------------------------------------------------------------- * * VMCIContext_CheckAndSignalNotify -- * * Sets the context's notify flag iff datagrams are pending for this * context. Called from VMCISetupNotify(). * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ void VMCIContext_CheckAndSignalNotify(VMCIContext *context) // IN: { VMCILockFlags flags; ASSERT(context); VMCI_GrabLock(&context->lock, &flags); if (context->pendingDatagrams) { VMCIContextSignalNotify(context); } VMCI_ReleaseLock(&context->lock, flags); } #endif /* *---------------------------------------------------------------------- * * VMCIContext_Init -- * * Initializes the VMCI context module. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ int VMCIContext_Init(void) { int err; VMCIList_Init(&contextList.head); err = VMCI_InitLock(&contextList.lock, "VMCIContextListLock", VMCI_LOCK_RANK_CONTEXTLIST); if (err < VMCI_SUCCESS) { return err; } err = VMCI_InitLock(&contextList.firingLock, "VMCIContextFiringLock", VMCI_LOCK_RANK_CONTEXTFIRE); if (err < VMCI_SUCCESS) { VMCI_CleanupLock(&contextList.lock); } return err; } /* *---------------------------------------------------------------------- * * VMCIContext_Exit -- * * Cleans up the contexts module. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ void VMCIContext_Exit(void) { VMCI_CleanupLock(&contextList.firingLock); VMCI_CleanupLock(&contextList.lock); } /* *---------------------------------------------------------------------- * * VMCIContext_InitContext -- * * Allocates and initializes a VMCI context. * * Results: * Returns 0 on success, appropriate error code otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ int VMCIContext_InitContext(VMCIId cid, // IN VMCIPrivilegeFlags privFlags, // IN uintptr_t eventHnd, // IN int userVersion, // IN: User's vers no. VMCIHostUser *user, // IN VMCIContext **outContext) // OUT { VMCILockFlags flags; VMCIContext *context; int result; if (privFlags & ~VMCI_PRIVILEGE_ALL_FLAGS) { VMCI_DEBUG_LOG(4, (LGPFX"Invalid flag (flags=0x%x) for VMCI context.\n", privFlags)); return VMCI_ERROR_INVALID_ARGS; } if (userVersion == 0) { return VMCI_ERROR_INVALID_ARGS; } context = VMCI_AllocKernelMem(sizeof *context, VMCI_MEMORY_NONPAGED); if (context == NULL) { VMCI_WARNING((LGPFX"Failed to allocate memory for VMCI context.\n")); return VMCI_ERROR_NO_MEM; } memset(context, 0, sizeof *context); VMCIList_InitEntry(&context->listItem); VMCIList_Init(&context->datagramQueue); context->userVersion = userVersion; context->queuePairArray = VMCIHandleArray_Create(0); if (!context->queuePairArray) { result = VMCI_ERROR_NO_MEM; goto error; } context->doorbellArray = VMCIHandleArray_Create(0); if (!context->doorbellArray) { result = VMCI_ERROR_NO_MEM; goto error; } context->pendingDoorbellArray = VMCIHandleArray_Create(0); if (!context->pendingDoorbellArray) { result = VMCI_ERROR_NO_MEM; goto error; } context->notifierArray = VMCIHandleArray_Create(0); if (context->notifierArray == NULL) { result = VMCI_ERROR_NO_MEM; goto error; } result = VMCI_InitLock(&context->lock, "VMCIContextLock", VMCI_LOCK_RANK_CONTEXT); if (result < VMCI_SUCCESS) { goto error; } Atomic_Write(&context->refCount, 1); #if defined(VMKERNEL) result = VMCIMutex_Init(&context->guestMemMutex, "VMCIGuestMem", VMCI_SEMA_RANK_GUESTMEM); if (result < VMCI_SUCCESS) { VMCI_CleanupLock(&context->lock); goto error; } context->curGuestMemID = INVALID_VMCI_GUEST_MEM_ID; context->inFilters = NULL; #endif /* Inititialize host-specific VMCI context. */ VMCIHost_InitContext(&context->hostContext, eventHnd); context->privFlags = privFlags; /* * If we collide with an existing context we generate a new and use it * instead. The VMX will determine if regeneration is okay. Since there * isn't 4B - 16 VMs running on a given host, the below loop will terminate. */ VMCI_GrabLock(&contextList.lock, &flags); ASSERT(cid != VMCI_INVALID_ID); while (VMCIContextExists(cid)) { /* * If the cid is below our limit and we collide we are creating duplicate * contexts internally so we want to assert fail in that case. */ ASSERT(cid >= VMCI_RESERVED_CID_LIMIT); /* We reserve the lowest 16 ids for fixed contexts. */ cid = MAX(cid, VMCI_RESERVED_CID_LIMIT-1) + 1; if (cid == VMCI_INVALID_ID) { cid = VMCI_RESERVED_CID_LIMIT; } } ASSERT(!VMCIContextExists(cid)); context->cid = cid; context->validUser = user != NULL; if (context->validUser) { context->user = *user; } VMCIList_Insert(&context->listItem, &contextList.head); VMCI_ReleaseLock(&contextList.lock, flags); #ifdef VMKERNEL VMCIContext_SetQuiesceState(context, FALSE, VMCI_INVALID_ID, eventHnd, 0, FALSE); #endif #ifndef VMX86_SERVER context->notify = NULL; # ifdef __linux__ context->notifyPage = NULL; # endif #endif *outContext = context; return VMCI_SUCCESS; error: if (context->notifierArray) { VMCIHandleArray_Destroy(context->notifierArray); } if (context->queuePairArray) { VMCIHandleArray_Destroy(context->queuePairArray); } if (context->doorbellArray) { VMCIHandleArray_Destroy(context->doorbellArray); } if (context->pendingDoorbellArray) { VMCIHandleArray_Destroy(context->pendingDoorbellArray); } VMCI_FreeKernelMem(context, sizeof *context); return result; } /* *---------------------------------------------------------------------- * * VMCIContext_ReleaseContext -- * * Cleans up a VMCI context. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ void VMCIContext_ReleaseContext(VMCIContext *context) // IN { VMCILockFlags flags; /* Dequeue VMCI context. */ VMCI_GrabLock(&contextList.lock, &flags); VMCIList_Remove(&context->listItem); VMCI_ReleaseLock(&contextList.lock, flags); VMCIContext_Release(context); } /* *----------------------------------------------------------------------------- * * VMCIContextFreeContext -- * * Deallocates all parts of a context datastructure. This * functions doesn't lock the context, because it assumes that * the caller is holding the last reference to context. As paged * memory may be freed as part of the call, the function must be * called without holding any spinlocks as this is not allowed on * Windows. * * Results: * None. * * Side effects: * Paged memory is freed. * *----------------------------------------------------------------------------- */ static void VMCIContextFreeContext(VMCIContext *context) // IN { VMCIListItem *curr; VMCIListItem *next; DatagramQueueEntry *dqEntry; VMCIHandle tempHandle; /* Fire event to all contexts interested in knowing this context is dying. */ VMCIContextFireNotification(context->cid, context->privFlags); /* * Cleanup all queue pair resources attached to context. If the VM dies * without cleaning up, this code will make sure that no resources are * leaked. */ tempHandle = VMCIHandleArray_GetEntry(context->queuePairArray, 0); while (!VMCI_HANDLE_EQUAL(tempHandle, VMCI_INVALID_HANDLE)) { if (VMCIQPBroker_Detach(tempHandle, context) < VMCI_SUCCESS) { /* * When VMCIQPBroker_Detach() succeeds it removes the handle from the * array. If detach fails, we must remove the handle ourselves. */ VMCIHandleArray_RemoveEntry(context->queuePairArray, tempHandle); } tempHandle = VMCIHandleArray_GetEntry(context->queuePairArray, 0); } /* * It is fine to destroy this without locking the datagramQueue, as * this is the only thread having a reference to the context. */ VMCIList_ScanSafe(curr, next, &context->datagramQueue) { dqEntry = VMCIList_Entry(curr, DatagramQueueEntry, listItem); VMCIList_Remove(curr); ASSERT(dqEntry && dqEntry->dg); ASSERT(dqEntry->dgSize == VMCI_DG_SIZE(dqEntry->dg)); VMCI_FreeKernelMem(dqEntry->dg, dqEntry->dgSize); VMCI_FreeKernelMem(dqEntry, sizeof *dqEntry); } VMCIHandleArray_Destroy(context->notifierArray); VMCIHandleArray_Destroy(context->queuePairArray); VMCIHandleArray_Destroy(context->doorbellArray); VMCIHandleArray_Destroy(context->pendingDoorbellArray); VMCI_CleanupLock(&context->lock); #if defined(VMKERNEL) VMCIContextInFilterCleanup(context); VMCIMutex_Destroy(&context->guestMemMutex); #endif VMCIHost_ReleaseContext(&context->hostContext); #ifndef VMX86_SERVER # ifdef __linux__ /* TODO Windows and Mac OS. */ VMCIUnsetNotify(context); # endif #endif VMCI_FreeKernelMem(context, sizeof *context); } /* *---------------------------------------------------------------------- * * VMCIContext_PendingDatagrams -- * * Returns the current number of pending datagrams. The call may * also serve as a synchronization point for the datagram queue, * as no enqueue operations can occur concurrently. * * Results: * Length of datagram queue for the given context. * * Side effects: * Locks datagram queue. * *---------------------------------------------------------------------- */ int VMCIContext_PendingDatagrams(VMCIId cid, // IN uint32 *pending) // OUT { VMCIContext *context; VMCILockFlags flags; context = VMCIContext_Get(cid); if (context == NULL) { return VMCI_ERROR_INVALID_ARGS; } VMCI_GrabLock(&context->lock, &flags); if (pending) { *pending = context->pendingDatagrams; } VMCI_ReleaseLock(&context->lock, flags); VMCIContext_Release(context); return VMCI_SUCCESS; } /* *---------------------------------------------------------------------- * * VMCIContext_EnqueueDatagram -- * * Queues a VMCI datagram for the appropriate target VM * context. * * Results: * Size of enqueued data on success, appropriate error code otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ int VMCIContext_EnqueueDatagram(VMCIId cid, // IN: Target VM VMCIDatagram *dg, // IN: Bool notify) // IN: { DatagramQueueEntry *dqEntry; VMCIContext *context; VMCILockFlags flags; VMCIHandle dgSrc; size_t vmciDgSize; ASSERT(dg); vmciDgSize = VMCI_DG_SIZE(dg); ASSERT(vmciDgSize <= VMCI_MAX_DG_SIZE); /* Get the target VM's VMCI context. */ context = VMCIContext_Get(cid); if (context == NULL) { VMCI_DEBUG_LOG(4, (LGPFX"Invalid context (ID=0x%x).\n", cid)); return VMCI_ERROR_INVALID_ARGS; } /* Allocate guest call entry and add it to the target VM's queue. */ dqEntry = VMCI_AllocKernelMem(sizeof *dqEntry, VMCI_MEMORY_NONPAGED); if (dqEntry == NULL) { VMCI_WARNING((LGPFX"Failed to allocate memory for datagram.\n")); VMCIContext_Release(context); return VMCI_ERROR_NO_MEM; } dqEntry->dg = dg; dqEntry->dgSize = vmciDgSize; dgSrc = dg->src; VMCIList_InitEntry(&dqEntry->listItem); VMCI_GrabLock(&context->lock, &flags); #if defined(VMKERNEL) if (context->inFilters != NULL) { if (VMCIFilterDenyDgIn(context->inFilters->filters, dg)) { VMCI_ReleaseLock(&context->lock, flags); VMCIContext_Release(context); VMCI_FreeKernelMem(dqEntry, sizeof *dqEntry); return VMCI_ERROR_NO_ACCESS; } } #endif /* * We put a higher limit on datagrams from the hypervisor. If the pending * datagram is not from hypervisor, then we check if enqueueing it would * exceed the VMCI_MAX_DATAGRAM_QUEUE_SIZE limit on the destination. If the * pending datagram is from hypervisor, we allow it to be queued at the * destination side provided we don't reach the * VMCI_MAX_DATAGRAM_AND_EVENT_QUEUE_SIZE limit. */ if (context->datagramQueueSize + vmciDgSize >= VMCI_MAX_DATAGRAM_QUEUE_SIZE && (!VMCI_HANDLE_EQUAL(dgSrc, VMCI_MAKE_HANDLE(VMCI_HYPERVISOR_CONTEXT_ID, VMCI_CONTEXT_RESOURCE_ID)) || context->datagramQueueSize + vmciDgSize >= VMCI_MAX_DATAGRAM_AND_EVENT_QUEUE_SIZE)) { VMCI_ReleaseLock(&context->lock, flags); VMCIContext_Release(context); VMCI_FreeKernelMem(dqEntry, sizeof *dqEntry); VMCI_DEBUG_LOG(10, (LGPFX"Context (ID=0x%x) receive queue is full.\n", cid)); return VMCI_ERROR_NO_RESOURCES; } VMCIList_Insert(&dqEntry->listItem, &context->datagramQueue); context->pendingDatagrams++; context->datagramQueueSize += vmciDgSize; if (notify) { VMCIContextSignalNotify(context); VMCIHost_SignalCall(&context->hostContext); } VMCI_ReleaseLock(&context->lock, flags); VMCIContext_Release(context); return vmciDgSize; } #undef VMCI_MAX_DATAGRAM_AND_EVENT_QUEUE_SIZE /* *---------------------------------------------------------------------- * * VMCIContextExists -- * * Internal helper to check if a context with the specified context * ID exists. Assumes the contextList.lock is held. * * Results: * TRUE if a context exists with the given cid. * FALSE otherwise * * Side effects: * None. * *---------------------------------------------------------------------- */ static Bool VMCIContextExists(VMCIId cid) // IN { VMCIContext *context; VMCIListItem *next; Bool rv = FALSE; VMCIList_Scan(next, &contextList.head) { context = VMCIList_Entry(next, VMCIContext, listItem); if (context->cid == cid) { rv = TRUE; break; } } return rv; } /* *---------------------------------------------------------------------- * * VMCIContext_Exists -- * * Verifies whether a context with the specified context ID exists. * * Results: * TRUE if a context exists with the given cid. * FALSE otherwise * * Side effects: * None. * *---------------------------------------------------------------------- */ Bool VMCIContext_Exists(VMCIId cid) // IN { VMCILockFlags flags; Bool rv; VMCI_GrabLock(&contextList.lock, &flags); rv = VMCIContextExists(cid); VMCI_ReleaseLock(&contextList.lock, flags); return rv; } /* *---------------------------------------------------------------------- * * VMCIContext_Get -- * * Retrieves VMCI context corresponding to the given cid. * * Results: * VMCI context on success, NULL otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ VMCIContext * VMCIContext_Get(VMCIId cid) // IN { VMCIContext *context = NULL; VMCIListItem *next; VMCILockFlags flags; if (cid == VMCI_INVALID_ID) { return NULL; } VMCI_GrabLock(&contextList.lock, &flags); if (VMCIList_Empty(&contextList.head)) { goto out; } VMCIList_Scan(next, &contextList.head) { context = VMCIList_Entry(next, VMCIContext, listItem); if (context->cid == cid) { /* * At this point, we are sure that the reference count is * larger already than zero. When starting the destruction of * a context, we always remove it from the context list * before decreasing the reference count. As we found the * context here, it hasn't been destroyed yet. This means * that we are not about to increase the reference count of * something that is in the process of being destroyed. */ Atomic_Inc(&context->refCount); break; } } out: VMCI_ReleaseLock(&contextList.lock, flags); return (context && context->cid == cid) ? context : NULL; } /* *---------------------------------------------------------------------- * * VMCIContext_Release -- * * Releases the VMCI context. If this is the last reference to * the context it will be deallocated. A context is created with * a reference count of one, and on destroy, it is removed from * the context list before its reference count is * decremented. Thus, if we reach zero, we are sure that nobody * else are about to increment it (they need the entry in the * context list for that). This function musn't be called with a * lock held. * * Results: * None. * * Side effects: * Paged memory may be deallocated. * *---------------------------------------------------------------------- */ void VMCIContext_Release(VMCIContext *context) // IN { uint32 refCount; ASSERT(context); refCount = Atomic_ReadDec32(&context->refCount); if (refCount == 1) { VMCIContextFreeContext(context); } } /* *---------------------------------------------------------------------- * * VMCIContext_DequeueDatagram -- * * Dequeues the next datagram and returns it to caller. * The caller passes in a pointer to the max size datagram * it can handle and the datagram is only unqueued if the * size is less than maxSize. If larger maxSize is set to * the size of the datagram to give the caller a chance to * set up a larger buffer for the guestcall. * * Results: * On success: 0 if no more pending datagrams, otherwise the size of * the next pending datagram. * On failure: appropriate error code. * * Side effects: * None. * *---------------------------------------------------------------------- */ int VMCIContext_DequeueDatagram(VMCIContext *context, // IN size_t *maxSize, // IN/OUT: max size of datagram caller can handle. VMCIDatagram **dg) // OUT: { DatagramQueueEntry *dqEntry; VMCIListItem *listItem; VMCILockFlags flags; int rv; ASSERT(context && dg); /* Dequeue the next datagram entry. */ VMCI_GrabLock(&context->lock, &flags); if (context->pendingDatagrams == 0) { VMCIContextClearNotifyAndCall(context); VMCI_ReleaseLock(&context->lock, flags); VMCI_DEBUG_LOG(4, (LGPFX"No datagrams pending.\n")); return VMCI_ERROR_NO_MORE_DATAGRAMS; } listItem = VMCIList_First(&context->datagramQueue); ASSERT (listItem != NULL); dqEntry = VMCIList_Entry(listItem, DatagramQueueEntry, listItem); #if defined(_WIN32) _Analysis_assume_(dqEntry != NULL); #endif ASSERT(dqEntry->dg); /* Check size of caller's buffer. */ if (*maxSize < dqEntry->dgSize) { *maxSize = dqEntry->dgSize; VMCI_ReleaseLock(&context->lock, flags); VMCI_DEBUG_LOG(4, (LGPFX"Caller's buffer should be at least " "(size=%u bytes).\n", (uint32)*maxSize)); return VMCI_ERROR_NO_MEM; } VMCIList_Remove(listItem); context->pendingDatagrams--; context->datagramQueueSize -= dqEntry->dgSize; if (context->pendingDatagrams == 0) { VMCIContextClearNotifyAndCall(context); rv = VMCI_SUCCESS; } else { /* * Return the size of the next datagram. */ DatagramQueueEntry *nextEntry; listItem = VMCIList_First(&context->datagramQueue); ASSERT(listItem); nextEntry = VMCIList_Entry(listItem, DatagramQueueEntry, listItem); #if defined(_WIN32) _Analysis_assume_(nextEntry != NULL); #endif ASSERT(nextEntry && nextEntry->dg); /* * The following size_t -> int truncation is fine as the maximum size of * a (routable) datagram is 68KB. */ rv = (int)nextEntry->dgSize; } VMCI_ReleaseLock(&context->lock, flags); /* Caller must free datagram. */ ASSERT(dqEntry->dgSize == VMCI_DG_SIZE(dqEntry->dg)); *dg = dqEntry->dg; dqEntry->dg = NULL; VMCI_FreeKernelMem(dqEntry, sizeof *dqEntry); return rv; } #ifdef VMKERNEL /* *---------------------------------------------------------------------- * * VMCIContext_SetQuiesceState -- * * Set the states related to FSR (quiesced state, migrateCid, * quiesce cause, active event handle). * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ void VMCIContext_SetQuiesceState(VMCIContext *context, // IN Bool isQuiesced, // IN VMCIId migrateCid, // IN uintptr_t eventHnd, // IN uint8 cause, // IN Bool isLocked) // IN { VMCILockFlags flags; if (!context) { return; } if (!isLocked) { VMCI_GrabLock(&context->lock, &flags); } context->isQuiesced = isQuiesced; context->migrateCid = migrateCid; VMCIHost_SetActiveHnd(&context->hostContext, eventHnd); context->quiesceCause = cause == MIGRATE_TYPE_VMOTION ? VMCI_DETACH_VMOTION : VMCI_DETACH_REGULAR; if (!isLocked) { VMCI_ReleaseLock(&context->lock, flags); } } /* *---------------------------------------------------------------------- * * VMCIContext_FindAndUpdateSrcFSR -- * * Find the source context for fast-suspend-resume. If found, the * source context's FSR state is changed to reflect the new active * event handle. * * Results: * If found, source context for fast-suspend-resume, NULL otherwise. * * Side effects: * The source context reference count increased and the caller is * supposed to release the context once it is done using it. * *---------------------------------------------------------------------- */ VMCIContext * VMCIContext_FindAndUpdateSrcFSR(VMCIId migrateCid, // IN uintptr_t eventHnd, // IN uintptr_t *srcEventHnd) // IN/OUT { VMCIContext *contextSrc = VMCIContext_Get(migrateCid); if (contextSrc) { VMCILockFlags flags; VMCI_GrabLock(&contextSrc->lock, &flags); if (contextSrc->isQuiesced && contextSrc->migrateCid == migrateCid) { if (srcEventHnd) { *srcEventHnd = VMCIHost_GetActiveHnd(&contextSrc->hostContext); ASSERT(*srcEventHnd != VMCI_INVALID_ID); } VMCIContext_SetQuiesceState(contextSrc, FALSE, VMCI_INVALID_ID, eventHnd, 0, TRUE); VMCI_ReleaseLock(&contextSrc->lock, flags); return contextSrc; } VMCI_ReleaseLock(&contextSrc->lock, flags); VMCIContext_Release(contextSrc); } return NULL; } /* *---------------------------------------------------------------------- * * VMCIContext_IsActiveHnd -- * * Whether the curent event handle is the active handle. * * Results: * TRUE if the event handle is active, FALSE otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ Bool VMCIContext_IsActiveHnd(VMCIContext *context, // IN uintptr_t eventHnd) // IN { VMCILockFlags flags; Bool isActive; ASSERT(context); VMCI_GrabLock(&context->lock, &flags); isActive = VMCIHost_IsActiveHnd(&context->hostContext, eventHnd); VMCI_ReleaseLock(&context->lock, flags); return isActive; } /* *---------------------------------------------------------------------- * * VMCIContext_GetActiveHnd -- * * Returns the curent event handle. * * Results: * The current active handle. * * Side effects: * None. * *---------------------------------------------------------------------- */ uintptr_t VMCIContext_GetActiveHnd(VMCIContext *context) // IN { VMCILockFlags flags; uintptr_t activeHnd; ASSERT(context); VMCI_GrabLock(&context->lock, &flags); activeHnd = VMCIHost_GetActiveHnd(&context->hostContext); VMCI_ReleaseLock(&context->lock, flags); return activeHnd; } /* *---------------------------------------------------------------------- * * VMCIContext_SetInactiveHnd -- * * Set the handle to be the inactive one. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ void VMCIContext_SetInactiveHnd(VMCIContext *context, // IN uintptr_t eventHnd) // IN { VMCILockFlags flags; ASSERT(context); VMCI_GrabLock(&context->lock, &flags); VMCIHost_SetInactiveHnd(&context->hostContext, eventHnd); VMCI_ReleaseLock(&context->lock, flags); } /* *---------------------------------------------------------------------- * * VMCIContext_RemoveHnd -- * * Remove the event handle from host context. * * Results: * Whether the handle exists and removed, also number of handles * before removal and number of handles after removal. * * Side effects: * If this is active handle, the inactive handle becomes active. * *---------------------------------------------------------------------- */ Bool VMCIContext_RemoveHnd(VMCIContext *context, // IN uintptr_t eventHnd, // IN uint32 *numOld, // OUT uint32 *numNew) // OUT { VMCILockFlags flags; uint32 numHandleOld, numHandleNew; Bool ret; ASSERT(context); VMCI_GrabLock(&context->lock, &flags); numHandleOld = VMCIHost_NumHnds(&context->hostContext); ret = VMCIHost_RemoveHnd(&context->hostContext, eventHnd); numHandleNew = VMCIHost_NumHnds(&context->hostContext); /* * This is needed to prevent FSR to share this * context while this context is being destroyed. */ if (ret && numHandleOld == 1 && numHandleNew == 1) { context->migrateCid = VMCI_INVALID_ID; } VMCI_ReleaseLock(&context->lock, flags); if (numOld) { *numOld = numHandleOld; } if (numNew) { *numNew = numHandleNew; } return ret; } /* *----------------------------------------------------------------------------- * * VMCIContext_ClearDatagrams -- * * Clear pending datagrams. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ void VMCIContext_ClearDatagrams(VMCIContext *context) // IN { int retval; VMCIDatagram *dg = NULL; size_t size = VMCI_MAX_DG_SIZE; uint32 pending; /* Drop all datagrams that are currently pending for given context. */ if (context == NULL) { return; } retval = VMCIContext_PendingDatagrams(context->cid, &pending); if (retval != VMCI_SUCCESS) { /* * This shouldn't happen as we already verified that the context * exists. */ ASSERT(FALSE); return; } /* * We drain the queue for any datagrams pending at the beginning of * the loop. As datagrams may arrive at any point in time, we * cannot guarantee that the queue is empty after this point. Only * removing a fixed number of pending datagrams prevents us from * looping forever. */ while (pending > 0 && VMCIContext_DequeueDatagram(context, &size, &dg) >= 0) { ASSERT(dg); VMCI_FreeKernelMem(dg, VMCI_DG_SIZE(dg)); --pending; } } /* *---------------------------------------------------------------------- * * VMCIContext_SetId -- * * Set the cid of given VMCI context. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ void VMCIContext_SetId(VMCIContext *context, // IN VMCIId cid) // IN: { VMCILockFlags flags; if (!context) { return; } VMCI_GrabLock(&context->lock, &flags); context->cid = cid; VMCI_ReleaseLock(&context->lock, flags); } /* *---------------------------------------------------------------------- * * VMCIContextGenerateEvent -- * * Generates a VMCI event that only takes context ID as event data. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ static void VMCIContextGenerateEvent(VMCIId cid, // IN VMCI_Event event) // IN { VMCIEventMsg *eMsg; VMCIEventPayload_Context *ePayload; /* buf is only 48 bytes. */ char buf[sizeof *eMsg + sizeof *ePayload]; eMsg = (VMCIEventMsg *)buf; ePayload = VMCIEventMsgPayload(eMsg); eMsg->hdr.dst = VMCI_MAKE_HANDLE(VMCI_HOST_CONTEXT_ID, VMCI_EVENT_HANDLER); eMsg->hdr.src = VMCI_MAKE_HANDLE(VMCI_HYPERVISOR_CONTEXT_ID, VMCI_CONTEXT_RESOURCE_ID); eMsg->hdr.payloadSize = sizeof *eMsg + sizeof *ePayload - sizeof eMsg->hdr; eMsg->eventData.event = event; ePayload->contextID = cid; (void)VMCIEvent_Dispatch((VMCIDatagram *)eMsg); } /* *---------------------------------------------------------------------- * * VMCIContext_NotifyGuestPaused -- * * Notify subscribers of a execution state change of the VM * with the given context ID. This will happen when a VM is * quiesced/unquiesced. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ void VMCIContext_NotifyGuestPaused(VMCIId cid, // IN Bool paused) // IN { VMCIContextGenerateEvent(cid, paused ? VMCI_EVENT_GUEST_PAUSED : VMCI_EVENT_GUEST_UNPAUSED); } /* *---------------------------------------------------------------------- * * VMCIContext_NotifyMemoryAccess -- * * Notify subscribers of a memory access change to the device. * This can occur when the device is enabled/disabled/reset. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ void VMCIContext_NotifyMemoryAccess(VMCIId cid, // IN Bool on) // IN { VMCIContextGenerateEvent(cid, on ? VMCI_EVENT_MEM_ACCESS_ON : VMCI_EVENT_MEM_ACCESS_OFF); } #endif /* *---------------------------------------------------------------------- * * VMCIContext_GetId -- * * Retrieves cid of given VMCI context. * * Results: * VMCIId of context on success, VMCI_INVALID_ID otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ VMCIId VMCIContext_GetId(VMCIContext *context) // IN: { if (!context) { return VMCI_INVALID_ID; } ASSERT(context->cid != VMCI_INVALID_ID); return context->cid; } /* *---------------------------------------------------------------------- * * vmci_context_get_priv_flags -- * * Retrieves the privilege flags of the given VMCI context ID. * * Results: * Context's privilege flags. * * Side effects: * None. * *---------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_context_get_priv_flags) VMCIPrivilegeFlags vmci_context_get_priv_flags(VMCIId contextID) // IN { if (VMCI_HostPersonalityActive()) { VMCIPrivilegeFlags flags; VMCIContext *context; context = VMCIContext_Get(contextID); if (!context) { return VMCI_LEAST_PRIVILEGE_FLAGS; } flags = context->privFlags; VMCIContext_Release(context); return flags; } return VMCI_NO_PRIVILEGE_FLAGS; } /* *---------------------------------------------------------------------- * * VMCIContext_AddNotification -- * * Add remoteCID to list of contexts current contexts wants * notifications from/about. * * Results: * VMCI_SUCCESS on success, error code otherwise. * * Side effects: * As in VMCIHandleArray_AppendEntry(). * *---------------------------------------------------------------------- */ int VMCIContext_AddNotification(VMCIId contextID, // IN: VMCIId remoteCID) // IN: { int result = VMCI_ERROR_ALREADY_EXISTS; VMCILockFlags flags; VMCILockFlags firingFlags; VMCIHandle notifierHandle; VMCIContext *context = VMCIContext_Get(contextID); if (context == NULL) { return VMCI_ERROR_NOT_FOUND; } if (VMCI_CONTEXT_IS_VM(contextID) && VMCI_CONTEXT_IS_VM(remoteCID)) { VMCI_DEBUG_LOG(4, (LGPFX"Context removed notifications for other VMs not " "supported (src=0x%x, remote=0x%x).\n", contextID, remoteCID)); result = VMCI_ERROR_DST_UNREACHABLE; goto out; } if (context->privFlags & VMCI_PRIVILEGE_FLAG_RESTRICTED) { result = VMCI_ERROR_NO_ACCESS; goto out; } notifierHandle = VMCI_MAKE_HANDLE(remoteCID, VMCI_EVENT_HANDLER); VMCI_GrabLock(&contextList.firingLock, &firingFlags); VMCI_GrabLock(&context->lock, &flags); if (!VMCIHandleArray_HasEntry(context->notifierArray, notifierHandle)) { VMCIHandleArray_AppendEntry(&context->notifierArray, notifierHandle); result = VMCI_SUCCESS; } VMCI_ReleaseLock(&context->lock, flags); VMCI_ReleaseLock(&contextList.firingLock, firingFlags); out: VMCIContext_Release(context); return result; } /* *---------------------------------------------------------------------- * * VMCIContext_RemoveNotification -- * * Remove remoteCID from current context's list of contexts it is * interested in getting notifications from/about. * * Results: * VMCI_SUCCESS on success, error code otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ int VMCIContext_RemoveNotification(VMCIId contextID, // IN: VMCIId remoteCID) // IN: { VMCILockFlags flags; VMCILockFlags firingFlags; VMCIContext *context = VMCIContext_Get(contextID); VMCIHandle tmpHandle; if (context == NULL) { return VMCI_ERROR_NOT_FOUND; } VMCI_GrabLock(&contextList.firingLock, &firingFlags); VMCI_GrabLock(&context->lock, &flags); tmpHandle = VMCIHandleArray_RemoveEntry(context->notifierArray, VMCI_MAKE_HANDLE(remoteCID, VMCI_EVENT_HANDLER)); VMCI_ReleaseLock(&context->lock, flags); VMCI_ReleaseLock(&contextList.firingLock, firingFlags); VMCIContext_Release(context); if (VMCI_HANDLE_EQUAL(tmpHandle, VMCI_INVALID_HANDLE)) { return VMCI_ERROR_NOT_FOUND; } return VMCI_SUCCESS; } /* *---------------------------------------------------------------------- * * VMCIContextFireNotification -- * * Fire notification for all contexts interested in given cid. * * Results: * VMCI_SUCCESS on success, error code otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ static int VMCIContextFireNotification(VMCIId contextID, // IN VMCIPrivilegeFlags privFlags) // IN { uint32 i, arraySize; VMCIListItem *next; VMCILockFlags flags; VMCILockFlags firingFlags; VMCIHandleArray *subscriberArray; VMCIHandle contextHandle = VMCI_MAKE_HANDLE(contextID, VMCI_EVENT_HANDLER); /* * We create an array to hold the subscribers we find when scanning through * all contexts. */ subscriberArray = VMCIHandleArray_Create(0); if (subscriberArray == NULL) { return VMCI_ERROR_NO_MEM; } /* * Scan all contexts to find who is interested in being notified about * given contextID. We have a special firingLock that we use to synchronize * across all notification operations. This avoids us having to take the * context lock for each HasEntry call and it solves a lock ranking issue. */ VMCI_GrabLock(&contextList.firingLock, &firingFlags); VMCI_GrabLock(&contextList.lock, &flags); VMCIList_Scan(next, &contextList.head) { VMCIContext *subCtx = VMCIList_Entry(next, VMCIContext, listItem); /* * We only deliver notifications of the removal of contexts, if * the two contexts are allowed to interact. */ if (VMCIHandleArray_HasEntry(subCtx->notifierArray, contextHandle) && !VMCIDenyInteraction(privFlags, subCtx->privFlags)) { VMCIHandleArray_AppendEntry(&subscriberArray, VMCI_MAKE_HANDLE(subCtx->cid, VMCI_EVENT_HANDLER)); } } VMCI_ReleaseLock(&contextList.lock, flags); VMCI_ReleaseLock(&contextList.firingLock, firingFlags); /* Fire event to all subscribers. */ arraySize = VMCIHandleArray_GetSize(subscriberArray); for (i = 0; i < arraySize; i++) { int result; VMCIEventMsg *eMsg; VMCIEventPayload_Context *evPayload; char buf[sizeof *eMsg + sizeof *evPayload]; eMsg = (VMCIEventMsg *)buf; /* Clear out any garbage. */ memset(eMsg, 0, sizeof *eMsg + sizeof *evPayload); eMsg->hdr.dst = VMCIHandleArray_GetEntry(subscriberArray, i); eMsg->hdr.src = VMCI_MAKE_HANDLE(VMCI_HYPERVISOR_CONTEXT_ID, VMCI_CONTEXT_RESOURCE_ID); eMsg->hdr.payloadSize = sizeof *eMsg + sizeof *evPayload - sizeof eMsg->hdr; eMsg->eventData.event = VMCI_EVENT_CTX_REMOVED; evPayload = VMCIEventMsgPayload(eMsg); evPayload->contextID = contextID; result = VMCIDatagram_Dispatch(VMCI_HYPERVISOR_CONTEXT_ID, (VMCIDatagram *)eMsg, FALSE); if (result < VMCI_SUCCESS) { VMCI_DEBUG_LOG(4, (LGPFX"Failed to enqueue event datagram " "(type=%d) for context (ID=0x%x).\n", eMsg->eventData.event, eMsg->hdr.dst.context)); /* We continue to enqueue on next subscriber. */ } } VMCIHandleArray_Destroy(subscriberArray); return VMCI_SUCCESS; } /* *---------------------------------------------------------------------- * * VMCIContextDgHypervisorSaveStateSize -- * * Calculate the size for the hypervisor datagram checkpoint * save data. * * The format is as follows: * * uint32 count - number of entries * uint32 size - size of first entry * char bytes[] - contents of first entry * uint32 size - size of second entry * char bytes[] - contents of second entry * ... * * Results: * VMCI_SUCCESS on success, error code otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ static int VMCIContextDgHypervisorSaveStateSize(VMCIContext *context, // IN uint32 *bufSize, // IN/OUT char **cptBufPtr) // UNUSED { uint32 total; VMCIListItem *iter; UNREFERENCED_PARAMETER(cptBufPtr); *bufSize = total = 0; VMCIList_Scan(iter, &context->datagramQueue) { DatagramQueueEntry *dqEntry = VMCIList_Entry(iter, DatagramQueueEntry, listItem); if (dqEntry->dg->src.context == VMCI_HYPERVISOR_CONTEXT_ID) { /* Size of the datagram followed by the contents of the datagram. */ total += sizeof(uint32) + dqEntry->dgSize; } } if (total > 0) { /* Don't forget the datagram count. */ *bufSize = total + sizeof(uint32); } return VMCI_SUCCESS; } /* *---------------------------------------------------------------------- * * VMCIContextDgHypervisorSaveState -- * * Get the hypervisor datagram checkpoint save data. * * Results: * VMCI_SUCCESS on success, error code otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ static int VMCIContextDgHypervisorSaveState(VMCIContext *context, // IN uint32 *bufSize, // IN/OUT char **cptBufPtr) // OUT { uint8 *p; uint32 total; uint32 count; VMCIListItem *iter; /* Need at least the count field and the size of one entry. */ if (*bufSize < sizeof(uint32) * 2) { return VMCI_ERROR_INVALID_ARGS; } p = VMCI_AllocKernelMem(*bufSize, VMCI_MEMORY_NONPAGED); if (p == NULL) { return VMCI_ERROR_NO_MEM; } *cptBufPtr = (char *)p; /* Leave space for the datagram count at the start. */ total = sizeof(uint32); p += sizeof(uint32); count = 0; VMCIList_Scan(iter, &context->datagramQueue) { DatagramQueueEntry *dqEntry = VMCIList_Entry(iter, DatagramQueueEntry, listItem); if (dqEntry->dg->src.context == VMCI_HYPERVISOR_CONTEXT_ID) { /* * VMX might have capped the amount of space we can use to checkpoint * hypervisor datagrams. Respect that here. Those that are not written * to the buffer will get dropped. */ if (total + sizeof(uint32) + dqEntry->dgSize > *bufSize) { break; } total += sizeof(uint32) + dqEntry->dgSize; /* * Write in the size of the datagram followed by the contents of the * datagram itself. */ *(uint32 *)p = dqEntry->dgSize; p += sizeof(uint32); memcpy(p, dqEntry->dg, dqEntry->dgSize); p += dqEntry->dgSize; count++; } } /* Now rollback and write the count at the start of the block. */ *(uint32 *)(*cptBufPtr) = count; return VMCI_SUCCESS; } /* *---------------------------------------------------------------------- * * VMCIContext_GetCheckpointState -- * * Get current context's checkpoint state of given type. * * Results: * VMCI_SUCCESS on success, error code otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ int VMCIContext_GetCheckpointState(VMCIId contextID, // IN: uint32 cptType, // IN: uint32 *bufSize, // IN/OUT: char **cptBufPtr) // OUT: { int i, result; VMCILockFlags flags; uint32 arraySize, cptDataSize; VMCIHandleArray *array; VMCIContext *context; char *cptBuf; Bool getContextID; ASSERT(bufSize && cptBufPtr); context = VMCIContext_Get(contextID); if (context == NULL) { return VMCI_ERROR_NOT_FOUND; } VMCI_GrabLock(&context->lock, &flags); if (cptType == VMCI_NOTIFICATION_CPT_STATE) { ASSERT(context->notifierArray); array = context->notifierArray; getContextID = TRUE; } else if (cptType == VMCI_WELLKNOWN_CPT_STATE) { /* * For compatibility with VMX'en with VM to VM communication, we * always return zero wellknown handles. */ *bufSize = 0; *cptBufPtr = NULL; result = VMCI_SUCCESS; goto release; } else if (cptType == VMCI_DOORBELL_CPT_STATE) { ASSERT(context->doorbellArray); array = context->doorbellArray; getContextID = FALSE; } else if (cptType == VMCI_DG_HYPERVISOR_SAVE_STATE_SIZE) { result = VMCIContextDgHypervisorSaveStateSize(context, bufSize, cptBufPtr); goto release; } else if (cptType == VMCI_DG_HYPERVISOR_SAVE_STATE) { result = VMCIContextDgHypervisorSaveState(context, bufSize, cptBufPtr); goto release; } else { VMCI_DEBUG_LOG(4, (LGPFX"Invalid cpt state (type=%d).\n", cptType)); result = VMCI_ERROR_INVALID_ARGS; goto release; } arraySize = VMCIHandleArray_GetSize(array); if (arraySize > 0) { if (cptType == VMCI_DOORBELL_CPT_STATE) { cptDataSize = arraySize * sizeof(VMCIDoorbellCptState); } else { cptDataSize = arraySize * sizeof(VMCIId); } if (*bufSize < cptDataSize) { *bufSize = cptDataSize; result = VMCI_ERROR_MORE_DATA; goto release; } cptBuf = VMCI_AllocKernelMem(cptDataSize, VMCI_MEMORY_NONPAGED | VMCI_MEMORY_ATOMIC); if (cptBuf == NULL) { result = VMCI_ERROR_NO_MEM; goto release; } for (i = 0; i < arraySize; i++) { VMCIHandle tmpHandle = VMCIHandleArray_GetEntry(array, i); if (cptType == VMCI_DOORBELL_CPT_STATE) { /* * PreFAST thinks this might overflow on arraySize>=2. However, we've * looked *very* carefully at this, tested PreFAST's assumptions, and * concluded PreFAST is getting confused about the relationships between * cptDataSize, arraySize, and i. */ #if defined(_WIN32) #pragma warning(suppress: 6386) #endif ((VMCIDoorbellCptState *)cptBuf)[i].handle = tmpHandle; } else { ((VMCIId *)cptBuf)[i] = getContextID ? tmpHandle.context : tmpHandle.resource; } } *bufSize = cptDataSize; *cptBufPtr = cptBuf; } else { *bufSize = 0; *cptBufPtr = NULL; } result = VMCI_SUCCESS; release: VMCI_ReleaseLock(&context->lock, flags); VMCIContext_Release(context); return result; } /* *---------------------------------------------------------------------- * * VMCIContext_SetCheckpointState -- * * Set current context's checkpoint state of given type. * * Results: * VMCI_SUCCESS on success, error code otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ int VMCIContext_SetCheckpointState(VMCIId contextID, // IN: uint32 cptType, // IN: uint32 bufSize, // IN: char *cptBuf) // IN: { uint32 i; VMCIId currentID; int result = VMCI_SUCCESS; uint32 numIDs = bufSize / sizeof(VMCIId); ASSERT(cptBuf); if (cptType == VMCI_WELLKNOWN_CPT_STATE && numIDs > 0) { /* * We would end up here if VMX with VM to VM communication * attempts to restore a checkpoint with wellknown handles. */ VMCI_WARNING((LGPFX"Attempt to restore checkpoint with obsolete " "wellknown handles.\n")); return VMCI_ERROR_OBSOLETE; } if (cptType != VMCI_NOTIFICATION_CPT_STATE) { VMCI_DEBUG_LOG(4, (LGPFX"Invalid cpt state (type=%d).\n", cptType)); return VMCI_ERROR_INVALID_ARGS; } for (i = 0; i < numIDs && result == VMCI_SUCCESS; i++) { currentID = ((VMCIId *)cptBuf)[i]; result = VMCIContext_AddNotification(contextID, currentID); if (result != VMCI_SUCCESS) { break; } } if (result != VMCI_SUCCESS) { VMCI_DEBUG_LOG(4, (LGPFX"Failed to set cpt state (type=%d) (error=%d).\n", cptType, result)); } return result; } /* *---------------------------------------------------------------------- * * VMCIContext_ReceiveNotificationsGet -- * * Retrieves the specified context's pending notifications in the * form of a handle array. The handle arrays returned are the * actual data - not a copy and should not be modified by the * caller. They must be released using * VMCIContext_ReceiveNotificationsRelease. * * Results: * VMCI_SUCCESS on success, error code otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ int VMCIContext_ReceiveNotificationsGet(VMCIId contextID, // IN VMCIHandleArray **dbHandleArray, // OUT VMCIHandleArray **qpHandleArray) // OUT { VMCIContext *context; VMCILockFlags flags; int result = VMCI_SUCCESS; ASSERT(dbHandleArray && qpHandleArray); context = VMCIContext_Get(contextID); if (context == NULL) { return VMCI_ERROR_NOT_FOUND; } VMCI_GrabLock(&context->lock, &flags); *dbHandleArray = context->pendingDoorbellArray; context->pendingDoorbellArray = VMCIHandleArray_Create(0); if (!context->pendingDoorbellArray) { context->pendingDoorbellArray = *dbHandleArray; *dbHandleArray = NULL; result = VMCI_ERROR_NO_MEM; } *qpHandleArray = NULL; VMCI_ReleaseLock(&context->lock, flags); VMCIContext_Release(context); return result; } /* *---------------------------------------------------------------------- * * VMCIContext_ReceiveNotificationsRelease -- * * Releases handle arrays with pending notifications previously * retrieved using VMCIContext_ReceiveNotificationsGet. If the * notifications were not successfully handed over to the guest, * success must be false. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ void VMCIContext_ReceiveNotificationsRelease(VMCIId contextID, // IN VMCIHandleArray *dbHandleArray, // IN VMCIHandleArray *qpHandleArray, // IN Bool success) // IN { VMCIContext *context = VMCIContext_Get(contextID); if (context) { VMCILockFlags flags; VMCI_GrabLock(&context->lock, &flags); if (!success) { VMCIHandle handle; /* * New notifications may have been added while we were not * holding the context lock, so we transfer any new pending * doorbell notifications to the old array, and reinstate the * old array. */ handle = VMCIHandleArray_RemoveTail(context->pendingDoorbellArray); while (!VMCI_HANDLE_INVALID(handle)) { ASSERT(VMCIHandleArray_HasEntry(context->doorbellArray, handle)); if (!VMCIHandleArray_HasEntry(dbHandleArray, handle)) { VMCIHandleArray_AppendEntry(&dbHandleArray, handle); } handle = VMCIHandleArray_RemoveTail(context->pendingDoorbellArray); } VMCIHandleArray_Destroy(context->pendingDoorbellArray); context->pendingDoorbellArray = dbHandleArray; dbHandleArray = NULL; } else { VMCIContextClearNotifyAndCall(context); } VMCI_ReleaseLock(&context->lock, flags); VMCIContext_Release(context); } else { /* * The OS driver part is holding on to the context for the * duration of the receive notification ioctl, so it should * still be here. */ ASSERT(FALSE); } if (dbHandleArray) { VMCIHandleArray_Destroy(dbHandleArray); } if (qpHandleArray) { VMCIHandleArray_Destroy(qpHandleArray); } } /* *---------------------------------------------------------------------- * * VMCIContext_DoorbellCreate -- * * Registers that a new doorbell handle has been allocated by the * context. Only doorbell handles registered can be notified. * * Results: * VMCI_SUCCESS on success, appropriate error code otherewise. * * Side effects: * None. * *---------------------------------------------------------------------- */ int VMCIContext_DoorbellCreate(VMCIId contextID, // IN VMCIHandle handle) // IN { VMCIContext *context; VMCILockFlags flags; int result; if (contextID == VMCI_INVALID_ID || VMCI_HANDLE_INVALID(handle)) { return VMCI_ERROR_INVALID_ARGS; } context = VMCIContext_Get(contextID); if (context == NULL) { return VMCI_ERROR_NOT_FOUND; } VMCI_GrabLock(&context->lock, &flags); if (!VMCIHandleArray_HasEntry(context->doorbellArray, handle)) { VMCIHandleArray_AppendEntry(&context->doorbellArray, handle); result = VMCI_SUCCESS; } else { result = VMCI_ERROR_DUPLICATE_ENTRY; } VMCI_ReleaseLock(&context->lock, flags); VMCIContext_Release(context); return result; } /* *---------------------------------------------------------------------- * * VMCIContext_DoorbellDestroy -- * * Unregisters a doorbell handle that was previously registered * with VMCIContext_DoorbellCreate. * * Results: * VMCI_SUCCESS on success, appropriate error code otherewise. * * Side effects: * None. * *---------------------------------------------------------------------- */ int VMCIContext_DoorbellDestroy(VMCIId contextID, // IN VMCIHandle handle) // IN { VMCIContext *context; VMCILockFlags flags; VMCIHandle removedHandle; if (contextID == VMCI_INVALID_ID || VMCI_HANDLE_INVALID(handle)) { return VMCI_ERROR_INVALID_ARGS; } context = VMCIContext_Get(contextID); if (context == NULL) { return VMCI_ERROR_NOT_FOUND; } VMCI_GrabLock(&context->lock, &flags); removedHandle = VMCIHandleArray_RemoveEntry(context->doorbellArray, handle); VMCIHandleArray_RemoveEntry(context->pendingDoorbellArray, handle); VMCI_ReleaseLock(&context->lock, flags); VMCIContext_Release(context); if (VMCI_HANDLE_INVALID(removedHandle)) { return VMCI_ERROR_NOT_FOUND; } else { return VMCI_SUCCESS; } } /* *---------------------------------------------------------------------- * * VMCIContext_DoorbellDestroyAll -- * * Unregisters all doorbell handles that were previously * registered with VMCIContext_DoorbellCreate. * * Results: * VMCI_SUCCESS on success, appropriate error code otherewise. * * Side effects: * None. * *---------------------------------------------------------------------- */ int VMCIContext_DoorbellDestroyAll(VMCIId contextID) // IN { VMCIContext *context; VMCILockFlags flags; VMCIHandle removedHandle; if (contextID == VMCI_INVALID_ID) { return VMCI_ERROR_INVALID_ARGS; } context = VMCIContext_Get(contextID); if (context == NULL) { return VMCI_ERROR_NOT_FOUND; } VMCI_GrabLock(&context->lock, &flags); do { removedHandle = VMCIHandleArray_RemoveTail(context->doorbellArray); } while(!VMCI_HANDLE_INVALID(removedHandle)); do { removedHandle = VMCIHandleArray_RemoveTail(context->pendingDoorbellArray); } while(!VMCI_HANDLE_INVALID(removedHandle)); VMCI_ReleaseLock(&context->lock, flags); VMCIContext_Release(context); return VMCI_SUCCESS; } /* *---------------------------------------------------------------------- * * VMCIContext_NotifyDoorbell -- * * Registers a notification of a doorbell handle initiated by the * specified source context. The notification of doorbells are * subject to the same isolation rules as datagram delivery. To * allow host side senders of notifications a finer granularity * of sender rights than those assigned to the sending context * itself, the host context is required to specify a different * set of privilege flags that will override the privileges of * the source context. * * Results: * VMCI_SUCCESS on success, appropriate error code otherewise. * * Side effects: * None. * *---------------------------------------------------------------------- */ int VMCIContext_NotifyDoorbell(VMCIId srcCID, // IN VMCIHandle handle, // IN VMCIPrivilegeFlags srcPrivFlags) // IN { VMCIContext *dstContext; VMCILockFlags flags; int result; if (VMCI_HANDLE_INVALID(handle)) { return VMCI_ERROR_INVALID_ARGS; } /* Get the target VM's VMCI context. */ dstContext = VMCIContext_Get(handle.context); if (dstContext == NULL) { VMCI_DEBUG_LOG(4, (LGPFX"Invalid context (ID=0x%x).\n", handle.context)); return VMCI_ERROR_NOT_FOUND; } if (srcCID != handle.context) { VMCIPrivilegeFlags dstPrivFlags; if (VMCI_CONTEXT_IS_VM(srcCID) && VMCI_CONTEXT_IS_VM(handle.context)) { VMCI_DEBUG_LOG(4, (LGPFX"Doorbell notification from VM to VM not " "supported (src=0x%x, dst=0x%x).\n", srcCID, handle.context)); result = VMCI_ERROR_DST_UNREACHABLE; goto out; } result = VMCIDoorbellGetPrivFlags(handle, &dstPrivFlags); if (result < VMCI_SUCCESS) { VMCI_WARNING((LGPFX"Failed to get privilege flags for destination " "(handle=0x%x:0x%x).\n", handle.context, handle.resource)); goto out; } if (srcCID != VMCI_HOST_CONTEXT_ID || srcPrivFlags == VMCI_NO_PRIVILEGE_FLAGS) { srcPrivFlags = vmci_context_get_priv_flags(srcCID); } if (VMCIDenyInteraction(srcPrivFlags, dstPrivFlags)) { result = VMCI_ERROR_NO_ACCESS; goto out; } } if (handle.context == VMCI_HOST_CONTEXT_ID) { result = VMCIDoorbellHostContextNotify(srcCID, handle); } else { VMCI_GrabLock(&dstContext->lock, &flags); #if defined(VMKERNEL) if (dstContext->inFilters != NULL && VMCIFilterProtoDeny(dstContext->inFilters->filters, handle.resource, VMCI_FP_DOORBELL)) { result = VMCI_ERROR_NO_ACCESS; } else #endif // VMKERNEL if (!VMCIHandleArray_HasEntry(dstContext->doorbellArray, handle)) { result = VMCI_ERROR_NOT_FOUND; } else { if (!VMCIHandleArray_HasEntry(dstContext->pendingDoorbellArray, handle)) { VMCIHandleArray_AppendEntry(&dstContext->pendingDoorbellArray, handle); VMCIContextSignalNotify(dstContext); #if defined(VMKERNEL) VMCIHost_SignalBitmap(&dstContext->hostContext); #else VMCIHost_SignalCall(&dstContext->hostContext); #endif } result = VMCI_SUCCESS; } VMCI_ReleaseLock(&dstContext->lock, flags); } out: VMCIContext_Release(dstContext); return result; } #ifdef VMKERNEL /* *---------------------------------------------------------------------- * * VMCIContext_SignalPendingDoorbells -- * * Signals the guest if any doorbell notifications are * pending. This is used after the VMCI device is unquiesced to * ensure that no pending notifications go unnoticed, since * signals may not be fully processed while the device is * quiesced. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ void VMCIContext_SignalPendingDoorbells(VMCIId contextID) { VMCIContext *context; VMCILockFlags flags; Bool pending; context = VMCIContext_Get(contextID); if (!context) { ASSERT(FALSE); return; } VMCI_GrabLock(&context->lock, &flags); pending = VMCIHandleArray_GetSize(context->pendingDoorbellArray) > 0; VMCI_ReleaseLock(&context->lock, flags); if (pending) { VMCIHost_SignalBitmapAlways(&context->hostContext); } VMCIContext_Release(context); } /* *---------------------------------------------------------------------- * * VMCIContext_SignalPendingDatagrams -- * * Signals the guest if any datagrams are pending. This is used * after the VMCI device is unquiesced to ensure that no pending * datagrams go unnoticed, since signals may not be fully * processed while the device is quiesced. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ void VMCIContext_SignalPendingDatagrams(VMCIId contextID) { Bool pending; VMCIContext *context; VMCILockFlags flags; context = VMCIContext_Get(contextID); if (!context) { ASSERT(FALSE); return; } VMCI_GrabLock(&context->lock, &flags); pending = context->pendingDatagrams; VMCI_ReleaseLock(&context->lock, flags); if (pending) { VMCIHost_SignalCallAlways(&context->hostContext); } VMCIContext_Release(context); } #endif // defined(VMKERNEL) /* *---------------------------------------------------------------------- * * vmci_cid_2_host_vm_id -- * * Maps a context ID to the host specific (process/world) ID * of the VM/VMX. * * Results: * VMCI_SUCCESS on success, error code otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_cid_2_host_vm_id) int vmci_cid_2_host_vm_id(VMCIId contextID, // IN void *hostVmID, // OUT size_t hostVmIDLen) // IN { #if defined(VMKERNEL) VMCIContext *context; VMCIHostVmID vmID; int result; context = VMCIContext_Get(contextID); if (!context) { return VMCI_ERROR_NOT_FOUND; } result = VMCIHost_ContextToHostVmID(&context->hostContext, &vmID); if (result == VMCI_SUCCESS) { if (sizeof vmID == hostVmIDLen) { memcpy(hostVmID, &vmID, hostVmIDLen); } else { result = VMCI_ERROR_INVALID_ARGS; } } VMCIContext_Release(context); return result; #else // !defined(VMKERNEL) UNREFERENCED_PARAMETER(contextID); UNREFERENCED_PARAMETER(hostVmID); UNREFERENCED_PARAMETER(hostVmIDLen); return VMCI_ERROR_UNAVAILABLE; #endif } /* *---------------------------------------------------------------------- * * vmci_is_context_owner -- * * Determines whether a given host OS specific representation of * user is the owner of the VM/VMX. * * Results: * Linux: 1 (true) if hostUser is owner, 0 (false) otherwise. * Other: VMCI_SUCCESS if the hostUser is owner, error code otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_is_context_owner) #if defined(__linux__) && !defined(VMKERNEL) int vmci_is_context_owner(VMCIId contextID, // IN VMCIHostUser uid) // IN { int isOwner = 0; if (VMCI_HostPersonalityActive()) { VMCIContext *context = VMCIContext_Get(contextID); if (context) { if (context->validUser) { if (VMCIHost_CompareUser(&uid, &context->user) == VMCI_SUCCESS) { isOwner = 1; } } VMCIContext_Release(context); } } return isOwner; } #else // !linux || VMKERNEL int vmci_is_context_owner(VMCIId contextID, // IN void *hostUser) // IN { if (VMCI_HostPersonalityActive()) { VMCIContext *context; VMCIHostUser *user = (VMCIHostUser *)hostUser; int retval; if (vmkernel) { return VMCI_ERROR_UNAVAILABLE; } if (!hostUser) { return VMCI_ERROR_INVALID_ARGS; } context = VMCIContext_Get(contextID); if (!context) { return VMCI_ERROR_NOT_FOUND; } if (context->validUser) { retval = VMCIHost_CompareUser(user, &context->user); } else { retval = VMCI_ERROR_UNAVAILABLE; } VMCIContext_Release(context); return retval; } return VMCI_ERROR_UNAVAILABLE; } #endif // !linux || VMKERNEL /* *---------------------------------------------------------------------- * * VMCIContext_SupportsHostQP -- * * Can host QPs be connected to this user process. The answer is * FALSE unless a sufficient version number has previously been set * by this caller. * * Results: * TRUE if context supports host queue pairs, FALSE otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ Bool VMCIContext_SupportsHostQP(VMCIContext *context) // IN: Context structure { #ifdef VMKERNEL return TRUE; #else if (!context || context->userVersion < VMCI_VERSION_HOSTQP) { return FALSE; } return TRUE; #endif } /* *---------------------------------------------------------------------- * * VMCIContext_QueuePairCreate -- * * Registers that a new queue pair handle has been allocated by * the context. * * Results: * VMCI_SUCCESS on success, appropriate error code otherewise. * * Side effects: * None. * *---------------------------------------------------------------------- */ int VMCIContext_QueuePairCreate(VMCIContext *context, // IN: Context structure VMCIHandle handle) // IN { int result; if (context == NULL || VMCI_HANDLE_INVALID(handle)) { return VMCI_ERROR_INVALID_ARGS; } if (!VMCIHandleArray_HasEntry(context->queuePairArray, handle)) { VMCIHandleArray_AppendEntry(&context->queuePairArray, handle); result = VMCI_SUCCESS; } else { result = VMCI_ERROR_DUPLICATE_ENTRY; } return result; } /* *---------------------------------------------------------------------- * * VMCIContext_QueuePairDestroy -- * * Unregisters a queue pair handle that was previously registered * with VMCIContext_QueuePairCreate. * * Results: * VMCI_SUCCESS on success, appropriate error code otherewise. * * Side effects: * None. * *---------------------------------------------------------------------- */ int VMCIContext_QueuePairDestroy(VMCIContext *context, // IN: Context structure VMCIHandle handle) // IN { VMCIHandle removedHandle; if (context == NULL || VMCI_HANDLE_INVALID(handle)) { return VMCI_ERROR_INVALID_ARGS; } removedHandle = VMCIHandleArray_RemoveEntry(context->queuePairArray, handle); if (VMCI_HANDLE_INVALID(removedHandle)) { return VMCI_ERROR_NOT_FOUND; } else { return VMCI_SUCCESS; } } /* *---------------------------------------------------------------------- * * VMCIContext_QueuePairExists -- * * Determines whether a given queue pair handle is registered * with the given context. * * Results: * TRUE, if queue pair is registered with context. FALSE, otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ Bool VMCIContext_QueuePairExists(VMCIContext *context, // IN: Context structure VMCIHandle handle) // IN { Bool result; if (context == NULL || VMCI_HANDLE_INVALID(handle)) { return VMCI_ERROR_INVALID_ARGS; } result = VMCIHandleArray_HasEntry(context->queuePairArray, handle); return result; } /* *---------------------------------------------------------------------- * * VMCIContext_RegisterGuestMem -- * * Tells the context that guest memory is available for * access. This should only be used when unquiescing the VMCI * device of a guest. * * Results: * None. * * Side effects: * Notifies host side endpoints of queue pairs that the queue pairs * can be accessed. * *---------------------------------------------------------------------- */ void VMCIContext_RegisterGuestMem(VMCIContext *context, // IN: Context structure VMCIGuestMemID gid) // IN: Reference to guest { #ifdef VMKERNEL uint32 numQueuePairs; uint32 cur; VMCIMutex_Acquire(&context->guestMemMutex); if (context->curGuestMemID != INVALID_VMCI_GUEST_MEM_ID) { if (context->curGuestMemID != gid) { /* * The guest memory has been registered with a different guest * memory ID. This is possible if we attempt to continue the * execution of the source VMX following a failed FSR. */ VMCIContextReleaseGuestMemLocked(context, context->curGuestMemID, FALSE); } else { /* * When unquiescing the device during a restore sync not part * of an FSR, we will already have registered the guest * memory when creating the device, so we don't need to do it * again. Also, there are no active queue pairs at this * point, so nothing to do. */ ASSERT(VMCIHandleArray_GetSize(context->queuePairArray) == 0); goto out; } } context->curGuestMemID = gid; /* * It is safe to access the queue pair array here, since no changes * to the queuePairArray can take place until after the unquiescing * is complete. */ numQueuePairs = VMCIHandleArray_GetSize(context->queuePairArray); for (cur = 0; cur < numQueuePairs; cur++) { VMCIHandle handle; handle = VMCIHandleArray_GetEntry(context->queuePairArray, cur); if (!VMCI_HANDLE_EQUAL(handle, VMCI_INVALID_HANDLE)) { int res; res = VMCIQPBroker_Map(handle, context, NULL); if (res < VMCI_SUCCESS) { VMCI_WARNING(("Failed to map guest memory for queue pair " "(handle=0x%x:0x%x, res=%d).\n", handle.context, handle.resource, res)); } } } out: VMCIMutex_Release(&context->guestMemMutex); #else UNREFERENCED_PARAMETER(context); UNREFERENCED_PARAMETER(gid); #endif } #ifdef VMKERNEL /* *---------------------------------------------------------------------- * * VMCIContextReleaseGuestMemLocked -- * * A version of VMCIContext_ReleaseGuestMem that assumes that the * guest mem lock is already held. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ static void VMCIContextReleaseGuestMemLocked(VMCIContext *context, // IN: Context structure VMCIGuestMemID gid, // IN: Reference to guest Bool powerOff) // IN: Device going away { uint32 numQueuePairs; uint32 cur; if (powerOff) { VMCIContext_NotifyMemoryAccess(context->cid, FALSE); } /* * It is safe to access the queue pair array here, since no changes * to the queuePairArray can take place when the the quiescing * has been initiated, or when the device is being cleaned up. */ numQueuePairs = VMCIHandleArray_GetSize(context->queuePairArray); for (cur = 0; cur < numQueuePairs; cur++) { VMCIHandle handle; handle = VMCIHandleArray_GetEntry(context->queuePairArray, cur); if (!VMCI_HANDLE_EQUAL(handle, VMCI_INVALID_HANDLE)) { int res; res = VMCIQPBroker_Unmap(handle, context, gid); if (res < VMCI_SUCCESS) { VMCI_WARNING(("Failed to unmap guest memory for queue pair " "(handle=0x%x:0x%x, res=%d).\n", handle.context, handle.resource, res)); } } } } #endif /* *---------------------------------------------------------------------- * * VMCIContext_ReleaseGuestMem -- * * Releases all the contexts references to guest memory, if the * caller identified by the gid was the last one to register the * guest memory. This should only be used when quiescing or * cleaning up the VMCI device of a guest. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ void VMCIContext_ReleaseGuestMem(VMCIContext *context, // IN: Context structure VMCIGuestMemID gid, // IN: Reference to guest Bool powerOff) // IN: Device is going away { #ifdef VMKERNEL VMCIMutex_Acquire(&context->guestMemMutex); if (context->curGuestMemID == gid) { /* * In the case of an FSR, we may have multiple VMX'en * registering and releasing guest memory concurrently. The * common case is that the source will clean up its device state * after a successful FSR, where the destination may already * have registered guest memory. So we only release guest * memory, if this is the same gid, that registered the memory. */ VMCIContextReleaseGuestMemLocked(context, gid, powerOff); context->curGuestMemID = INVALID_VMCI_GUEST_MEM_ID; } VMCIMutex_Release(&context->guestMemMutex); #else UNREFERENCED_PARAMETER(context); UNREFERENCED_PARAMETER(gid); UNREFERENCED_PARAMETER(powerOff); #endif } #if defined(VMKERNEL) /* *---------------------------------------------------------------------- * * VMCIContext_RevalidateMappings -- * * Updates the mappings for all QPs. Should only be called with the VMCI * device lock held. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ Bool VMCIContext_RevalidateMappings(VMCIContext *context) // IN: Context structure { uint32 numQueuePairs; uint32 cur; numQueuePairs = VMCIHandleArray_GetSize(context->queuePairArray); for (cur = 0; cur < numQueuePairs; cur++) { VMCIHandle handle; handle = VMCIHandleArray_GetEntry(context->queuePairArray, cur); if (!VMCI_HANDLE_EQUAL(handle, VMCI_INVALID_HANDLE)) { int res = VMCIQPBroker_Revalidate(handle, context); if (res < VMCI_SUCCESS) { VMCI_WARNING(("Failed to revalidate guest mappings for queue " " pair (handle=0x%x:0x%x, res=%d).\n", handle.context, handle.resource, res)); /* * I have not seen these errors but I do not think they should be * considered fatal. */ if (res != VMCI_ERROR_NOT_FOUND && res != VMCI_ERROR_QUEUEPAIR_NOTATTACHED) { return FALSE; } } } } return TRUE; } /* *---------------------------------------------------------------------- * * VMCIContext_FilterSet -- * * Sets an ingoing (host to guest) filter for the VMCI firewall of the * given context. If a filter list already exists for the given filter * entry, the old entry will be deleted. It is assumed that the list * can be used as is, and that the memory backing it will be freed by the * VMCI Context module once the filter is deleted. * * Results: * VMCI_SUCCESS on success, * VMCI_ERROR_NOT_FOUND if there is no active context linked to the cid, * VMCI_ERROR_INVALID_ARGS if a non-VM cid is specified. * * Side effects: * None. * *---------------------------------------------------------------------- */ int VMCIContext_FilterSet(VMCIId cid, // IN VMCIFilterState *filters) // IN { VMCIContext *context; VMCILockFlags flags; VMCIFilterState *oldState; if (!VMCI_CONTEXT_IS_VM(cid)) { return VMCI_ERROR_INVALID_ARGS; } context = VMCIContext_Get(cid); if (!context) { return VMCI_ERROR_NOT_FOUND; } VMCI_GrabLock(&context->lock, &flags); oldState = context->inFilters; context->inFilters = filters; VMCI_ReleaseLock(&context->lock, flags); if (oldState) { VMCIVMKDevFreeFilterState(oldState); } VMCIContext_Release(context); return VMCI_SUCCESS; } /* *---------------------------------------------------------------------- * * VMCIContextInFilterCleanup -- * * When a context is destroyed, all filters will be deleted. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ static void VMCIContextInFilterCleanup(VMCIContext *context) { if (context->inFilters != NULL) { VMCIVMKDevFreeFilterState(context->inFilters); context->inFilters = NULL; } } /* *---------------------------------------------------------------------- * * VMCI_Uuid2ContextId -- * * Given a running VM's UUID, retrieve the VM's VMCI context ID. * The given UUID is local to the host; it is _not_ the UUID * handed out by VC. It comes from the "bios.uuid" field in the * VMX file. We walk the context list and try to match the given * UUID against each context. If we get a match, we return the * contexts's VMCI ID. * * Results: * VMCI_SUCCESS if found and *contextID contains the CID. * VMCI_ERROR_INVALID_ARGS for bad parameters. * VMCI_ERROR_NOT_FOUND if no match. * * Side effects: * None. * *---------------------------------------------------------------------- */ int VMCI_Uuid2ContextId(const char *uuidString, // IN VMCIId *contextID) // OUT { int err; VMCIListItem *next; VMCILockFlags flags; if (!uuidString || *uuidString == '\0' || !contextID) { return VMCI_ERROR_INVALID_ARGS; } err = VMCI_ERROR_NOT_FOUND; VMCI_GrabLock(&contextList.lock, &flags); VMCIList_Scan(next, &contextList.head) { VMCIContext *context = VMCIList_Entry(next, VMCIContext, listItem); if (VMCIHost_ContextHasUuid(&context->hostContext, uuidString) == VMCI_SUCCESS) { *contextID = context->cid; err = VMCI_SUCCESS; break; } } VMCI_ReleaseLock(&contextList.lock, flags); return err; } #endif // VMKERNEL vmci-only/common/vmciEvent.h 0000444 0000000 0000000 00000002527 13432725347 015110 0 ustar root root /********************************************************* * Copyright (C) 2007 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 * *********************************************************/ /* * vmciEvent.h -- * * Event code for the vmci guest driver */ #ifndef __VMCI_EVENT_H__ #define __VMCI_EVENT_H__ #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMCORE #define INCLUDE_ALLOW_VMKERNEL #include "includeCheck.h" #include "vmci_defs.h" #include "vmci_call_defs.h" int VMCIEvent_Init(void); void VMCIEvent_Exit(void); void VMCIEvent_Sync(void); int VMCIEvent_Dispatch(VMCIDatagram *msg); Bool VMCIEvent_CheckHostCapabilities(void); #endif //__VMCI_EVENT_H__ vmci-only/common/vmciEvent.c 0000444 0000000 0000000 00000051157 13432725347 015106 0 ustar root root /********************************************************* * Copyright (C) 2007-2016 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 * *********************************************************/ /* * vmciEvent.c -- * * VMCI Event code for host and guests. */ #include "vmci_kernel_if.h" #include "vmci_defs.h" #include "vmci_infrastructure.h" #include "vmciEvent.h" #include "vmciKernelAPI.h" #if defined(_WIN32) # include "kernelStubsSal.h" #endif #if defined(VMKERNEL) # include "vmciVmkInt.h" # include "vm_libc.h" # include "helper_ext.h" # include "vmciDriver.h" #else # include "vmciDriver.h" #endif #define LGPFX "VMCIEvent: " #define EVENT_MAGIC 0xEABE0000 typedef struct VMCISubscription { VMCIId id; int refCount; Bool runDelayed; VMCIEvent destroyEvent; VMCI_Event event; VMCI_EventCB callback; void *callbackData; VMCIListItem subscriberListItem; } VMCISubscription; static VMCISubscription *VMCIEventFind(VMCIId subID); static int VMCIEventDeliver(VMCIEventMsg *eventMsg); static int VMCIEventRegisterSubscription(VMCISubscription *sub, VMCI_Event event, uint32 flags, VMCI_EventCB callback, void *callbackData); static VMCISubscription *VMCIEventUnregisterSubscription(VMCIId subID); static VMCIList subscriberArray[VMCI_EVENT_MAX]; static VMCILock subscriberLock; typedef struct VMCIDelayedEventInfo { VMCISubscription *sub; uint8 eventPayload[sizeof(VMCIEventData_Max)]; } VMCIDelayedEventInfo; typedef struct VMCIEventRef { VMCISubscription *sub; VMCIListItem listItem; } VMCIEventRef; /* *---------------------------------------------------------------------- * * VMCIEvent_Init -- * * General init code. * * Results: * VMCI_SUCCESS on success, appropriate error code otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ int VMCIEvent_Init(void) { int i; for (i = 0; i < VMCI_EVENT_MAX; i++) { VMCIList_Init(&subscriberArray[i]); } return VMCI_InitLock(&subscriberLock, "VMCIEventSubscriberLock", VMCI_LOCK_RANK_EVENT); } /* *---------------------------------------------------------------------- * * VMCIEvent_Exit -- * * General exit code. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ void VMCIEvent_Exit(void) { VMCIListItem *iter, *iter2; VMCI_Event e; /* We free all memory at exit. */ for (e = 0; e < VMCI_EVENT_MAX; e++) { VMCIList_ScanSafe(iter, iter2, &subscriberArray[e]) { VMCISubscription *cur; /* * We should never get here because all events should have been * unregistered before we try to unload the driver module. * Also, delayed callbacks could still be firing so this cleanup * would not be safe. * Still it is better to free the memory than not ... so we * leave this code in just in case.... * */ ASSERT(FALSE); cur = VMCIList_Entry(iter, VMCISubscription, subscriberListItem); VMCI_FreeKernelMem(cur, sizeof *cur); } } VMCI_CleanupLock(&subscriberLock); } /* *----------------------------------------------------------------------------- * * VMCIEvent_Sync -- * * Use this as a synchronization point when setting globals, for example, * during device shutdown. * * Results: * TRUE. * * Side effects: * None. * *----------------------------------------------------------------------------- */ void VMCIEvent_Sync(void) { VMCILockFlags lockFlags; VMCI_GrabLock_BH(&subscriberLock, &lockFlags); VMCI_ReleaseLock_BH(&subscriberLock, lockFlags); } /* *----------------------------------------------------------------------------- * * VMCIEvent_CheckHostCapabilities -- * * Verify that the host supports the hypercalls we need. If it does not, * try to find fallback hypercalls and use those instead. * * Results: * TRUE if required hypercalls (or fallback hypercalls) are * supported by the host, FALSE otherwise. * * Side effects: * None. * *----------------------------------------------------------------------------- */ Bool VMCIEvent_CheckHostCapabilities(void) { /* VMCIEvent does not require any hypercalls. */ return TRUE; } /* *----------------------------------------------------------------------------- * * VMCIEventGet -- * * Gets a reference to the given VMCISubscription. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static void VMCIEventGet(VMCISubscription *entry) // IN { ASSERT(entry); entry->refCount++; } /* *----------------------------------------------------------------------------- * * VMCIEventRelease -- * * Releases the given VMCISubscription. * * Results: * None. * * Side effects: * Fires the destroy event if the reference count has gone to zero. * *----------------------------------------------------------------------------- */ static void VMCIEventRelease(VMCISubscription *entry) // IN { ASSERT(entry); ASSERT(entry->refCount > 0); entry->refCount--; if (entry->refCount == 0) { VMCI_SignalEvent(&entry->destroyEvent); } } /* *------------------------------------------------------------------------------ * * EventReleaseCB -- * * Callback to release the event entry reference. It is called by the * VMCI_WaitOnEvent function before it blocks. * * Result: * None. * * Side effects: * None. * *------------------------------------------------------------------------------ */ static int EventReleaseCB(void *clientData) // IN { VMCILockFlags flags; VMCISubscription *sub = (VMCISubscription *)clientData; ASSERT(sub); VMCI_GrabLock_BH(&subscriberLock, &flags); VMCIEventRelease(sub); VMCI_ReleaseLock_BH(&subscriberLock, flags); return 0; } /* *----------------------------------------------------------------------------- * * VMCIEventFind -- * * Find entry. Assumes lock is held. * * Results: * Entry if found, NULL if not. * * Side effects: * Increments the VMCISubscription refcount if an entry is found. * *----------------------------------------------------------------------------- */ static VMCISubscription * VMCIEventFind(VMCIId subID) // IN { VMCIListItem *iter; VMCI_Event e; for (e = 0; e < VMCI_EVENT_MAX; e++) { VMCIList_Scan(iter, &subscriberArray[e]) { VMCISubscription *cur = VMCIList_Entry(iter, VMCISubscription, subscriberListItem); if (cur->id == subID) { VMCIEventGet(cur); return cur; } } } return NULL; } /* *---------------------------------------------------------------------- * * VMCIEventDelayedDispatchCB -- * * Calls the specified callback in a delayed context. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ static void VMCIEventDelayedDispatchCB(void *data) // IN { VMCIDelayedEventInfo *eventInfo; VMCISubscription *sub; VMCI_EventData *ed; VMCILockFlags flags; eventInfo = (VMCIDelayedEventInfo *)data; ASSERT(eventInfo); ASSERT(eventInfo->sub); sub = eventInfo->sub; ed = (VMCI_EventData *)eventInfo->eventPayload; sub->callback(sub->id, ed, sub->callbackData); VMCI_GrabLock_BH(&subscriberLock, &flags); VMCIEventRelease(sub); VMCI_ReleaseLock_BH(&subscriberLock, flags); VMCI_FreeKernelMem(eventInfo, sizeof *eventInfo); } /* *---------------------------------------------------------------------------- * * VMCIEventDeliver -- * * Actually delivers the events to the subscribers. * * Results: * None. * * Side effects: * The callback function for each subscriber is invoked. * *---------------------------------------------------------------------------- */ static int VMCIEventDeliver(VMCIEventMsg *eventMsg) // IN { int err = VMCI_SUCCESS; VMCIListItem *iter; VMCILockFlags flags; VMCIList noDelayList; VMCIList_Init(&noDelayList); ASSERT(eventMsg); VMCI_GrabLock_BH(&subscriberLock, &flags); VMCIList_Scan(iter, &subscriberArray[eventMsg->eventData.event]) { VMCISubscription *cur = VMCIList_Entry(iter, VMCISubscription, subscriberListItem); ASSERT(cur && cur->event == eventMsg->eventData.event); #if defined(_WIN32) _Analysis_assume_(cur != NULL); #endif if (cur->runDelayed) { VMCIDelayedEventInfo *eventInfo; if ((eventInfo = VMCI_AllocKernelMem(sizeof *eventInfo, (VMCI_MEMORY_ATOMIC | VMCI_MEMORY_NONPAGED))) == NULL) { err = VMCI_ERROR_NO_MEM; goto out; } VMCIEventGet(cur); memset(eventInfo, 0, sizeof *eventInfo); memcpy(eventInfo->eventPayload, VMCI_DG_PAYLOAD(eventMsg), (size_t)eventMsg->hdr.payloadSize); eventInfo->sub = cur; err = VMCI_ScheduleDelayedWork(VMCIEventDelayedDispatchCB, eventInfo); if (err != VMCI_SUCCESS) { VMCIEventRelease(cur); VMCI_FreeKernelMem(eventInfo, sizeof *eventInfo); goto out; } } else { VMCIEventRef *eventRef; /* * To avoid possible lock rank voilation when holding * subscriberLock, we construct a local list of * subscribers and release subscriberLock before * invokes the callbacks. This is similar to delayed * callbacks, but callbacks is invoked right away here. */ if ((eventRef = VMCI_AllocKernelMem(sizeof *eventRef, (VMCI_MEMORY_ATOMIC | VMCI_MEMORY_NONPAGED))) == NULL) { err = VMCI_ERROR_NO_MEM; goto out; } VMCIEventGet(cur); eventRef->sub = cur; VMCIList_InitEntry(&eventRef->listItem); VMCIList_Insert(&eventRef->listItem, &noDelayList); } } out: VMCI_ReleaseLock_BH(&subscriberLock, flags); if (!VMCIList_Empty(&noDelayList)) { VMCI_EventData *ed; VMCIListItem *iter2; /* * The below ScanSafe macro makes the analyzer think iter might be NULL and * then dereferenced. */ #if defined(_WIN32) #pragma warning(suppress: 28182) #endif VMCIList_ScanSafe(iter, iter2, &noDelayList) { VMCIEventRef *eventRef = VMCIList_Entry(iter, VMCIEventRef, listItem); VMCISubscription *cur = eventRef->sub; uint8 eventPayload[sizeof(VMCIEventData_Max)]; /* We set event data before each callback to ensure isolation. */ memset(eventPayload, 0, sizeof eventPayload); memcpy(eventPayload, VMCI_DG_PAYLOAD(eventMsg), (size_t)eventMsg->hdr.payloadSize); ed = (VMCI_EventData *)eventPayload; cur->callback(cur->id, ed, cur->callbackData); VMCI_GrabLock_BH(&subscriberLock, &flags); VMCIEventRelease(cur); VMCI_ReleaseLock_BH(&subscriberLock, flags); VMCI_FreeKernelMem(eventRef, sizeof *eventRef); } } return err; } /* *---------------------------------------------------------------------- * * VMCIEvent_Dispatch -- * * Dispatcher for the VMCI_EVENT_RECEIVE datagrams. Calls all * subscribers for given event. * * Results: * VMCI_SUCCESS on success, error code otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ int VMCIEvent_Dispatch(VMCIDatagram *msg) // IN { VMCIEventMsg *eventMsg = (VMCIEventMsg *)msg; ASSERT(msg && msg->src.context == VMCI_HYPERVISOR_CONTEXT_ID && msg->dst.resource == VMCI_EVENT_HANDLER); if (msg->payloadSize < sizeof(VMCI_Event) || msg->payloadSize > sizeof(VMCIEventData_Max)) { return VMCI_ERROR_INVALID_ARGS; } if (!VMCI_EVENT_VALID(eventMsg->eventData.event)) { return VMCI_ERROR_EVENT_UNKNOWN; } VMCIEventDeliver(eventMsg); return VMCI_SUCCESS; } /* *---------------------------------------------------------------------- * * VMCIEventRegisterSubscription -- * * Initialize and add subscription to subscriber list. * * Results: * VMCI_SUCCESS on success, error code otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ static int VMCIEventRegisterSubscription(VMCISubscription *sub, // IN VMCI_Event event, // IN uint32 flags, // IN VMCI_EventCB callback, // IN void *callbackData) // IN { # define VMCI_EVENT_MAX_ATTEMPTS 10 static VMCIId subscriptionID = 0; VMCILockFlags lockFlags; uint32 attempts = 0; int result; Bool success; ASSERT(sub); if (!VMCI_EVENT_VALID(event) || callback == NULL) { VMCI_DEBUG_LOG(4, (LGPFX"Failed to subscribe to event (type=%d) " "(callback=%p) (data=%p).\n", event, callback, callbackData)); return VMCI_ERROR_INVALID_ARGS; } if (vmkernel) { /* * In the vmkernel we defer delivery of events to a helper world. This * makes the event delivery more consistent across hosts and guests with * regard to which locks are held. Memory access and guest paused events * are an exception to this, since clients need to know immediately that * the device memory is disabled (if we delay such events, then clients * may be notified too late). */ if (VMCI_EVENT_MEM_ACCESS_ON == event || VMCI_EVENT_MEM_ACCESS_OFF == event || VMCI_EVENT_GUEST_PAUSED == event || VMCI_EVENT_GUEST_UNPAUSED == event) { /* * Client must expect to get such events synchronously, and should * perform its locking accordingly. If it can't handle this, then * fail. */ if (flags & VMCI_FLAG_EVENT_DELAYED_CB) { return VMCI_ERROR_INVALID_ARGS; } sub->runDelayed = FALSE; } else { sub->runDelayed = TRUE; } } else if (!VMCI_CanScheduleDelayedWork()) { /* * If the platform doesn't support delayed work callbacks then don't * allow registration for them. */ if (flags & VMCI_FLAG_EVENT_DELAYED_CB) { return VMCI_ERROR_INVALID_ARGS; } sub->runDelayed = FALSE; } else { /* * The platform supports delayed work callbacks. Honor the requested * flags */ sub->runDelayed = (flags & VMCI_FLAG_EVENT_DELAYED_CB) ? TRUE : FALSE; } sub->refCount = 1; sub->event = event; sub->callback = callback; sub->callbackData = callbackData; VMCIList_InitEntry(&sub->subscriberListItem); VMCI_GrabLock_BH(&subscriberLock, &lockFlags); /* Check if creation of a new event is allowed. */ if (!VMCI_CanCreate()) { result = VMCI_ERROR_UNAVAILABLE; goto exit; } for (success = FALSE, attempts = 0; success == FALSE && attempts < VMCI_EVENT_MAX_ATTEMPTS; attempts++) { VMCISubscription *existingSub = NULL; /* * We try to get an id a couple of time before claiming we are out of * resources. */ sub->id = ++subscriptionID; /* Test for duplicate id. */ existingSub = VMCIEventFind(sub->id); if (existingSub == NULL) { /* We succeeded if we didn't find a duplicate. */ success = TRUE; } else { VMCIEventRelease(existingSub); } } if (success) { VMCI_CreateEvent(&sub->destroyEvent); VMCIList_Insert(&sub->subscriberListItem, &subscriberArray[event]); result = VMCI_SUCCESS; } else { result = VMCI_ERROR_NO_RESOURCES; } exit: VMCI_ReleaseLock_BH(&subscriberLock, lockFlags); return result; # undef VMCI_EVENT_MAX_ATTEMPTS } /* *---------------------------------------------------------------------- * * VMCIEventUnregisterSubscription -- * * Remove subscription from subscriber list. * * Results: * VMCISubscription when found, NULL otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ static VMCISubscription * VMCIEventUnregisterSubscription(VMCIId subID) // IN { VMCILockFlags flags; VMCISubscription *s; VMCI_GrabLock_BH(&subscriberLock, &flags); s = VMCIEventFind(subID); if (s != NULL) { VMCIEventRelease(s); VMCIList_Remove(&s->subscriberListItem); } VMCI_ReleaseLock_BH(&subscriberLock, flags); if (s != NULL) { VMCI_WaitOnEvent(&s->destroyEvent, EventReleaseCB, s); VMCI_DestroyEvent(&s->destroyEvent); } return s; } /* *---------------------------------------------------------------------- * * vmci_event_subscribe -- * * Subscribe to given event. The callback specified can be fired * in different contexts depending on what flag is specified while * registering. If flags contains VMCI_FLAG_EVENT_NONE then the * callback is fired with the subscriber lock held (and BH context * on the guest). If flags contain VMCI_FLAG_EVENT_DELAYED_CB then * the callback is fired with no locks held in thread context. * This is useful because other VMCIEvent functions can be called, * but it also increases the chances that an event will be dropped. * * Results: * VMCI_SUCCESS on success, error code otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_event_subscribe) int vmci_event_subscribe(VMCI_Event event, // IN #if !defined(__linux__) || defined(VMKERNEL) uint32 flags, // IN #endif // !linux || VMKERNEL VMCI_EventCB callback, // IN void *callbackData, // IN VMCIId *subscriptionID) // OUT { int retval; #if defined(__linux__) && !defined(VMKERNEL) uint32 flags = VMCI_FLAG_EVENT_NONE; #endif // linux && !VMKERNEL VMCISubscription *s = NULL; if (subscriptionID == NULL) { VMCI_DEBUG_LOG(4, (LGPFX"Invalid subscription (NULL).\n")); return VMCI_ERROR_INVALID_ARGS; } s = VMCI_AllocKernelMem(sizeof *s, VMCI_MEMORY_NONPAGED); if (s == NULL) { return VMCI_ERROR_NO_MEM; } retval = VMCIEventRegisterSubscription(s, event, flags, callback, callbackData); if (retval < VMCI_SUCCESS) { VMCI_FreeKernelMem(s, sizeof *s); return retval; } *subscriptionID = s->id; return retval; } /* *---------------------------------------------------------------------- * * vmci_event_unsubscribe -- * * Unsubscribe to given event. Removes it from list and frees it. * Will return callbackData if requested by caller. * * Results: * VMCI_SUCCESS on success, error code otherwise. * * Side effects: * None. * *---------------------------------------------------------------------- */ VMCI_EXPORT_SYMBOL(vmci_event_unsubscribe) int vmci_event_unsubscribe(VMCIId subID) // IN { VMCISubscription *s; /* * Return subscription. At this point we know noone else is accessing * the subscription so we can free it. */ s = VMCIEventUnregisterSubscription(subID); if (s == NULL) { return VMCI_ERROR_NOT_FOUND; } VMCI_FreeKernelMem(s, sizeof *s); return VMCI_SUCCESS; } vmci-only/common/vmciCommonInt.h 0000444 0000000 0000000 00000013523 13432725347 015730 0 ustar root root /********************************************************* * Copyright (C) 2006-2012,2017 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 * *********************************************************/ /* * vmciCommonInt.h -- * * Struct definitions for VMCI internal common code. */ #ifndef _VMCI_COMMONINT_H_ #define _VMCI_COMMONINT_H_ #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMCORE #define INCLUDE_ALLOW_VMKERNEL #include "includeCheck.h" #include "vm_atomic.h" #include "vmci_defs.h" #include "vmci_call_defs.h" #include "vmci_infrastructure.h" #include "vmci_handle_array.h" #include "vmci_kernel_if.h" /* * The DatagramQueueEntry is a queue header for the in-kernel VMCI * datagram queues. It is allocated in non-paged memory, as the * content is accessed while holding a spinlock. The pending datagram * itself may be allocated from paged memory. We shadow the size of * the datagram in the non-paged queue entry as this size is used * while holding the same spinlock as above. */ typedef struct DatagramQueueEntry { VMCIListItem listItem; /* For queuing. */ size_t dgSize; /* Size of datagram. */ VMCIDatagram *dg; /* Pending datagram. */ } DatagramQueueEntry; /* * The VMCIFilterState captures the state of all VMCI filters in one * direction. The ranges array contains all filter list in a single * memory chunk, and the filter list pointers in the VMCIProtoFilters * point into the ranges array. */ typedef struct VMCIFilterState { VMCIProtoFilters filters; VMCIIdRange *ranges; size_t rangesSize; } VMCIFilterState; struct VMCIContext { VMCIListItem listItem; /* For global VMCI list. */ VMCIId cid; Atomic_uint32 refCount; VMCIList datagramQueue; /* Head of per VM queue. */ uint32 pendingDatagrams; size_t datagramQueueSize;/* Size of datagram queue in bytes. */ int userVersion; /* * Version of the code that created * this context; e.g., VMX. */ VMCILock lock; /* * Locks datagramQueue, inFilters, * doorbellArray, pendingDoorbellArray * and notifierArray. */ VMCIHandleArray *queuePairArray; /* * QueuePairs attached to. The array of * handles for queue pairs is accessed * from the code for QP API, and there * it is protected by the QP lock. It * is also accessed from the context * clean up path, which does not * require a lock. VMCILock is not * used to protect the QP array. */ VMCIHandleArray *doorbellArray; /* Doorbells created by context. */ VMCIHandleArray *pendingDoorbellArray; /* Doorbells pending for context. */ VMCIHandleArray *notifierArray; /* Contexts current context is subscribing to. */ VMCIHost hostContext; VMCIPrivilegeFlags privFlags; VMCIHostUser user; Bool validUser; #ifdef VMKERNEL Bool isQuiesced; /* Whether current VM is quiesced */ VMCIId migrateCid; /* The migrate cid if it is migrating */ uint8 quiesceCause; /* Quiesced as part of vMotion? */ VMCIMutex guestMemMutex; /* * Coordinates guest memory * registration/release during FSR. */ VMCIGuestMemID curGuestMemID; /* ID of current registered guest mem */ VMCIFilterState *inFilters; /* Ingoing filters for VMCI traffic. */ #endif #ifndef VMX86_SERVER Bool *notify; /* Notify flag pointer - hosted only. */ # ifdef __linux__ struct page *notifyPage; /* Page backing the notify UVA. */ # endif #endif }; /* *------------------------------------------------------------------------------ * * VMCIDenyInteraction -- * * Utilility function that checks whether two entities are allowed * to interact. If one of them is restricted, the other one must * be trusted. * * Result: * TRUE if the two entities are not allowed to interact. FALSE otherwise. * * Side effects: * None. * *------------------------------------------------------------------------------ */ static INLINE Bool VMCIDenyInteraction(VMCIPrivilegeFlags partOne, // IN VMCIPrivilegeFlags partTwo) // IN { return (((partOne & VMCI_PRIVILEGE_FLAG_RESTRICTED) && !(partTwo & VMCI_PRIVILEGE_FLAG_TRUSTED)) || ((partTwo & VMCI_PRIVILEGE_FLAG_RESTRICTED) && !(partOne & VMCI_PRIVILEGE_FLAG_TRUSTED))); } #endif /* _VMCI_COMMONINT_H_ */ vmci-only/common/vmciRoute.h 0000444 0000000 0000000 00000002565 13432725347 015127 0 ustar root root /********************************************************* * Copyright (C) 2011-2013 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 * *********************************************************/ /* * vmciRoute.h -- * * VMCI Routing. */ #ifndef _VMCI_ROUTE_H_ #define _VMCI_ROUTE_H_ #define INCLUDE_ALLOW_VMMON #define INCLUDE_ALLOW_VMCORE #define INCLUDE_ALLOW_MODULE #define INCLUDE_ALLOW_VMKERNEL #include "includeCheck.h" #include "vmci_defs.h" typedef enum { VMCI_ROUTE_NONE, VMCI_ROUTE_AS_HOST, VMCI_ROUTE_AS_GUEST, } VMCIRoute; int VMCI_Route(VMCIHandle *src, const VMCIHandle *dst, Bool fromGuest, VMCIRoute *route); const char *VMCI_RouteString(VMCIRoute route); #endif // _VMCI_ROUTE_H_ vmci-only/linux/ 0000755 0000000 0000000 00000000000 13432726375 012644 5 ustar root root vmci-only/linux/driver.c 0000644 0000000 0000000 00000214116 13432725347 014306 0 ustar root root /********************************************************* * Copyright (C) 2011-2019 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 * *********************************************************/ /* Must come before any kernel header file */ #include "driver-config.h" #define EXPORT_SYMTAB #include <asm/atomic.h> #include <asm/io.h> #include <linux/file.h> #include <linux/fs.h> #include <linux/init.h> #if defined(__x86_64__) && LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 12) # include <linux/ioctl32.h> /* Use weak: not all kernels export sys_ioctl for use by modules */ asmlinkage __attribute__((weak)) long sys_ioctl(unsigned int fd, unsigned int cmd, unsigned long arg); #endif #include <linux/miscdevice.h> #include <linux/moduleparam.h> #include <linux/poll.h> #include <linux/smp.h> #include "compat_highmem.h" #include "compat_interrupt.h" #include "compat_ioport.h" #include "compat_kernel.h" #include "compat_mm.h" #include "compat_module.h" #include "compat_mutex.h" #include "compat_page.h" #include "compat_pci.h" #include "compat_sched.h" #include "compat_slab.h" #include "compat_uaccess.h" #include "compat_version.h" #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 9) # error "Linux kernels before 2.6.9 are not supported." #endif #include "vm_basic_types.h" #include "vm_device_version.h" #include "vmware.h" #include "driverLog.h" #include "vmci_defs.h" #include "vmci_handle_array.h" #include "vmci_infrastructure.h" #include "vmci_iocontrols.h" #include "vmci_version.h" #include "vmci_kernel_if.h" #include "vmciCommonInt.h" #include "vmciContext.h" #include "vmciDatagram.h" #include "vmciDoorbell.h" #include "vmciDriver.h" #include "vmciEvent.h" #include "vmciKernelAPI.h" #include "vmciQueuePair.h" #include "vmciResource.h" #define LGPFX "VMCI: " #define VMCI_DEVICE_NAME "vmci" #define VMCI_MODULE_NAME "vmci" /* *---------------------------------------------------------------------- * * PCI Device interface -- * * Declarations of types and functions related to the VMCI PCI * device personality. * * *---------------------------------------------------------------------- */ /* * VMCI PCI driver state */ typedef struct vmci_device { compat_mutex_t lock; unsigned int ioaddr; unsigned int ioaddr_size; unsigned int irq; unsigned int intr_type; Bool exclusive_vectors; struct msix_entry msix_entries[VMCI_MAX_INTRS]; Bool enabled; spinlock_t dev_spinlock; atomic_t datagrams_allowed; } vmci_device; static const struct pci_device_id vmci_ids[] = { { PCI_DEVICE(PCI_VENDOR_ID_VMWARE, PCI_DEVICE_ID_VMWARE_VMCI), }, { 0 }, }; static int vmci_probe_device(struct pci_dev *pdev, const struct pci_device_id *id); static void vmci_remove_device(struct pci_dev* pdev); static struct pci_driver vmci_driver = { .name = VMCI_DEVICE_NAME, .id_table = vmci_ids, .probe = vmci_probe_device, .remove = vmci_remove_device, }; #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 19) static compat_irqreturn_t vmci_interrupt(int irq, void *dev_id, struct pt_regs * regs); static compat_irqreturn_t vmci_interrupt_bm(int irq, void *dev_id, struct pt_regs * regs); #else static compat_irqreturn_t vmci_interrupt(int irq, void *dev_id); static compat_irqreturn_t vmci_interrupt_bm(int irq, void *dev_id); #endif static void dispatch_datagrams(unsigned long data); static void process_bitmap(unsigned long data); /* MSI-X has performance problems in < 2.6.19 */ #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 19) # define VMCI_DISABLE_MSIX 0 #else # define VMCI_DISABLE_MSIX 1 #endif /* * Needed by other components of this module. It's okay to have one global * instance of this because there can only ever be one VMCI device. Our * virtual hardware enforces this. */ struct pci_dev *vmci_pdev; static vmci_device vmci_dev; static compat_mod_param_bool vmci_disable_host = 0; static compat_mod_param_bool vmci_disable_guest = 0; static compat_mod_param_bool vmci_disable_msi; static compat_mod_param_bool vmci_disable_msix = VMCI_DISABLE_MSIX; DECLARE_TASKLET(vmci_dg_tasklet, dispatch_datagrams, (unsigned long)&vmci_dev); DECLARE_TASKLET(vmci_bm_tasklet, process_bitmap, (unsigned long)&vmci_dev); /* * Allocate a buffer for incoming datagrams globally to avoid repeated * allocation in the interrupt handler's atomic context. */ static uint8 *data_buffer = NULL; static uint32 data_buffer_size = VMCI_MAX_DG_SIZE; /* * If the VMCI hardware supports the notification bitmap, we allocate * and register a page with the device. */ static uint8 *notification_bitmap; static dma_addr_t notification_base; /* *---------------------------------------------------------------------- * * Host device node interface -- * * Implements VMCI by implementing open/close/ioctl functions * * *---------------------------------------------------------------------- */ /* * Per-instance host state */ typedef struct VMCILinux { VMCIContext *context; int userVersion; VMCIObjType ctType; #if defined(HAVE_COMPAT_IOCTL) || defined(HAVE_UNLOCKED_IOCTL) compat_mutex_t lock; #endif } VMCILinux; /* * Static driver state. */ #define VM_DEVICE_NAME_SIZE 32 #define LINUXLOG_BUFFER_SIZE 1024 typedef struct VMCILinuxState { struct miscdevice misc; char buf[LINUXLOG_BUFFER_SIZE]; atomic_t activeContexts; } VMCILinuxState; static int VMCISetupNotify(VMCIContext *context, VA notifyUVA); static void VMCIUnsetNotifyInt(VMCIContext *context, Bool useLock); static int LinuxDriver_Open(struct inode *inode, struct file *filp); static int LinuxDriver_Ioctl(struct inode *inode, struct file *filp, u_int iocmd, unsigned long ioarg); #if defined(HAVE_COMPAT_IOCTL) || defined(HAVE_UNLOCKED_IOCTL) static long LinuxDriver_UnlockedIoctl(struct file *filp, u_int iocmd, unsigned long ioarg); #endif static int LinuxDriver_Close(struct inode *inode, struct file *filp); static unsigned int LinuxDriverPoll(struct file *file, poll_table *wait); #if defined(HAVE_COMPAT_IOCTL) || defined(HAVE_UNLOCKED_IOCTL) #define LinuxDriverLockIoctlPerFD(mutex) compat_mutex_lock(mutex) #define LinuxDriverUnlockIoctlPerFD(mutex) compat_mutex_unlock(mutex) #else #define LinuxDriverLockIoctlPerFD(mutex) do {} while (0) #define LinuxDriverUnlockIoctlPerFD(mutex) do {} while (0) #endif /* should be const if not for older kernels support */ static struct file_operations vmuser_fops = { .owner = THIS_MODULE, .open = LinuxDriver_Open, .release = LinuxDriver_Close, .poll = LinuxDriverPoll, #ifdef HAVE_UNLOCKED_IOCTL .unlocked_ioctl = LinuxDriver_UnlockedIoctl, #else .ioctl = LinuxDriver_Ioctl, #endif #ifdef HAVE_COMPAT_IOCTL .compat_ioctl = LinuxDriver_UnlockedIoctl, #endif }; static struct VMCILinuxState linuxState = { .misc = { .name = VMCI_DEVICE_NAME, .minor = MISC_DYNAMIC_MINOR, .fops = &vmuser_fops, }, .activeContexts = ATOMIC_INIT(0), }; /* *---------------------------------------------------------------------- * * Shared VMCI device definitions -- * * Types and variables shared by both host and guest personality * * *---------------------------------------------------------------------- */ static Bool guestDeviceInit; static atomic_t guestDeviceActive; static Bool hostDeviceInit; /* *----------------------------------------------------------------------------- * * Host device support -- * * The following functions implement the support for the VMCI * host driver. * * *----------------------------------------------------------------------------- */ #ifdef VM_X86_64 #ifndef HAVE_COMPAT_IOCTL static int LinuxDriver_Ioctl32_Handler(unsigned int fd, unsigned int iocmd, unsigned long ioarg, struct file * filp) { int ret; ret = -ENOTTY; if (filp && filp->f_op && filp->f_op->ioctl == LinuxDriver_Ioctl) { ret = LinuxDriver_Ioctl(filp->f_dentry->d_inode, filp, iocmd, ioarg); } return ret; } #endif /* !HAVE_COMPAT_IOCTL */ static int register_ioctl32_handlers(void) { #ifndef HAVE_COMPAT_IOCTL { int i; for (i = IOCTL_VMCI_FIRST; i < IOCTL_VMCI_LAST; i++) { int retval = register_ioctl32_conversion(i, LinuxDriver_Ioctl32_Handler); if (retval) { Warning(LGPFX"Failed to register ioctl32 conversion " "(cmd=%d,err=%d).\n", i, retval); return retval; } } for (i = IOCTL_VMCI_FIRST2; i < IOCTL_VMCI_LAST2; i++) { int retval = register_ioctl32_conversion(i, LinuxDriver_Ioctl32_Handler); if (retval) { Warning(LGPFX"Failed to register ioctl32 conversion " "(cmd=%d,err=%d).\n", i, retval); return retval; } } } #endif /* !HAVE_COMPAT_IOCTL */ return 0; } static void unregister_ioctl32_handlers(void) { #ifndef HAVE_COMPAT_IOCTL { int i; for (i = IOCTL_VMCI_FIRST; i < IOCTL_VMCI_LAST; i++) { int retval = unregister_ioctl32_conversion(i); if (retval) { Warning(LGPFX"Failed to unregister ioctl32 conversion " "(cmd=%d,err=%d).\n", i, retval); } } for (i = IOCTL_VMCI_FIRST2; i < IOCTL_VMCI_LAST2; i++) { int retval = unregister_ioctl32_conversion(i); if (retval) { Warning(LGPFX"Failed to unregister ioctl32 conversion " "(cmd=%d,err=%d).\n", i, retval); } } } #endif /* !HAVE_COMPAT_IOCTL */ } #else /* VM_X86_64 */ #define register_ioctl32_handlers() (0) #define unregister_ioctl32_handlers() do { } while (0) #endif /* VM_X86_64 */ /* *----------------------------------------------------------------------------- * * vmci_host_init -- * * Initializes the VMCI host device driver. * * Results: * 0 on success, other error codes on failure. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static int vmci_host_init(void) { int error; if (VMCI_HostInit() < VMCI_SUCCESS) { return -ENOMEM; } error = misc_register(&linuxState.misc); if (error) { Warning(LGPFX "Module registration error " "(name=%s, major=%d, minor=%d, err=%d).\n", linuxState.misc.name, MISC_MAJOR, linuxState.misc.minor, error); goto err_host_cleanup; } error = register_ioctl32_handlers(); if (error) { Warning(LGPFX "Failed to register ioctl32 handlers, err: %d\n", error); goto err_misc_unregister; } Log(LGPFX "Module registered (name=%s, major=%d, minor=%d).\n", linuxState.misc.name, MISC_MAJOR, linuxState.misc.minor); return 0; err_misc_unregister: misc_deregister(&linuxState.misc); err_host_cleanup: VMCI_HostCleanup(); return error; } /* *---------------------------------------------------------------------- * * LinuxDriver_Open -- * * Called on open of /dev/vmci. * * Side effects: * Increment use count used to determine eventual deallocation of * the module * *---------------------------------------------------------------------- */ static int LinuxDriver_Open(struct inode *inode, // IN struct file *filp) // IN { VMCILinux *vmciLinux; vmciLinux = kmalloc(sizeof *vmciLinux, GFP_KERNEL); if (vmciLinux == NULL) { return -ENOMEM; } memset(vmciLinux, 0, sizeof *vmciLinux); vmciLinux->ctType = VMCIOBJ_NOT_SET; vmciLinux->userVersion = 0; #if defined(HAVE_COMPAT_IOCTL) || defined(HAVE_UNLOCKED_IOCTL) compat_mutex_init(&vmciLinux->lock); #endif filp->private_data = vmciLinux; return 0; } /* *---------------------------------------------------------------------- * * LinuxDriver_Close -- * * Called on close of /dev/vmci, most often when the process * exits. * *---------------------------------------------------------------------- */ static int LinuxDriver_Close(struct inode *inode, // IN struct file *filp) // IN { VMCILinux *vmciLinux; vmciLinux = (VMCILinux *)filp->private_data; ASSERT(vmciLinux); if (vmciLinux->ctType == VMCIOBJ_CONTEXT) { ASSERT(vmciLinux->context); VMCIContext_ReleaseContext(vmciLinux->context); vmciLinux->context = NULL; /* * The number of active contexts is used to track whether any * VMX'en are using the host personality. It is incremented when * a context is created through the IOCTL_VMCI_INIT_CONTEXT * ioctl. */ atomic_dec(&linuxState.activeContexts); } vmciLinux->ctType = VMCIOBJ_NOT_SET; kfree(vmciLinux); filp->private_data = NULL; return 0; } /* *---------------------------------------------------------------------- * * LinuxDriverPoll -- * * This is used to wake up the VMX when a VMCI call arrives, or * to wake up select() or poll() at the next clock tick. * *---------------------------------------------------------------------- */ static unsigned int LinuxDriverPoll(struct file *filp, poll_table *wait) { VMCILockFlags flags; VMCILinux *vmciLinux = (VMCILinux *) filp->private_data; unsigned int mask = 0; if (vmciLinux->ctType == VMCIOBJ_CONTEXT) { ASSERT(vmciLinux->context != NULL); /* * Check for VMCI calls to this VM context. */ if (wait != NULL) { poll_wait(filp, &vmciLinux->context->hostContext.waitQueue, wait); } VMCI_GrabLock(&vmciLinux->context->lock, &flags); if (vmciLinux->context->pendingDatagrams > 0 || VMCIHandleArray_GetSize(vmciLinux->context->pendingDoorbellArray) > 0) { mask = POLLIN; } VMCI_ReleaseLock(&vmciLinux->context->lock, flags); } return mask; } /* *---------------------------------------------------------------------- * * VMCICopyHandleArrayToUser -- * * Copies the handles of a handle array into a user buffer, and * returns the new length in userBufferSize. If the copy to the * user buffer fails, the functions still returns VMCI_SUCCESS, * but retval != 0. * *---------------------------------------------------------------------- */ static int VMCICopyHandleArrayToUser(void *userBufUVA, // IN uint64 *userBufSize, // IN/OUT VMCIHandleArray *handleArray, // IN int *retval) // IN { uint32 arraySize; VMCIHandle *handles; if (handleArray) { arraySize = VMCIHandleArray_GetSize(handleArray); } else { arraySize = 0; } if (arraySize * sizeof *handles > *userBufSize) { return VMCI_ERROR_MORE_DATA; } *userBufSize = arraySize * sizeof *handles; if (*userBufSize) { *retval = copy_to_user(userBufUVA, VMCIHandleArray_GetHandles(handleArray), *userBufSize); } return VMCI_SUCCESS; } /* *----------------------------------------------------------------------------- * * VMCIDoQPBrokerAlloc -- * * Helper function for creating queue pair and copying the result * to user memory. * * Results: * 0 if result value was copied to user memory, -EFAULT otherwise. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static int VMCIDoQPBrokerAlloc(VMCIHandle handle, VMCIId peer, uint32 flags, uint64 produceSize, uint64 consumeSize, QueuePairPageStore *pageStore, VMCIContext *context, Bool vmToVm, void *resultUVA) { int result; int retval; VMCIContext_GetId(context); result = VMCIQPBroker_Alloc(handle, peer, flags, VMCI_NO_PRIVILEGE_FLAGS, produceSize, consumeSize, pageStore, context); if (result == VMCI_SUCCESS && vmToVm) { result = VMCI_SUCCESS_QUEUEPAIR_CREATE; } retval = copy_to_user(resultUVA, &result, sizeof result); if (retval) { retval = -EFAULT; if (result >= VMCI_SUCCESS) { result = VMCIQPBroker_Detach(handle, context); ASSERT(result >= VMCI_SUCCESS); } } return retval; } /* *----------------------------------------------------------------------------- * * LinuxDriver_Ioctl -- * * Main path for UserRPC * * Results: * * Side effects: * None. * *----------------------------------------------------------------------------- */ static int LinuxDriver_Ioctl(struct inode *inode, struct file *filp, u_int iocmd, unsigned long ioarg) { VMCILinux *vmciLinux = (VMCILinux *) filp->private_data; int retval = 0; switch (iocmd) { case IOCTL_VMCI_VERSION2: { int verFromUser; if (copy_from_user(&verFromUser, (void *)ioarg, sizeof verFromUser)) { retval = -EFAULT; break; } vmciLinux->userVersion = verFromUser; } /* Fall through. */ case IOCTL_VMCI_VERSION: /* * The basic logic here is: * * If the user sends in a version of 0 tell it our version. * If the user didn't send in a version, tell it our version. * If the user sent in an old version, tell it -its- version. * If the user sent in an newer version, tell it our version. * * The rationale behind telling the caller its version is that * Workstation 6.5 required that VMX and VMCI kernel module were * version sync'd. All new VMX users will be programmed to * handle the VMCI kernel module version. */ if (vmciLinux->userVersion > 0 && vmciLinux->userVersion < VMCI_VERSION_HOSTQP) { retval = vmciLinux->userVersion; } else { retval = VMCI_VERSION; } break; case IOCTL_VMCI_INIT_CONTEXT: { VMCIInitBlock initBlock; VMCIHostUser user; retval = copy_from_user(&initBlock, (void *)ioarg, sizeof initBlock); if (retval != 0) { Log(LGPFX"Error reading init block.\n"); retval = -EFAULT; break; } LinuxDriverLockIoctlPerFD(&vmciLinux->lock); if (vmciLinux->ctType != VMCIOBJ_NOT_SET) { Log(LGPFX"Received VMCI init on initialized handle.\n"); retval = -EINVAL; goto init_release; } if (initBlock.flags & ~VMCI_PRIVILEGE_FLAG_RESTRICTED) { Log(LGPFX"Unsupported VMCI restriction flag.\n"); retval = -EINVAL; goto init_release; } user = current_uid(); retval = VMCIContext_InitContext(initBlock.cid, initBlock.flags, 0 /* Unused */, vmciLinux->userVersion, &user, &vmciLinux->context); if (retval < VMCI_SUCCESS) { Log(LGPFX"Error initializing context.\n"); retval = retval == VMCI_ERROR_DUPLICATE_ENTRY ? -EEXIST : -EINVAL; goto init_release; } /* * Copy cid to userlevel, we do this to allow the VMX to enforce its * policy on cid generation. */ initBlock.cid = VMCIContext_GetId(vmciLinux->context); retval = copy_to_user((void *)ioarg, &initBlock, sizeof initBlock); if (retval != 0) { VMCIContext_ReleaseContext(vmciLinux->context); vmciLinux->context = NULL; Log(LGPFX"Error writing init block.\n"); retval = -EFAULT; goto init_release; } ASSERT(initBlock.cid != VMCI_INVALID_ID); vmciLinux->ctType = VMCIOBJ_CONTEXT; atomic_inc(&linuxState.activeContexts); init_release: LinuxDriverUnlockIoctlPerFD(&vmciLinux->lock); break; } case IOCTL_VMCI_DATAGRAM_SEND: { VMCIDatagramSendRecvInfo sendInfo; VMCIDatagram *dg = NULL; VMCIId cid; if (vmciLinux->ctType != VMCIOBJ_CONTEXT) { Warning(LGPFX"Ioctl only valid for context handle (iocmd=%d).\n", iocmd); retval = -EINVAL; break; } retval = copy_from_user(&sendInfo, (void *) ioarg, sizeof sendInfo); if (retval) { Warning(LGPFX"copy_from_user failed.\n"); retval = -EFAULT; break; } if (sendInfo.len > VMCI_MAX_DG_SIZE) { Warning(LGPFX"Datagram too big (size=%d).\n", sendInfo.len); retval = -EINVAL; break; } if (sendInfo.len < sizeof *dg) { Warning(LGPFX"Datagram too small (size=%d).\n", sendInfo.len); retval = -EINVAL; break; } dg = VMCI_AllocKernelMem(sendInfo.len, VMCI_MEMORY_NORMAL); if (dg == NULL) { Log(LGPFX"Cannot allocate memory to dispatch datagram.\n"); retval = -ENOMEM; break; } retval = copy_from_user(dg, (char *)(VA)sendInfo.addr, sendInfo.len); if (retval != 0) { Log(LGPFX"Error getting datagram (err=%d).\n", retval); VMCI_FreeKernelMem(dg, sendInfo.len); retval = -EFAULT; break; } VMCI_DEBUG_LOG(10, (LGPFX"Datagram dst (handle=0x%x:0x%x) src " "(handle=0x%x:0x%x), payload (size=%"FMT64"u " "bytes).\n", dg->dst.context, dg->dst.resource, dg->src.context, dg->src.resource, dg->payloadSize)); /* Get source context id. */ ASSERT(vmciLinux->context); cid = VMCIContext_GetId(vmciLinux->context); ASSERT(cid != VMCI_INVALID_ID); sendInfo.result = VMCIDatagram_Dispatch(cid, dg, TRUE); VMCI_FreeKernelMem(dg, sendInfo.len); retval = copy_to_user((void *)ioarg, &sendInfo, sizeof sendInfo); break; } case IOCTL_VMCI_DATAGRAM_RECEIVE: { VMCIDatagramSendRecvInfo recvInfo; VMCIDatagram *dg = NULL; size_t size; if (vmciLinux->ctType != VMCIOBJ_CONTEXT) { Warning(LGPFX"Ioctl only valid for context handle (iocmd=%d).\n", iocmd); retval = -EINVAL; break; } retval = copy_from_user(&recvInfo, (void *) ioarg, sizeof recvInfo); if (retval) { Warning(LGPFX"copy_from_user failed.\n"); retval = -EFAULT; break; } ASSERT(vmciLinux->ctType == VMCIOBJ_CONTEXT); size = recvInfo.len; ASSERT(vmciLinux->context); recvInfo.result = VMCIContext_DequeueDatagram(vmciLinux->context, &size, &dg); if (recvInfo.result >= VMCI_SUCCESS) { ASSERT(dg); retval = copy_to_user((void *) ((uintptr_t) recvInfo.addr), dg, VMCI_DG_SIZE(dg)); VMCI_FreeKernelMem(dg, VMCI_DG_SIZE(dg)); if (retval != 0) { break; } } retval = copy_to_user((void *)ioarg, &recvInfo, sizeof recvInfo); break; } case IOCTL_VMCI_QUEUEPAIR_ALLOC: { if (vmciLinux->ctType != VMCIOBJ_CONTEXT) { Log(LGPFX"IOCTL_VMCI_QUEUEPAIR_ALLOC only valid for contexts.\n"); retval = -EINVAL; break; } if (vmciLinux->userVersion < VMCI_VERSION_NOVMVM) { VMCIQueuePairAllocInfo_VMToVM queuePairAllocInfo; VMCIQueuePairAllocInfo_VMToVM *info = (VMCIQueuePairAllocInfo_VMToVM *)ioarg; retval = copy_from_user(&queuePairAllocInfo, (void *)ioarg, sizeof queuePairAllocInfo); if (retval) { retval = -EFAULT; break; } retval = VMCIDoQPBrokerAlloc(queuePairAllocInfo.handle, queuePairAllocInfo.peer, queuePairAllocInfo.flags, queuePairAllocInfo.produceSize, queuePairAllocInfo.consumeSize, NULL, vmciLinux->context, TRUE, // VM to VM style create &info->result); } else { VMCIQueuePairAllocInfo queuePairAllocInfo; VMCIQueuePairAllocInfo *info = (VMCIQueuePairAllocInfo *)ioarg; QueuePairPageStore pageStore; retval = copy_from_user(&queuePairAllocInfo, (void *)ioarg, sizeof queuePairAllocInfo); if (retval) { retval = -EFAULT; break; } pageStore.pages = queuePairAllocInfo.ppnVA; pageStore.len = queuePairAllocInfo.numPPNs; retval = VMCIDoQPBrokerAlloc(queuePairAllocInfo.handle, queuePairAllocInfo.peer, queuePairAllocInfo.flags, queuePairAllocInfo.produceSize, queuePairAllocInfo.consumeSize, &pageStore, vmciLinux->context, FALSE, // Not VM to VM style create &info->result); } break; } case IOCTL_VMCI_QUEUEPAIR_SETVA: { VMCIQueuePairSetVAInfo setVAInfo; VMCIQueuePairSetVAInfo *info = (VMCIQueuePairSetVAInfo *)ioarg; int32 result; if (vmciLinux->ctType != VMCIOBJ_CONTEXT) { Log(LGPFX"IOCTL_VMCI_QUEUEPAIR_SETVA only valid for contexts.\n"); retval = -EINVAL; break; } if (vmciLinux->userVersion < VMCI_VERSION_NOVMVM) { Log(LGPFX"IOCTL_VMCI_QUEUEPAIR_SETVA not supported for this VMX version.\n"); retval = -EINVAL; break; } retval = copy_from_user(&setVAInfo, (void *)ioarg, sizeof setVAInfo); if (retval) { retval = -EFAULT; break; } if (setVAInfo.va) { /* * VMX is passing down a new VA for the queue pair mapping. */ result = VMCIQPBroker_Map(setVAInfo.handle, vmciLinux->context, setVAInfo.va); } else { /* * The queue pair is about to be unmapped by the VMX. */ result = VMCIQPBroker_Unmap(setVAInfo.handle, vmciLinux->context, 0); } retval = copy_to_user(&info->result, &result, sizeof result); if (retval) { retval = -EFAULT; } break; } case IOCTL_VMCI_QUEUEPAIR_SETPAGEFILE: { VMCIQueuePairPageFileInfo pageFileInfo; VMCIQueuePairPageFileInfo *info = (VMCIQueuePairPageFileInfo *)ioarg; int32 result; if (vmciLinux->userVersion < VMCI_VERSION_HOSTQP || vmciLinux->userVersion >= VMCI_VERSION_NOVMVM) { Log(LGPFX"IOCTL_VMCI_QUEUEPAIR_SETPAGEFILE not supported this VMX " "(version=%d).\n", vmciLinux->userVersion); retval = -EINVAL; break; } if (vmciLinux->ctType != VMCIOBJ_CONTEXT) { Log(LGPFX"IOCTL_VMCI_QUEUEPAIR_SETPAGEFILE only valid for contexts.\n"); retval = -EINVAL; break; } retval = copy_from_user(&pageFileInfo, (void *)ioarg, sizeof *info); if (retval) { retval = -EFAULT; break; } /* * Communicate success pre-emptively to the caller. Note that * the basic premise is that it is incumbent upon the caller not * to look at the info.result field until after the ioctl() * returns. And then, only if the ioctl() result indicates no * error. We send up the SUCCESS status before calling * SetPageStore() store because failing to copy up the result * code means unwinding the SetPageStore(). * * It turns out the logic to unwind a SetPageStore() opens a can * of worms. For example, if a host had created the QueuePair * and a guest attaches and SetPageStore() is successful but * writing success fails, then ... the host has to be stopped * from writing (anymore) data into the QueuePair. That means * an additional test in the VMCI_Enqueue() code path. Ugh. */ result = VMCI_SUCCESS; retval = copy_to_user(&info->result, &result, sizeof result); if (retval == 0) { result = VMCIQPBroker_SetPageStore(pageFileInfo.handle, pageFileInfo.produceVA, pageFileInfo.consumeVA, vmciLinux->context); if (result < VMCI_SUCCESS) { retval = copy_to_user(&info->result, &result, sizeof result); if (retval != 0) { /* * Note that in this case the SetPageStore() call * failed but we were unable to communicate that to the * caller (because the copy_to_user() call failed). * So, if we simply return an error (in this case * -EFAULT) then the caller will know that the * SetPageStore failed even though we couldn't put the * result code in the result field and indicate exactly * why it failed. * * That says nothing about the issue where we were once * able to write to the caller's info memory and now * can't. Something more serious is probably going on * than the fact that SetPageStore() didn't work. */ retval = -EFAULT; } } } else { /* * In this case, we can't write a result field of the * caller's info block. So, we don't even try to * SetPageStore(). */ retval = -EFAULT; } break; } case IOCTL_VMCI_QUEUEPAIR_DETACH: { VMCIQueuePairDetachInfo detachInfo; VMCIQueuePairDetachInfo *info = (VMCIQueuePairDetachInfo *)ioarg; int32 result; if (vmciLinux->ctType != VMCIOBJ_CONTEXT) { Log(LGPFX"IOCTL_VMCI_QUEUEPAIR_DETACH only valid for contexts.\n"); retval = -EINVAL; break; } retval = copy_from_user(&detachInfo, (void *)ioarg, sizeof detachInfo); if (retval) { retval = -EFAULT; break; } result = VMCIQPBroker_Detach(detachInfo.handle, vmciLinux->context); if (result == VMCI_SUCCESS && vmciLinux->userVersion < VMCI_VERSION_NOVMVM) { result = VMCI_SUCCESS_LAST_DETACH; } retval = copy_to_user(&info->result, &result, sizeof result); if (retval) { retval = -EFAULT; } break; } case IOCTL_VMCI_CTX_ADD_NOTIFICATION: { VMCINotifyAddRemoveInfo arInfo; VMCINotifyAddRemoveInfo *info = (VMCINotifyAddRemoveInfo *)ioarg; int32 result; VMCIId cid; if (vmciLinux->ctType != VMCIOBJ_CONTEXT) { Log(LGPFX"IOCTL_VMCI_CTX_ADD_NOTIFICATION only valid for contexts.\n"); retval = -EINVAL; break; } retval = copy_from_user(&arInfo, (void *)ioarg, sizeof arInfo); if (retval) { retval = -EFAULT; break; } cid = VMCIContext_GetId(vmciLinux->context); result = VMCIContext_AddNotification(cid, arInfo.remoteCID); retval = copy_to_user(&info->result, &result, sizeof result); if (retval) { retval = -EFAULT; break; } break; } case IOCTL_VMCI_CTX_REMOVE_NOTIFICATION: { VMCINotifyAddRemoveInfo arInfo; VMCINotifyAddRemoveInfo *info = (VMCINotifyAddRemoveInfo *)ioarg; int32 result; VMCIId cid; if (vmciLinux->ctType != VMCIOBJ_CONTEXT) { Log(LGPFX"IOCTL_VMCI_CTX_REMOVE_NOTIFICATION only valid for " "contexts.\n"); retval = -EINVAL; break; } retval = copy_from_user(&arInfo, (void *)ioarg, sizeof arInfo); if (retval) { retval = -EFAULT; break; } cid = VMCIContext_GetId(vmciLinux->context); result = VMCIContext_RemoveNotification(cid, arInfo.remoteCID); retval = copy_to_user(&info->result, &result, sizeof result); if (retval) { retval = -EFAULT; break; } break; } case IOCTL_VMCI_CTX_GET_CPT_STATE: { VMCICptBufInfo getInfo; VMCIId cid; char *cptBuf; if (vmciLinux->ctType != VMCIOBJ_CONTEXT) { Log(LGPFX"IOCTL_VMCI_CTX_GET_CPT_STATE only valid for contexts.\n"); retval = -EINVAL; break; } retval = copy_from_user(&getInfo, (void *)ioarg, sizeof getInfo); if (retval) { retval = -EFAULT; break; } cid = VMCIContext_GetId(vmciLinux->context); getInfo.result = VMCIContext_GetCheckpointState(cid, getInfo.cptType, &getInfo.bufSize, &cptBuf); if (getInfo.result == VMCI_SUCCESS && getInfo.bufSize) { retval = copy_to_user((void *)(VA)getInfo.cptBuf, cptBuf, getInfo.bufSize); VMCI_FreeKernelMem(cptBuf, getInfo.bufSize); if (retval) { retval = -EFAULT; break; } } retval = copy_to_user((void *)ioarg, &getInfo, sizeof getInfo); if (retval) { retval = -EFAULT; break; } break; } case IOCTL_VMCI_CTX_SET_CPT_STATE: { VMCICptBufInfo setInfo; VMCIId cid; char *cptBuf; if (vmciLinux->ctType != VMCIOBJ_CONTEXT) { Log(LGPFX"IOCTL_VMCI_CTX_SET_CPT_STATE only valid for contexts.\n"); retval = -EINVAL; break; } retval = copy_from_user(&setInfo, (void *)ioarg, sizeof setInfo); if (retval) { retval = -EFAULT; break; } cptBuf = VMCI_AllocKernelMem(setInfo.bufSize, VMCI_MEMORY_NORMAL); if (cptBuf == NULL) { Log(LGPFX"Cannot allocate memory to set cpt state (type=%d).\n", setInfo.cptType); retval = -ENOMEM; break; } retval = copy_from_user(cptBuf, (void *)(VA)setInfo.cptBuf, setInfo.bufSize); if (retval) { VMCI_FreeKernelMem(cptBuf, setInfo.bufSize); retval = -EFAULT; break; } cid = VMCIContext_GetId(vmciLinux->context); setInfo.result = VMCIContext_SetCheckpointState(cid, setInfo.cptType, setInfo.bufSize, cptBuf); VMCI_FreeKernelMem(cptBuf, setInfo.bufSize); retval = copy_to_user((void *)ioarg, &setInfo, sizeof setInfo); if (retval) { retval = -EFAULT; break; } break; } case IOCTL_VMCI_GET_CONTEXT_ID: { VMCIId cid = VMCI_HOST_CONTEXT_ID; retval = copy_to_user((void *)ioarg, &cid, sizeof cid); break; } case IOCTL_VMCI_SET_NOTIFY: { VMCISetNotifyInfo notifyInfo; if (vmciLinux->ctType != VMCIOBJ_CONTEXT) { Log(LGPFX"IOCTL_VMCI_SET_NOTIFY only valid for contexts.\n"); retval = -EINVAL; break; } retval = copy_from_user(¬ifyInfo, (void *)ioarg, sizeof notifyInfo); if (retval) { retval = -EFAULT; break; } if ((VA)notifyInfo.notifyUVA != (VA)NULL) { notifyInfo.result = VMCISetupNotify(vmciLinux->context, (VA)notifyInfo.notifyUVA); } else { VMCIUnsetNotifyInt(vmciLinux->context, TRUE); notifyInfo.result = VMCI_SUCCESS; } retval = copy_to_user((void *)ioarg, ¬ifyInfo, sizeof notifyInfo); if (retval) { retval = -EFAULT; break; } break; } case IOCTL_VMCI_NOTIFY_RESOURCE: { VMCINotifyResourceInfo info; VMCIId cid; if (vmciLinux->userVersion < VMCI_VERSION_NOTIFY) { Log(LGPFX"IOCTL_VMCI_NOTIFY_RESOURCE is invalid for current" " VMX versions.\n"); retval = -EINVAL; break; } if (vmciLinux->ctType != VMCIOBJ_CONTEXT) { Log(LGPFX"IOCTL_VMCI_NOTIFY_RESOURCE is only valid for contexts.\n"); retval = -EINVAL; break; } retval = copy_from_user(&info, (void *)ioarg, sizeof info); if (retval) { retval = -EFAULT; break; } cid = VMCIContext_GetId(vmciLinux->context); switch (info.action) { case VMCI_NOTIFY_RESOURCE_ACTION_NOTIFY: if (info.resource == VMCI_NOTIFY_RESOURCE_DOOR_BELL) { info.result = VMCIContext_NotifyDoorbell(cid, info.handle, VMCI_NO_PRIVILEGE_FLAGS); } else { info.result = VMCI_ERROR_UNAVAILABLE; } break; case VMCI_NOTIFY_RESOURCE_ACTION_CREATE: info.result = VMCIContext_DoorbellCreate(cid, info.handle); break; case VMCI_NOTIFY_RESOURCE_ACTION_DESTROY: info.result = VMCIContext_DoorbellDestroy(cid, info.handle); break; default: Log(LGPFX"IOCTL_VMCI_NOTIFY_RESOURCE got unknown action (action=%d).\n", info.action); info.result = VMCI_ERROR_INVALID_ARGS; } retval = copy_to_user((void *)ioarg, &info, sizeof info); if (retval) { retval = -EFAULT; break; } break; } case IOCTL_VMCI_NOTIFICATIONS_RECEIVE: { VMCINotificationReceiveInfo info; VMCIHandleArray *dbHandleArray; VMCIHandleArray *qpHandleArray; VMCIId cid; if (vmciLinux->ctType != VMCIOBJ_CONTEXT) { Log(LGPFX"IOCTL_VMCI_NOTIFICATIONS_RECEIVE is only valid for contexts.\n"); retval = -EINVAL; break; } if (vmciLinux->userVersion < VMCI_VERSION_NOTIFY) { Log(LGPFX"IOCTL_VMCI_NOTIFICATIONS_RECEIVE is not supported for the" " current vmx version.\n"); retval = -EINVAL; break; } retval = copy_from_user(&info, (void *)ioarg, sizeof info); if (retval) { retval = -EFAULT; break; } if ((info.dbHandleBufSize && !info.dbHandleBufUVA) || (info.qpHandleBufSize && !info.qpHandleBufUVA)) { retval = -EINVAL; break; } cid = VMCIContext_GetId(vmciLinux->context); info.result = VMCIContext_ReceiveNotificationsGet(cid, &dbHandleArray, &qpHandleArray); if (info.result == VMCI_SUCCESS) { info.result = VMCICopyHandleArrayToUser((void *)(VA)info.dbHandleBufUVA, &info.dbHandleBufSize, dbHandleArray, &retval); if (info.result == VMCI_SUCCESS && !retval) { info.result = VMCICopyHandleArrayToUser((void *)(VA)info.qpHandleBufUVA, &info.qpHandleBufSize, qpHandleArray, &retval); } if (!retval) { retval = copy_to_user((void *)ioarg, &info, sizeof info); } VMCIContext_ReceiveNotificationsRelease(cid, dbHandleArray, qpHandleArray, info.result == VMCI_SUCCESS && !retval); } else { retval = copy_to_user((void *)ioarg, &info, sizeof info); } break; } default: Warning(LGPFX"Unknown ioctl (iocmd=%d).\n", iocmd); retval = -EINVAL; } return retval; } #if defined(HAVE_COMPAT_IOCTL) || defined(HAVE_UNLOCKED_IOCTL) /* *----------------------------------------------------------------------------- * * LinuxDriver_UnlockedIoctl -- * * Wrapper for LinuxDriver_Ioctl supporting the compat_ioctl and * unlocked_ioctl methods that have signatures different from the * old ioctl. Used as compat_ioctl method for 32bit apps running * on 64bit kernel and for unlocked_ioctl on systems supporting * those. LinuxDriver_Ioctl may safely be called without holding * the BKL. * * Results: * Same as LinuxDriver_Ioctl. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static long LinuxDriver_UnlockedIoctl(struct file *filp, u_int iocmd, unsigned long ioarg) { return LinuxDriver_Ioctl(NULL, filp, iocmd, ioarg); } #endif /* *----------------------------------------------------------------------------- * * VMCIUserVAInvalidPointer -- * * Checks if a given user VA is valid or not. Copied from * bora/modules/vmnet/linux/hostif.c:VNetUserIfInvalidPointer(). TODO * libify the common code. * * Results: * TRUE iff invalid. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE Bool VMCIUserVAInvalidPointer(VA uva, // IN: size_t size) // IN: { return !access_ok(VERIFY_WRITE, (void *)uva, size); } /* *----------------------------------------------------------------------------- * * VMCIUserVALockPage -- * * Lock physical page backing a given user VA. Copied from * bora/modules/vmnet/linux/userif.c:UserIfLockPage(). TODO libify the * common code. * * Results: * Pointer to struct page on success, NULL otherwise. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE struct page * VMCIUserVALockPage(VA addr) // IN: { struct page *page = NULL; int retval; down_read(¤t->mm->mmap_sem); #if LINUX_VERSION_CODE >= KERNEL_VERSION(4, 6, 0) retval = get_user_pages(addr, 1, 1, 0, &page, NULL); #else retval = get_user_pages(current, current->mm, addr, 1, 1, 0, &page, NULL); #endif up_read(¤t->mm->mmap_sem); if (retval != 1) { return NULL; } return page; } /* *----------------------------------------------------------------------------- * * VMCIMapBoolPtr -- * * Lock physical page backing a given user VA and maps it to kernel * address space. The range of the mapped memory should be within a * single page otherwise an error is returned. Copied from * bora/modules/vmnet/linux/userif.c:VNetUserIfMapUint32Ptr(). TODO * libify the common code. * * Results: * 0 on success, negative error code otherwise. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static INLINE int VMCIMapBoolPtr(VA notifyUVA, // IN: struct page **p, // OUT: Bool **notifyPtr) // OUT: { if (VMCIUserVAInvalidPointer(notifyUVA, sizeof **notifyPtr) || (((notifyUVA + sizeof **notifyPtr - 1) & ~(PAGE_SIZE - 1)) != (notifyUVA & ~(PAGE_SIZE - 1)))) { return -EINVAL; } *p = VMCIUserVALockPage(notifyUVA); if (*p == NULL) { return -EAGAIN; } *notifyPtr = (Bool *)((uint8 *)kmap(*p) + (notifyUVA & (PAGE_SIZE - 1))); return 0; } /* *----------------------------------------------------------------------------- * * VMCISetupNotify -- * * Sets up a given context for notify to work. Calls VMCIMapBoolPtr() * which maps the notify boolean in user VA in kernel space. * * Results: * VMCI_SUCCESS on success, error code otherwise. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static int VMCISetupNotify(VMCIContext *context, // IN: VA notifyUVA) // IN: { int retval; if (context->notify) { Warning(LGPFX"Notify mechanism is already set up.\n"); return VMCI_ERROR_DUPLICATE_ENTRY; } retval = VMCIMapBoolPtr(notifyUVA, &context->notifyPage, &context->notify) == 0 ? VMCI_SUCCESS : VMCI_ERROR_GENERIC; if (retval == VMCI_SUCCESS) { VMCIContext_CheckAndSignalNotify(context); } return retval; } /* *----------------------------------------------------------------------------- * * VMCIUnsetNotifyInt -- * * Internal version of VMCIUnsetNotify, that allows for locking * the context before unsetting the notify pointer. If useLock is * TRUE, the context lock is grabbed. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static void VMCIUnsetNotifyInt(VMCIContext *context, // IN Bool useLock) // IN { VMCILockFlags flags; if (useLock) { VMCI_GrabLock(&context->lock, &flags); } if (context->notifyPage) { struct page *notifyPage = context->notifyPage; context->notify = NULL; context->notifyPage = NULL; if (useLock) { VMCI_ReleaseLock(&context->lock, flags); } kunmap(notifyPage); put_page(notifyPage); } else { if (useLock) { VMCI_ReleaseLock(&context->lock, flags); } } } /* *----------------------------------------------------------------------------- * * VMCIUnsetNotify -- * * Reverts actions set up by VMCISetupNotify(). Unmaps and unlocks the * page mapped/locked by VMCISetupNotify(). * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ void VMCIUnsetNotify(VMCIContext *context) // IN: { VMCIUnsetNotifyInt(context, FALSE); } /* *----------------------------------------------------------------------------- * * PCI device support -- * * The following functions implement the support for the VMCI * guest device. This includes initializing the device and * interrupt handling. * *----------------------------------------------------------------------------- */ /* *----------------------------------------------------------------------------- * * vmci_guest_init -- * * Initializes the VMCI PCI device. The initialization might fail * if there is no VMCI PCI device. * * Results: * 0 on success, other error codes on failure. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static int vmci_guest_init(void) { int retval; /* Initialize guest device data. */ compat_mutex_init(&vmci_dev.lock); vmci_dev.intr_type = VMCI_INTR_TYPE_INTX; vmci_dev.exclusive_vectors = FALSE; spin_lock_init(&vmci_dev.dev_spinlock); vmci_dev.enabled = FALSE; atomic_set(&vmci_dev.datagrams_allowed, 0); atomic_set(&guestDeviceActive, 0); data_buffer = vmalloc(data_buffer_size); if (!data_buffer) { return -ENOMEM; } /* This should be last to make sure we are done initializing. */ retval = pci_register_driver(&vmci_driver); if (retval < 0) { vfree(data_buffer); data_buffer = NULL; return retval; } return 0; } /* *----------------------------------------------------------------------------- * * vmci_enable_msix -- * * Enable MSI-X. Try exclusive vectors first, then shared vectors. * * Results: * 0 on success, other error codes on failure. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static int vmci_enable_msix(struct pci_dev *pdev) // IN { int i; int result; for (i = 0; i < VMCI_MAX_INTRS; ++i) { vmci_dev.msix_entries[i].entry = i; vmci_dev.msix_entries[i].vector = i; } result = pci_enable_msix(pdev, vmci_dev.msix_entries, VMCI_MAX_INTRS); if (!result) { vmci_dev.exclusive_vectors = TRUE; } else if (result > 0) { result = pci_enable_msix(pdev, vmci_dev.msix_entries, 1); } return result; } /* *----------------------------------------------------------------------------- * * vmci_probe_device -- * * Most of the initialization at module load time is done here. * * Results: * Returns 0 for success, an error otherwise. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static int vmci_probe_device(struct pci_dev *pdev, // IN: vmci PCI device const struct pci_device_id *id) // IN: matching device ID { unsigned int ioaddr; unsigned int ioaddr_size; unsigned int capabilities; int result; printk(KERN_INFO "Probing for vmci/PCI.\n"); result = pci_enable_device(pdev); if (result) { printk(KERN_ERR "Cannot VMCI device %s: error %d\n", pci_name(pdev), result); return result; } pci_set_master(pdev); /* To enable QueuePair functionality. */ ioaddr = pci_resource_start(pdev, 0); ioaddr_size = pci_resource_len(pdev, 0); /* * Request I/O region with adjusted base address and size. The adjusted * values are needed and used if we release the region in case of failure. */ if (!compat_request_region(ioaddr, ioaddr_size, "vmci")) { printk(KERN_INFO "vmci: Another driver already loaded " "for device in slot %s.\n", pci_name(pdev)); goto pci_disable; } printk(KERN_INFO "Found vmci/PCI at %#x, irq %u.\n", ioaddr, pdev->irq); /* * Verify that the VMCI Device supports the capabilities that * we need. If the device is missing capabilities that we would * like to use, check for fallback capabilities and use those * instead (so we can run a new VM on old hosts). Fail the load if * a required capability is missing and there is no fallback. * * Right now, we need datagrams. There are no fallbacks. */ capabilities = inl(ioaddr + VMCI_CAPS_ADDR); if ((capabilities & VMCI_CAPS_DATAGRAM) == 0) { printk(KERN_ERR "VMCI device does not support datagrams.\n"); goto release; } /* * If the hardware supports notifications, we will use that as * well. */ if (capabilities & VMCI_CAPS_NOTIFICATIONS) { capabilities = VMCI_CAPS_DATAGRAM; notification_bitmap = dma_alloc_coherent(&pdev->dev, PAGE_SIZE, ¬ification_base, GFP_KERNEL); if (notification_bitmap == NULL) { printk(KERN_ERR "VMCI device unable to allocate notification bitmap.\n"); } else { memset(notification_bitmap, 0, PAGE_SIZE); capabilities |= VMCI_CAPS_NOTIFICATIONS; } } else { capabilities = VMCI_CAPS_DATAGRAM; } printk(KERN_INFO "VMCI: using capabilities 0x%x.\n", capabilities); /* Let the host know which capabilities we intend to use. */ outl(capabilities, ioaddr + VMCI_CAPS_ADDR); /* Device struct initialization. */ compat_mutex_lock(&vmci_dev.lock); if (vmci_dev.enabled) { printk(KERN_ERR "VMCI device already enabled.\n"); goto unlock; } vmci_dev.ioaddr = ioaddr; vmci_dev.ioaddr_size = ioaddr_size; atomic_set(&vmci_dev.datagrams_allowed, 1); /* * Register notification bitmap with device if that capability is * used */ if (capabilities & VMCI_CAPS_NOTIFICATIONS) { unsigned long bitmapPPN = notification_base >> PAGE_SHIFT; if (!VMCI_RegisterNotificationBitmap(bitmapPPN)) { printk(KERN_ERR "VMCI device unable to register notification bitmap " "with PPN 0x%x.\n", (uint32)bitmapPPN); goto datagram_disallow; } } /* Check host capabilities. */ if (!VMCI_CheckHostCapabilities()) { goto remove_bitmap; } /* Enable device. */ vmci_dev.enabled = TRUE; pci_set_drvdata(pdev, &vmci_dev); vmci_pdev = pdev; /* * We do global initialization here because we need datagrams * during VMCIUtil_Init, since it registers for VMCI events. If we * ever support more than one VMCI device we will have to create * seperate LateInit/EarlyExit functions that can be used to do * initialization/cleanup that depends on the device being * accessible. We need to initialize VMCI components before * requesting an irq - the VMCI interrupt handler uses these * components, and it may be invoked once request_irq() has * registered the handler (as the irq line may be shared). */ VMCIUtil_Init(); if (VMCIQPGuestEndpoints_Init() < VMCI_SUCCESS) { goto util_exit; } /* * Enable interrupts. Try MSI-X first, then MSI, and then fallback on * legacy interrupts. */ if (!vmci_disable_msix && !vmci_enable_msix(pdev)) { vmci_dev.intr_type = VMCI_INTR_TYPE_MSIX; vmci_dev.irq = vmci_dev.msix_entries[0].vector; } else if (!vmci_disable_msi && !pci_enable_msi(pdev)) { vmci_dev.intr_type = VMCI_INTR_TYPE_MSI; vmci_dev.irq = pdev->irq; } else { vmci_dev.intr_type = VMCI_INTR_TYPE_INTX; vmci_dev.irq = pdev->irq; } /* Request IRQ for legacy or MSI interrupts, or for first MSI-X vector. */ result = request_irq(vmci_dev.irq, vmci_interrupt, COMPAT_IRQF_SHARED, "vmci", &vmci_dev); if (result) { printk(KERN_ERR "vmci: irq %u in use: %d\n", vmci_dev.irq, result); goto components_exit; } /* * For MSI-X with exclusive vectors we need to request an interrupt for each * vector so that we get a separate interrupt handler routine. This allows * us to distinguish between the vectors. */ if (vmci_dev.exclusive_vectors) { ASSERT(vmci_dev.intr_type == VMCI_INTR_TYPE_MSIX); result = request_irq(vmci_dev.msix_entries[1].vector, vmci_interrupt_bm, 0, "vmci", &vmci_dev); if (result) { printk(KERN_ERR "vmci: irq %u in use: %d\n", vmci_dev.msix_entries[1].vector, result); free_irq(vmci_dev.irq, &vmci_dev); goto components_exit; } } printk(KERN_INFO "Registered vmci device.\n"); atomic_inc(&guestDeviceActive); compat_mutex_unlock(&vmci_dev.lock); /* Enable specific interrupt bits. */ if (capabilities & VMCI_CAPS_NOTIFICATIONS) { outl(VMCI_IMR_DATAGRAM | VMCI_IMR_NOTIFICATION, vmci_dev.ioaddr + VMCI_IMR_ADDR); } else { outl(VMCI_IMR_DATAGRAM, vmci_dev.ioaddr + VMCI_IMR_ADDR); } /* Enable interrupts. */ outl(VMCI_CONTROL_INT_ENABLE, vmci_dev.ioaddr + VMCI_CONTROL_ADDR); return 0; components_exit: VMCIQPGuestEndpoints_Exit(); tasklet_kill(&vmci_dg_tasklet); tasklet_kill(&vmci_bm_tasklet); util_exit: VMCIUtil_Exit(); vmci_dev.enabled = FALSE; if (vmci_dev.intr_type == VMCI_INTR_TYPE_MSIX) { pci_disable_msix(pdev); } else if (vmci_dev.intr_type == VMCI_INTR_TYPE_MSI) { pci_disable_msi(pdev); } remove_bitmap: if (notification_bitmap) { outl(VMCI_CONTROL_RESET, vmci_dev.ioaddr + VMCI_CONTROL_ADDR); } datagram_disallow: atomic_set(&vmci_dev.datagrams_allowed, 0); unlock: compat_mutex_unlock(&vmci_dev.lock); release: if (notification_bitmap) { dma_free_coherent(&pdev->dev, PAGE_SIZE, notification_bitmap, notification_base); notification_bitmap = NULL; } release_region(ioaddr, ioaddr_size); pci_disable: pci_disable_device(pdev); return -EBUSY; } /* *----------------------------------------------------------------------------- * * vmci_remove_device -- * * Cleanup, called for each device on unload. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ static void vmci_remove_device(struct pci_dev* pdev) { struct vmci_device *dev = pci_get_drvdata(pdev); printk(KERN_INFO "Removing vmci device\n"); atomic_dec(&guestDeviceActive); VMCIQPGuestEndpoints_Exit(); VMCIUtil_Exit(); vmci_pdev = NULL; compat_mutex_lock(&dev->lock); atomic_set(&vmci_dev.datagrams_allowed, 0); printk(KERN_INFO "Resetting vmci device\n"); outl(VMCI_CONTROL_RESET, vmci_dev.ioaddr + VMCI_CONTROL_ADDR); /* * Free IRQ and then disable MSI/MSI-X as appropriate. For MSI-X, we might * have multiple vectors, each with their own IRQ, which we must free too. */ free_irq(dev->irq, dev); if (dev->intr_type == VMCI_INTR_TYPE_MSIX) { if (dev->exclusive_vectors) { free_irq(dev->msix_entries[1].vector, dev); } pci_disable_msix(pdev); } else if (dev->intr_type == VMCI_INTR_TYPE_MSI) { pci_disable_msi(pdev); } dev->exclusive_vectors = FALSE; dev->intr_type = VMCI_INTR_TYPE_INTX; tasklet_kill(&vmci_dg_tasklet); tasklet_kill(&vmci_bm_tasklet); tasklet_disable(&vmci_dg_tasklet); tasklet_disable(&vmci_bm_tasklet); release_region(dev->ioaddr, dev->ioaddr_size); dev->enabled = FALSE; if (notification_bitmap) { /* * The device reset above cleared the bitmap state of the * device, so we can safely free it here. */ pci_free_consistent(pdev, PAGE_SIZE, notification_bitmap, notification_base); notification_bitmap = NULL; } printk(KERN_INFO "Unregistered vmci device.\n"); compat_mutex_unlock(&dev->lock); pci_disable_device(pdev); } /* *----------------------------------------------------------------------------- * * vmci_interrupt -- * * Interrupt handler for legacy or MSI interrupt, or for first MSI-X * interrupt (vector VMCI_INTR_DATAGRAM). * * Results: * COMPAT_IRQ_HANDLED if the interrupt is handled, COMPAT_IRQ_NONE if * not an interrupt. * * Side effects: * None. * *----------------------------------------------------------------------------- */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 19) static compat_irqreturn_t vmci_interrupt(int irq, // IN void *clientdata, // IN struct pt_regs *regs) // IN #else static compat_irqreturn_t vmci_interrupt(int irq, // IN void *clientdata) // IN #endif { vmci_device *dev = clientdata; if (dev == NULL) { printk(KERN_DEBUG "vmci_interrupt(): irq %d for unknown device.\n", irq); return COMPAT_IRQ_NONE; } /* * If we are using MSI-X with exclusive vectors then we simply schedule * the datagram tasklet, since we know the interrupt was meant for us. * Otherwise we must read the ICR to determine what to do. */ if (dev->intr_type == VMCI_INTR_TYPE_MSIX && dev->exclusive_vectors) { tasklet_schedule(&vmci_dg_tasklet); } else { unsigned int icr; ASSERT(dev->intr_type == VMCI_INTR_TYPE_INTX || dev->intr_type == VMCI_INTR_TYPE_MSI); /* Acknowledge interrupt and determine what needs doing. */ icr = inl(dev->ioaddr + VMCI_ICR_ADDR); if (icr == 0 || icr == 0xffffffff) { return COMPAT_IRQ_NONE; } if (icr & VMCI_ICR_DATAGRAM) { tasklet_schedule(&vmci_dg_tasklet); icr &= ~VMCI_ICR_DATAGRAM; } if (icr & VMCI_ICR_NOTIFICATION) { tasklet_schedule(&vmci_bm_tasklet); icr &= ~VMCI_ICR_NOTIFICATION; } if (icr != 0) { printk(KERN_INFO LGPFX"Ignoring unknown interrupt cause (%d).\n", icr); } } return COMPAT_IRQ_HANDLED; } /* *----------------------------------------------------------------------------- * * vmci_interrupt_bm -- * * Interrupt handler for MSI-X interrupt vector VMCI_INTR_NOTIFICATION, * which is for the notification bitmap. Will only get called if we are * using MSI-X with exclusive vectors. * * Results: * COMPAT_IRQ_HANDLED if the interrupt is handled, COMPAT_IRQ_NONE if * not an interrupt. * * Side effects: * None. * *----------------------------------------------------------------------------- */ #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 19) static compat_irqreturn_t vmci_interrupt_bm(int irq, // IN void *clientdata, // IN struct pt_regs *regs) // IN #else static compat_irqreturn_t vmci_interrupt_bm(int irq, // IN void *clientdata) // IN #endif { vmci_device *dev = clientdata; if (dev == NULL) { printk(KERN_DEBUG "vmci_interrupt_bm(): irq %d for unknown device.\n", irq); return COMPAT_IRQ_NONE; } /* For MSI-X we can just assume it was meant for us. */ ASSERT(dev->intr_type == VMCI_INTR_TYPE_MSIX && dev->exclusive_vectors); tasklet_schedule(&vmci_bm_tasklet); return COMPAT_IRQ_HANDLED; } /* *----------------------------------------------------------------------------- * * VMCI_DeviceEnabled -- * * Checks whether the VMCI device is enabled. * * Results: * TRUE if device is enabled, FALSE otherwise. * * Side effects: * None. * *----------------------------------------------------------------------------- */ Bool VMCI_DeviceEnabled(void) { return VMCI_GuestPersonalityActive() || VMCI_HostPersonalityActive(); } /* *----------------------------------------------------------------------------- * * VMCI_SendDatagram -- * * VM to hypervisor call mechanism. We use the standard VMware naming * convention since shared code is calling this function as well. * * Results: * The result of the hypercall. * * Side effects: * None. * *----------------------------------------------------------------------------- */ int VMCI_SendDatagram(VMCIDatagram *dg) { unsigned long flags; int result; /* Check args. */ if (dg == NULL) { return VMCI_ERROR_INVALID_ARGS; } if (atomic_read(&vmci_dev.datagrams_allowed) == 0) { return VMCI_ERROR_UNAVAILABLE; } /* * Need to acquire spinlock on the device because * the datagram data may be spread over multiple pages and the monitor may * interleave device user rpc calls from multiple VCPUs. Acquiring the * spinlock precludes that possibility. Disabling interrupts to avoid * incoming datagrams during a "rep out" and possibly landing up in this * function. */ spin_lock_irqsave(&vmci_dev.dev_spinlock, flags); /* * Send the datagram and retrieve the return value from the result register. */ __asm__ __volatile__( "cld\n\t" "rep outsb\n\t" : /* No output. */ : "d"(vmci_dev.ioaddr + VMCI_DATA_OUT_ADDR), "c"(VMCI_DG_SIZE(dg)), "S"(dg) ); /* * XXX Should read result high port as well when updating handlers to * return 64bit. */ result = inl(vmci_dev.ioaddr + VMCI_RESULT_LOW_ADDR); spin_unlock_irqrestore(&vmci_dev.dev_spinlock, flags); return result; } /* *----------------------------------------------------------------------------- * * dispatch_datagrams -- * * Reads and dispatches incoming datagrams. * * Results: * None. * * Side effects: * Reads data from the device. * *----------------------------------------------------------------------------- */ void dispatch_datagrams(unsigned long data) { vmci_device *dev = (vmci_device *)data; if (dev == NULL) { printk(KERN_DEBUG "vmci: dispatch_datagrams(): no vmci device" "present.\n"); return; } if (data_buffer == NULL) { printk(KERN_DEBUG "vmci: dispatch_datagrams(): no buffer present.\n"); return; } VMCI_ReadDatagramsFromPort((VMCIIoHandle) 0, dev->ioaddr + VMCI_DATA_IN_ADDR, data_buffer, data_buffer_size); } /* *----------------------------------------------------------------------------- * * process_bitmap -- * * Scans the notification bitmap for raised flags, clears them * and handles the notifications. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ void process_bitmap(unsigned long data) { vmci_device *dev = (vmci_device *)data; if (dev == NULL) { printk(KERN_DEBUG "vmci: process_bitmaps(): no vmci device" "present.\n"); return; } if (notification_bitmap == NULL) { printk(KERN_DEBUG "vmci: process_bitmaps(): no bitmap present.\n"); return; } VMCI_ScanNotificationBitmap(notification_bitmap); } /* *---------------------------------------------------------------------- * * Shared functions -- * * Functions shared between host and guest personality. * *---------------------------------------------------------------------- */ /* *----------------------------------------------------------------------------- * * VMCI_GuestPersonalityActive -- * * Determines whether the VMCI PCI device has been successfully * initialized. * * Results: * TRUE, if VMCI guest device is operational, FALSE otherwise. * * Side effects: * Reads data from the device. * *----------------------------------------------------------------------------- */ Bool VMCI_GuestPersonalityActive(void) { return guestDeviceInit && atomic_read(&guestDeviceActive) > 0; } /* *----------------------------------------------------------------------------- * * VMCI_HostPersonalityActive -- * * Determines whether the VMCI host personality is * available. Since the core functionality of the host driver is * always present, all guests could possibly use the host * personality. However, to minimize the deviation from the * pre-unified driver state of affairs, we only consider the host * device active, if there is no active guest device, or if there * are VMX'en with active VMCI contexts using the host device. * * Results: * TRUE, if VMCI host driver is operational, FALSE otherwise. * * Side effects: * Reads data from the device. * *----------------------------------------------------------------------------- */ Bool VMCI_HostPersonalityActive(void) { return hostDeviceInit && (!VMCI_GuestPersonalityActive() || atomic_read(&linuxState.activeContexts) > 0); } /* *---------------------------------------------------------------------- * * Module definitions -- * * Implements support for module load/unload. * *---------------------------------------------------------------------- */ /* *---------------------------------------------------------------------- * * vmci_init -- * * linux module entry point. Called by /sbin/insmod command * * Results: * registers a device driver for a major # that depends * on the uid. Add yourself to that list. List is now in * private/driver-private.c. * *---------------------------------------------------------------------- */ static int __init vmci_init(void) { int retval; retval = VMCI_SharedInit(); if (retval != VMCI_SUCCESS) { Warning(LGPFX"Failed to initialize VMCI common components (err=%d).\n", retval); return -ENOMEM; } if (!vmci_disable_guest) { retval = vmci_guest_init(); if (retval != 0) { Warning(LGPFX"VMCI PCI device not initialized (err=%d).\n", retval); } else { guestDeviceInit = TRUE; if (VMCI_GuestPersonalityActive()) { Log(LGPFX"Using guest personality\n"); } } } if (!vmci_disable_host) { retval = vmci_host_init(); if (retval != 0) { Warning(LGPFX"Unable to initialize host personality (err=%d).\n", retval); } else { hostDeviceInit = TRUE; Log(LGPFX"Using host personality\n"); } } if (!guestDeviceInit && !hostDeviceInit) { VMCI_SharedCleanup(); return -ENODEV; } Log(LGPFX"Module (name=%s) is initialized\n", VMCI_MODULE_NAME); return 0; } /* *---------------------------------------------------------------------- * * vmci_exit -- * * Called by /sbin/rmmod * * *---------------------------------------------------------------------- */ static void __exit vmci_exit(void) { int retval; if (guestDeviceInit) { pci_unregister_driver(&vmci_driver); vfree(data_buffer); data_buffer = NULL; guestDeviceInit = FALSE; } if (hostDeviceInit) { unregister_ioctl32_handlers(); VMCI_HostCleanup(); retval = misc_deregister(&linuxState.misc); if (retval) { Warning(LGPFX "Module %s: error unregistering\n", VMCI_MODULE_NAME); } else { Log(LGPFX"Module %s: unloaded\n", VMCI_MODULE_NAME); } hostDeviceInit = FALSE; } VMCI_SharedCleanup(); } module_init(vmci_init); module_exit(vmci_exit); MODULE_DEVICE_TABLE(pci, vmci_ids); module_param_named(disable_host, vmci_disable_host, bool, 0); MODULE_PARM_DESC(disable_host, "Disable driver host personality - (default=0)"); module_param_named(disable_guest, vmci_disable_guest, bool, 0); MODULE_PARM_DESC(disable_guest, "Disable driver guest personality - (default=0)"); module_param_named(disable_msi, vmci_disable_msi, bool, 0); MODULE_PARM_DESC(disable_msi, "Disable MSI use in driver - (default=0)"); module_param_named(disable_msix, vmci_disable_msix, bool, 0); MODULE_PARM_DESC(disable_msix, "Disable MSI-X use in driver - (default=" __stringify(VMCI_DISABLE_MSIX) ")"); MODULE_AUTHOR("VMware, Inc."); MODULE_DESCRIPTION("VMware Virtual Machine Communication Interface (VMCI)."); MODULE_VERSION(VMCI_DRIVER_VERSION_STRING); MODULE_LICENSE("GPL v2"); /* * Starting with SLE10sp2, Novell requires that IHVs sign a support agreement * with them and mark their kernel modules as externally supported via a * change to the module header. If this isn't done, the module will not load * by default (i.e., neither mkinitrd nor modprobe will accept it). */ MODULE_INFO(supported, "external"); vmci-only/linux/vmciKernelIf.c 0000444 0000000 0000000 00000152506 13432725347 015373 0 ustar root root /********************************************************* * Copyright (C) 2007 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 * *********************************************************/ /* * vmciKernelIf.c -- * * This file implements defines and helper functions for VMCI * host _and_ guest kernel code. This is the linux specific * implementation. */ /* Must come before any kernel header file */ #include "driver-config.h" #if !defined(__linux__) || defined(VMKERNEL) #error "Wrong platform." #endif #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 9) # error "Linux kernels before 2.6.9 are not supported." #endif #include <linux/mm.h> /* For vmalloc_to_page() and get_user_pages()*/ #include <linux/pagemap.h> /* For page_cache_release() */ #include <linux/socket.h> /* For memcpy_{to,from}iovec(). */ #include <linux/vmalloc.h> #include <linux/wait.h> #include "compat_highmem.h" #include "compat_interrupt.h" #include "compat_mm.h" #include "compat_module.h" #include "compat_page.h" #include "compat_pci.h" #include "compat_sched.h" #include "compat_semaphore.h" #include "compat_slab.h" #include "compat_spinlock.h" #include "compat_version.h" #include "compat_workqueue.h" #include "vm_assert.h" #include "vm_basic_types.h" #include "vmci_iocontrols.h" #include "vmci_kernel_if.h" #include "vmciQueue.h" #include "vmciQueuePair.h" /* * The Kernel specific component of the VMCIQueue structure. */ struct VMCIQueueKernelIf { VMCIMutex __mutex; /* Protects the queue. */ VMCIMutex *mutex; /* Shared by producer/consumer queues. */ size_t numPages; /* Number of pages incl. header. */ Bool host; /* Host or guest? */ union { struct { dma_addr_t *pas; /* Physical addresses. */ void **vas; /* Virtual addresses. */ } g; /* Guest. */ struct { struct page **headerPage; /* Guest queue header pages. */ struct page **page; /* Guest queue pages. */ } h; /* Host. */ } u; }; typedef struct VMCIDelayedWorkInfo { compat_work work; VMCIWorkFn *workFn; void *data; } VMCIDelayedWorkInfo; extern struct pci_dev *vmci_pdev; /* *----------------------------------------------------------------------------- * * VMCI_InitLock * * Initializes the lock. Must be called before use. * * Results: * Always VMCI_SUCCESS. * * Side effects: * Thread can block. * *----------------------------------------------------------------------------- */ int VMCI_InitLock(VMCILock *lock, // IN: char *name, // IN: Unused on Linux VMCILockRank rank) // IN: Unused on Linux { spin_lock_init(lock); return VMCI_SUCCESS; } /* *----------------------------------------------------------------------------- * * VMCI_CleanupLock * * Cleanup the lock. Must be called before deallocating lock. * * Results: * None * * Side effects: * Deletes kernel lock state * *----------------------------------------------------------------------------- */ void VMCI_CleanupLock(VMCILock *lock) { } /* *----------------------------------------------------------------------------- * * VMCI_GrabLock * * Grabs the given lock. XXX Fill in specific lock requirements. XXX Move * locking code into hostif if VMCI stays in vmmon. * * Results: * None * * Side effects: * Thread can block. * *----------------------------------------------------------------------------- */ void VMCI_GrabLock(VMCILock *lock, // IN VMCILockFlags *flags) // OUT: used to restore irql on windows { spin_lock(lock); } /* *----------------------------------------------------------------------------- * * VMCI_ReleaseLock * * Releases the given lock. XXX Move locking code into hostif if VMCI * stays in vmmon. * * Results: * None * * Side effects: * A thread blocked on this lock may wake up. * *----------------------------------------------------------------------------- */ void VMCI_ReleaseLock(VMCILock *lock, // IN VMCILockFlags flags) // IN { spin_unlock(lock); } /* *----------------------------------------------------------------------------- * * VMCI_GrabLock_BH * * Grabs the given lock and for linux kernels disables bottom half execution. * This should be used with locks accessed both from bottom half/tasklet * contexts, ie. guestcall handlers, and from process contexts to avoid * deadlocks where the process has the lock and gets descheduled due to a * bh/tasklet coming in. * * Results: * None * * Side effects: * None. * *----------------------------------------------------------------------------- */ void VMCI_GrabLock_BH(VMCILock *lock, // IN VMCILockFlags *flags) // OUT: used to restore { spin_lock_bh(lock); } /* *----------------------------------------------------------------------------- * * VMCI_ReleaseLock_BH * * Releases the given lock and for linux kernels reenables bottom half * execution. * This should be used with locks accessed both from bottom half/tasklet * contexts, ie. guestcall handlers, and from process contexts to avoid * deadlocks where the process has the lock and get descheduled due to a * bh/tasklet coming in. * * Results: * None * * Side effects: * None. * *----------------------------------------------------------------------------- */ void VMCI_ReleaseLock_BH(VMCILock *lock, // IN VMCILockFlags flags) // IN { spin_unlock_bh(lock); } /* *---------------------------------------------------------------------- * * VMCIHost_InitContext -- * * Host-specific initialization of VMCI context state. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ void VMCIHost_InitContext(VMCIHost *hostContext, // IN uintptr_t eventHnd) // IN: Unused { init_waitqueue_head(&hostContext->waitQueue); } /* *---------------------------------------------------------------------- * * VMCIHost_ReleaseContext -- * * Host-specific release of state allocated by * VMCIHost_InitContext. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ void VMCIHost_ReleaseContext(VMCIHost *hostContext) // IN { } /* *---------------------------------------------------------------------- * * VMCIHost_SignalCall -- * * Signal to userlevel that a VMCI call is waiting. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ void VMCIHost_SignalCall(VMCIHost *hostContext) // IN { wake_up(&hostContext->waitQueue); } /* *---------------------------------------------------------------------- * * VMCIHost_WaitForCallLocked -- * * Wait until a VMCI call is pending or the waiting thread is * interrupted. It is assumed that a lock is held prior to * calling this function. The lock will be released during the * wait. The correctnes of this funtion depends on that the same * lock is held when the call is signalled. * * Results: * TRUE on success * FALSE if the wait was interrupted. * * Side effects: * The call may block. * *---------------------------------------------------------------------- */ Bool VMCIHost_WaitForCallLocked(VMCIHost *hostContext, // IN VMCILock *lock, // IN VMCILockFlags *flags, // IN Bool useBH) // IN { DECLARE_WAITQUEUE(wait, current); /* * The thread must be added to the wait queue and have its state * changed while holding the lock - otherwise a signal may change * the state in between and have it overwritten causing a loss of * the event. */ add_wait_queue(&hostContext->waitQueue, &wait); current->state = TASK_INTERRUPTIBLE; if (useBH) { VMCI_ReleaseLock_BH(lock, *flags); } else { VMCI_ReleaseLock(lock, *flags); } schedule(); if (useBH) { VMCI_GrabLock_BH(lock, flags); } else { VMCI_GrabLock(lock, flags); } current->state = TASK_RUNNING; remove_wait_queue(&hostContext->waitQueue, &wait); if (signal_pending(current)) { return FALSE; } return TRUE; } /* *---------------------------------------------------------------------- * * VMCIHost_ClearCall -- * * Clear the pending call signal. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------- */ void VMCIHost_ClearCall(VMCIHost *hostContext) // IN { } /* *----------------------------------------------------------------------------- * * VMCIHost_CompareUser -- * * Determines whether the two users are the same. * * Results: * VMCI_SUCCESS if equal, error code otherwise. * * Side effects: * None. * *----------------------------------------------------------------------------- */ int VMCIHost_CompareUser(VMCIHostUser *user1, VMCIHostUser *user2) { if (!user1 || !user2) { return VMCI_ERROR_INVALID_ARGS; } #if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 5, 0) # define vmw_uid_eq(a, b) uid_eq(a, b) #else # define vmw_uid_eq(a, b) ((a) == (b)) #endif return vmw_uid_eq(*user1, *user2) ? VMCI_SUCCESS : VMCI_ERROR_GENERIC; } /* *---------------------------------------------------------------------- * * VMCI_AllocKernelMem * * Allocate some kernel memory for the VMCI driver. * * Results: * The address allocated or NULL on error. * * * Side effects: * memory is malloced *---------------------------------------------------------------------- */ void * VMCI_AllocKernelMem(size_t size, int flags) { void *ptr; if ((flags & VMCI_MEMORY_ATOMIC) != 0) { ptr = kmalloc(size, GFP_ATOMIC); } else { ptr = kmalloc(size, GFP_KERNEL); } return ptr; } /* *---------------------------------------------------------------------- * * VMCI_FreeKernelMem * * Free kernel memory allocated for the VMCI driver. * * Results: * None. * * Side effects: * memory is freed. *---------------------------------------------------------------------- */ void VMCI_FreeKernelMem(void *ptr, // IN: size_t size) // IN: Unused on Linux { kfree(ptr); } /* *----------------------------------------------------------------------------- * * VMCI_CopyToUser -- * * Copy memory to the user application from a kernel buffer. This * function may block, so don't call it while holding any kind of * lock. * * Results: * 0 on success. * Nonzero on failure. * * Side effects: * None * *----------------------------------------------------------------------------- */ int VMCI_CopyToUser(VA64 dst, // OUT: Destination user VA. const void *src, // IN: Source kernel VA. size_t len) // IN: Number of bytes to copy. { return copy_to_user(VMCIVA64ToPtr(dst), src, len) ? -EFAULT : 0; } /* *----------------------------------------------------------------------------- * * VMCI_CopyFromUser -- * * Copy memory from the user application to a kernel buffer. This * function may block, so don't call it while holding any kind of * lock. * * Results: * 0 on success. * Nonzero on failure. * * Side effects: * None. * *----------------------------------------------------------------------------- */ int VMCI_CopyFromUser(void *dst, // OUT: Kernel VA VA64 src, // IN: User VA size_t len) // IN { return copy_from_user(dst, VMCIVA64ToPtr(src), len); } /* *---------------------------------------------------------------------------- * * VMCIDelayedWorkCB * * Called in a worker thread context. * * Results: * None. * * Side effects: * None. * *---------------------------------------------------------------------------- */ static void VMCIDelayedWorkCB(compat_work_arg work) // IN { VMCIDelayedWorkInfo *delayedWorkInfo; delayedWorkInfo = COMPAT_WORK_GET_DATA(work, VMCIDelayedWorkInfo, work); ASSERT(delayedWorkInfo); ASSERT(delayedWorkInfo->workFn); delayedWorkInfo->workFn(delayedWorkInfo->data); VMCI_FreeKernelMem(delayedWorkInfo, sizeof *delayedWorkInfo); } /* *---------------------------------------------------------------------------- * * VMCI_CanScheduleDelayedWork -- * * Checks to see if the given platform supports delayed work callbacks. * * Results: * TRUE if it does. FALSE otherwise. * * Side effects: * None. * *---------------------------------------------------------------------------- */ Bool VMCI_CanScheduleDelayedWork(void) { return TRUE; } /* *---------------------------------------------------------------------------- * * VMCI_ScheduleDelayedWork -- * * Schedule the specified callback. * * Results: * Zero on success, error code otherwise. * * Side effects: * None. * *---------------------------------------------------------------------------- */ int VMCI_ScheduleDelayedWork(VMCIWorkFn *workFn, // IN void *data) // IN { VMCIDelayedWorkInfo *delayedWorkInfo; ASSERT(workFn); delayedWorkInfo = VMCI_AllocKernelMem(sizeof *delayedWorkInfo, VMCI_MEMORY_ATOMIC); if (!delayedWorkInfo) { return VMCI_ERROR_NO_MEM; } delayedWorkInfo->workFn = workFn; delayedWorkInfo->data = data; COMPAT_INIT_WORK(&delayedWorkInfo->work, VMCIDelayedWorkCB, delayedWorkInfo); compat_schedule_work(&delayedWorkInfo->work); return VMCI_SUCCESS; } /* *----------------------------------------------------------------------------- * * VMCI_CreateEvent -- * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ void VMCI_CreateEvent(VMCIEvent *event) // IN: { init_waitqueue_head(event); } /* *----------------------------------------------------------------------------- * * VMCI_DestroyEvent -- * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ void VMCI_DestroyEvent(VMCIEvent *event) // IN: { /* Nothing to do. */ } /* *----------------------------------------------------------------------------- * * VMCI_SignalEvent -- * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ void VMCI_SignalEvent(VMCIEvent *event) // IN: { wake_up(event); } /* *----------------------------------------------------------------------------- * * VMCI_WaitOnEvent -- * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ void VMCI_WaitOnEvent(VMCIEvent *event, // IN: VMCIEventReleaseCB releaseCB, // IN: void *clientData) // IN: { /* * XXX Should this be a TASK_UNINTERRUPTIBLE wait? I'm leaving it * as it was for now. */ VMCI_WaitOnEventInterruptible(event, releaseCB, clientData); } /* *----------------------------------------------------------------------------- * * VMCI_WaitOnEventInterruptible -- * * Results: * True if the wait was interrupted by a signal, false otherwise. * * Side effects: * None. * *----------------------------------------------------------------------------- */ Bool VMCI_WaitOnEventInterruptible(VMCIEvent *event, // IN: VMCIEventReleaseCB releaseCB, // IN: void *clientData) // IN: { DECLARE_WAITQUEUE(wait, current); if (event == NULL || releaseCB == NULL) { return FALSE; } add_wait_queue(event, &wait); current->state = TASK_INTERRUPTIBLE; /* * Release the lock or other primitive that makes it possible for us to * put the current thread on the wait queue without missing the signal. * Ie. on Linux we need to put ourselves on the wait queue and set our * stateto TASK_INTERRUPTIBLE without another thread signalling us. * The releaseCB is used to synchronize this. */ releaseCB(clientData); schedule(); current->state = TASK_RUNNING; remove_wait_queue(event, &wait); return signal_pending(current); } /* *----------------------------------------------------------------------------- * * VMCIMutex_Init -- * * Initializes the mutex. Must be called before use. * * Results: * Success. * * Side effects: * None. * *----------------------------------------------------------------------------- */ int VMCIMutex_Init(VMCIMutex *mutex, // IN char *name, // IN: Unused VMCILockRank rank) // IN: Unused { sema_init(mutex, 1); return VMCI_SUCCESS; } /* *----------------------------------------------------------------------------- * * VMCIMutex_Destroy -- * * Destroys the mutex. Does nothing on Linux. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ void VMCIMutex_Destroy(VMCIMutex *mutex) // IN: Unused { } /* *----------------------------------------------------------------------------- * * VMCIMutex_Acquire -- * * Acquires the mutex. * * Results: * None. * * Side effects: * Thread may block. * *----------------------------------------------------------------------------- */ void VMCIMutex_Acquire(VMCIMutex *mutex) // IN: { down(mutex); } /* *----------------------------------------------------------------------------- * * VMCIMutex_Release -- * * Releases the mutex. * * Results: * None. * * Side effects: * May wake up the thread blocking on this mutex. * *----------------------------------------------------------------------------- */ void VMCIMutex_Release(VMCIMutex *mutex) // IN: { up(mutex); } /* *----------------------------------------------------------------------------- * * VMCI_AllocQueue -- * * Allocates kernel queue pages of specified size with IOMMU mappings, * plus space for the queue structure/kernel interface and the queue * header. * * Results: * Pointer to the queue on success, NULL otherwise. * * Side effects: * Memory is allocated. * *----------------------------------------------------------------------------- */ void * VMCI_AllocQueue(uint64 size, // IN: size of queue (not including header) uint32 flags) // IN: queuepair flags { size_t i; VMCIQueue *queue; const size_t numPages = CEILING(size, PAGE_SIZE) + 1; const size_t pasSize = numPages * sizeof *queue->kernelIf->u.g.pas; const size_t vasSize = numPages * sizeof *queue->kernelIf->u.g.vas; const size_t queueSize = sizeof *queue + sizeof *(queue->kernelIf) + pasSize + vasSize; /* * Size should be enforced by VMCIQPair_Alloc(), double-check here. * Allocating too much on Linux can cause the system to become * unresponsive, because we allocate page-by-page, and we allow the * system to wait for pages rather than fail. */ if (size > VMCI_MAX_GUEST_QP_MEMORY) { ASSERT(FALSE); return NULL; } queue = vmalloc(queueSize); if (!queue) { return NULL; } queue->qHeader = NULL; queue->savedHeader = NULL; queue->kernelIf = (VMCIQueueKernelIf *)(queue + 1); queue->kernelIf->mutex = NULL; queue->kernelIf->numPages = numPages; queue->kernelIf->u.g.pas = (dma_addr_t *)(queue->kernelIf + 1); queue->kernelIf->u.g.vas = (void **)((uint8 *)queue->kernelIf->u.g.pas + pasSize); queue->kernelIf->host = FALSE; for (i = 0; i < numPages; i++) { queue->kernelIf->u.g.vas[i] = dma_alloc_coherent(&vmci_pdev->dev, PAGE_SIZE, &queue->kernelIf->u.g.pas[i], GFP_KERNEL); if (!queue->kernelIf->u.g.vas[i]) { VMCI_FreeQueue(queue, i * PAGE_SIZE); /* Size excl. the header. */ return NULL; } } /* Queue header is the first page. */ queue->qHeader = queue->kernelIf->u.g.vas[0]; return (void *)queue; } /* *----------------------------------------------------------------------------- * * VMCI_FreeQueue -- * * Frees kernel VA space for a given queue and its queue header, and * frees physical data pages. * * Results: * None. * * Side effects: * Memory is freed. * *----------------------------------------------------------------------------- */ void VMCI_FreeQueue(void *q, // IN: uint64 size) // IN: size of queue (not including header) { VMCIQueue *queue = q; if (queue) { uint64 i; /* Given size does not include header, so add in a page here. */ for (i = 0; i < CEILING(size, PAGE_SIZE) + 1; i++) { dma_free_coherent(&vmci_pdev->dev, PAGE_SIZE, queue->kernelIf->u.g.vas[i], queue->kernelIf->u.g.pas[i]); } vfree(queue); } } /* *----------------------------------------------------------------------------- * * VMCI_AllocPPNSet -- * * Allocates two list of PPNs --- one for the pages in the produce queue, * and the other for the pages in the consume queue. Intializes the list * of PPNs with the page frame numbers of the KVA for the two queues (and * the queue headers). * * Results: * Success or failure. * * Side effects: * Memory may be allocated. * *----------------------------------------------------------------------------- */ int VMCI_AllocPPNSet(void *prodQ, // IN: uint64 numProducePages, // IN: for queue plus header void *consQ, // IN: uint64 numConsumePages, // IN: for queue plus header PPNSet *ppnSet) // OUT: { VMCIPpnList producePPNs; VMCIPpnList consumePPNs; VMCIQueue *produceQ = prodQ; VMCIQueue *consumeQ = consQ; uint64 i; if (!produceQ || !numProducePages || !consumeQ || !numConsumePages || !ppnSet) { return VMCI_ERROR_INVALID_ARGS; } if (ppnSet->initialized) { return VMCI_ERROR_ALREADY_EXISTS; } producePPNs = VMCI_AllocKernelMem(numProducePages * sizeof *producePPNs, VMCI_MEMORY_NORMAL); if (!producePPNs) { return VMCI_ERROR_NO_MEM; } consumePPNs = VMCI_AllocKernelMem(numConsumePages * sizeof *consumePPNs, VMCI_MEMORY_NORMAL); if (!consumePPNs) { VMCI_FreeKernelMem(producePPNs, numProducePages * sizeof *producePPNs); return VMCI_ERROR_NO_MEM; } for (i = 0; i < numProducePages; i++) { unsigned long pfn; producePPNs[i] = pfn = produceQ->kernelIf->u.g.pas[i] >> PAGE_SHIFT; /* * Fail allocation if PFN isn't supported by hypervisor. */ if (sizeof pfn > sizeof *producePPNs && pfn != producePPNs[i]) { goto ppnError; } } for (i = 0; i < numConsumePages; i++) { unsigned long pfn; consumePPNs[i] = pfn = consumeQ->kernelIf->u.g.pas[i] >> PAGE_SHIFT; /* * Fail allocation if PFN isn't supported by hypervisor. */ if (sizeof pfn > sizeof *consumePPNs && pfn != consumePPNs[i]) { goto ppnError; } } ppnSet->numProducePages = numProducePages; ppnSet->numConsumePages = numConsumePages; ppnSet->producePPNs = producePPNs; ppnSet->consumePPNs = consumePPNs; ppnSet->initialized = TRUE; return VMCI_SUCCESS; ppnError: VMCI_FreeKernelMem(producePPNs, numProducePages * sizeof *producePPNs); VMCI_FreeKernelMem(consumePPNs, numConsumePages * sizeof *consumePPNs); return VMCI_ERROR_INVALID_ARGS; } /* *----------------------------------------------------------------------------- * * VMCI_FreePPNSet -- * * Frees the two list of PPNs for a queue pair. * * Results: * None. * * Side effects: * None. * *----------------------------------------------------------------------------- */ void VMCI_FreePPNSet(PPNSet *ppnSet) // IN: { ASSERT(ppnSet); if (ppnSet->initialized) { /* Do not call these functions on NULL inputs. */ ASSERT(ppnSet->producePPNs && ppnSet->consumePPNs); VMCI_FreeKernelMem(ppnSet->producePPNs, ppnSet->numProducePages * sizeof *ppnSet->producePPNs); VMCI_FreeKernelMem(ppnSet->consumePPNs, ppnSet->numConsumePages * sizeof *ppnSet->consumePPNs); } memset(ppnSet, 0, sizeof *ppnSet); } /* *----------------------------------------------------------------------------- * * VMCI_PopulatePPNList -- * * Populates the list of PPNs in the hypercall structure with the PPNS * of the produce queue and the consume queue. * * Results: * VMCI_SUCCESS. * * Side effects: * None. * *----------------------------------------------------------------------------- */ int VMCI_PopulatePPNList(uint8 *callBuf, // OUT: const PPNSet *ppnSet) // IN: { ASSERT(callBuf && ppnSet && ppnSet->initialized); memcpy(callBuf, ppnSet->producePPNs, ppnSet->numProducePages * sizeof *ppnSet->producePPNs); memcpy(callBuf + ppnSet->numProducePages * sizeof *ppnSet->producePPNs, ppnSet->consumePPNs, ppnSet->numConsumePages * sizeof *ppnSet->consumePPNs); return VMCI_SUCCESS; } #ifdef __KERNEL__ /* *----------------------------------------------------------------------------- * * __VMCIMemcpyToQueue -- * * Copies from a given buffer or iovector to a VMCI Queue. Uses * kmap()/kunmap() to dynamically map/unmap required portions of the queue * by traversing the offset -> page translation structure for the queue. * Assumes that offset + size does not wrap around in the queue. * * Results: * Zero on success, negative error code on failure. * * Side effects: * None. * *----------------------------------------------------------------------------- */ int __VMCIMemcpyToQueue(VMCIQueue *queue, // OUT: uint64 queueOffset, // IN: const void *src, // IN: size_t size, // IN: Bool isIovec) // IN: if src is a struct iovec * { VMCIQueueKernelIf *kernelIf = queue->kernelIf; size_t bytesCopied = 0; while (bytesCopied < size) { const uint64 pageIndex = (queueOffset + bytesCopied) / PAGE_SIZE; const size_t pageOffset = (queueOffset + bytesCopied) & (PAGE_SIZE - 1); void *va; size_t toCopy; if (kernelIf->host) { va = kmap(kernelIf->u.h.page[pageIndex]); } else { va = kernelIf->u.g.vas[pageIndex + 1]; /* Skip header. */ } ASSERT(va); if (size - bytesCopied > PAGE_SIZE - pageOffset) { /* Enough payload to fill up from this page. */ toCopy = PAGE_SIZE - pageOffset; } else { toCopy = size - bytesCopied; } if (isIovec) { struct iovec *iov = (struct iovec *)src; int err; /* The iovec will track bytesCopied internally. */ err = memcpy_fromiovec((uint8 *)va + pageOffset, iov, toCopy); if (err != 0) { if (kernelIf->host) { kunmap(kernelIf->u.h.page[pageIndex]); } return VMCI_ERROR_INVALID_ARGS; } } else { memcpy((uint8 *)va + pageOffset, (uint8 *)src + bytesCopied, toCopy); } bytesCopied += toCopy; if (kernelIf->host) { kunmap(kernelIf->u.h.page[pageIndex]); } } return VMCI_SUCCESS; } /* *----------------------------------------------------------------------------- * * __VMCIMemcpyFromQueue -- * * Copies to a given buffer or iovector from a VMCI Queue. Uses * kmap()/kunmap() to dynamically map/unmap required portions of the queue * by traversing the offset -> page translation structure for the queue. * Assumes that offset + size does not wrap around in the queue. * * Results: * Zero on success, negative error code on failure. * * Side effects: * None. * *----------------------------------------------------------------------------- */ int __VMCIMemcpyFromQueue(void *dest, // OUT: const VMCIQueue *queue, // IN: uint64 queueOffset, // IN: size_t size, // IN: Bool isIovec) // IN: if dest is a struct iovec * { VMCIQueueKernelIf *kernelIf = queue->kernelIf; size_t bytesCopied = 0; while (bytesCopied < size) { const uint64 pageIndex = (queueOffset + bytesCopied) / PAGE_SIZE; const size_t pageOffset = (queueOffset + bytesCopied) & (PAGE_SIZE - 1); void *va; size_t toCopy; if (kernelIf->host) { va = kmap(kernelIf->u.h.page[pageIndex]); } else { va = kernelIf->u.g.vas[pageIndex + 1]; /* Skip header. */ } ASSERT(va); if (size - bytesCopied > PAGE_SIZE - pageOffset) { /* Enough payload to fill up this page. */ toCopy = PAGE_SIZE - pageOffset; } else { toCopy = size - bytesCopied; } if (isIovec) { struct iovec *iov = (struct iovec *)dest; int err; /* The iovec will track bytesCopied internally. */ err = memcpy_toiovec(iov, (uint8 *)va + pageOffset, toCopy); if (err != 0) { if (kernelIf->host) { kunmap(kernelIf->u.h.page[pageIndex]); } return VMCI_ERROR_INVALID_ARGS; } } else { memcpy((uint8 *)dest + bytesCopied, (uint8 *)va + pageOffset, toCopy); } bytesCopied += toCopy; if (kernelIf->host) { kunmap(kernelIf->u.h.page[pageIndex]); } } return VMCI_SUCCESS; } /* *----------------------------------------------------------------------------- * * VMCIMemcpyToQueue -- * * Copies from a given buffer to a VMCI Queue. * * Results: * Zero on success, negative error code on failure. * * Side effects: * None. * *----------------------------------------------------------------------------- */ int VMCIMemcpyToQueue(VMCIQueue *queue, // OUT: uint64 queueOffset, // IN: const void *src, // IN: size_t srcOffset, // IN: size_t size, // IN: int bufType, // IN: Unused Bool canBlock) // IN: Unused { ASSERT(canBlock || !queue->kernelIf->host); return __VMCIMemcpyToQueue(queue, queueOffset, (uint8 *)src + srcOffset, size, FALSE); } /* *----------------------------------------------------------------------------- * * VMCIMemcpyFromQueue -- * * Copies to a given buffer from a VMCI Queue. * * Results: * Zero on success, negative error code on failure. * * Side effects: * None. * *----------------------------------------------------------------------------- */ int VMCIMemcpyFromQueue(void *dest, // OUT: size_t destOffset, // IN: const VMCIQueue *queue, // IN: uint64 queueOffset, // IN: size_t size, // IN: int bufType, // IN: Unused Bool canBlock) // IN: Unused { ASSERT(canBlock || !queue->kernelIf->host); return __VMCIMemcpyFromQueue((uint8 *)dest + destOffset, queue, queueOffset, size, FALSE); } /* *----------------------------------------------------------------------------- * * VMCIMemcpyToQueueLocal -- * * Copies from a given buffer to a local VMCI queue. On Linux, this is the * same as a regular copy. * * Results: * Zero on success, negative error code on failure. * * Side effects: * None. * *----------------------------------------------------------------------------- */ int VMCIMemcpyToQueueLocal(VMCIQueue *queue, // OUT uint64 queueOffset, // IN const void *src, // IN size_t srcOffset, // IN size_t size, // IN int bufType, // IN: Unused Bool canBlock) // IN: Unused { ASSERT(canBlock || !queue->kernelIf->host); return __VMCIMemcpyToQueue(queue, queueOffset, (uint8 *)src + srcOffset, size, FALSE);; } /* *----------------------------------------------------------------------------- * * VMCIMemcpyFromQueueLocal -- * * Copies to a given buffer from a VMCI Queue. * * Results: * Zero on success, negative error code on failure. * * Side effects: * None. * *----------------------------------------------------------------------------- */ int VMCIMemcpyFromQueueLocal(void *dest, // OUT: size_t destOffset, // IN: const VMCIQueue *queue, // IN: uint64 queueOffset, // IN: size_t size, // IN: int bufType, // IN: Unused Bool canBlock) // IN: Unused { ASSERT(canBlock || !queue->kernelIf->host); return __VMCIMemcpyFromQueue((uint8 *)dest + destOffset, queue, queueOffset, size, FALSE); } /* *---------------------------------------------------------------------------- * * VMCIMemcpyToQueueV -- * * Copies from a given iovec from a VMCI Queue. * * Results: * Zero on success, negative error code on failure. * * Side effects: * None. * *---------------------------------------------------------------------------- */ int VMCIMemcpyToQueueV(VMCIQueue *queue, // OUT: uint64 queueOffset, // IN: const void *src, // IN: iovec size_t srcOffset, // IN: ignored size_t size, // IN: int bufType, // IN: Unused Bool canBlock) // IN: Unused { ASSERT(canBlock || !queue->kernelIf->host); /* * We ignore srcOffset because src is really a struct iovec * and will * maintain offset internally. */ return __VMCIMemcpyToQueue(queue, queueOffset, src, size, TRUE); } /* *---------------------------------------------------------------------------- * * VMCIMemcpyFromQueueV -- * * Copies to a given iovec from a VMCI Queue. * * Results: * Zero on success, negative error code on failure. * * Side effects: * None. * *---------------------------------------------------------------------------- */ int VMCIMemcpyFromQueueV(void *dest, // OUT: iovec size_t destOffset, // IN: ignored const VMCIQueue *queue, // IN: uint64 queueOffset, // IN: size_t size, // IN: int bufType, // IN: Unused Bool canBlock) // IN: Unused { ASSERT(canBlock || !queue->kernelIf->host); /* * We ignore destOffset because dest is really a struct iovec * and will * maintain offset internally. */ return __VMCIMemcpyFromQueue(dest, queue, queueOffset, size, TRUE); } #endif /* *----------------------------------------------------------------------------- * * VMCIWellKnownID_AllowMap -- * * Checks whether the calling context is allowed to register for the given * well known service ID. Currently returns FALSE if the service ID is * within the reserved range and VMCI_PRIVILEGE_FLAG_TRUSTED is not * provided as the input privilege flags. Otherwise returns TRUE. * XXX TODO access control based on host configuration information; this * will be platform specific implementation. * * Results: * Boolean value indicating access granted or denied. * * Side effects: * None. * *----------------------------------------------------------------------------- */ Bool VMCIWellKnownID_AllowMap(VMCIId wellKnownID, // IN: VMCIPrivilegeFlags privFlags) // IN: { if (wellKnownID < VMCI_RESERVED_RESOURCE_ID_MAX && !(privFlags & VMCI_PRIVILEGE_FLAG_TRUSTED)) { return FALSE; } return TRUE; } /* *----------------------------------------------------------------------------- * * VMCIHost_AllocQueue -- * * Allocates kernel VA space of specified size plus space for the queue * and kernel interface. This is different from the guest queue allocator, * because we do not allocate our own queue header/data pages here but * share those of the guest. * * Results: * A pointer to an allocated and initialized VMCIQueue structure or NULL. * * Side effects: * None. * *----------------------------------------------------------------------------- */ VMCIQueue * VMCIHost_AllocQueue(uint64 size) // IN: { VMCIQueue *queue; const size_t numPages = CEILING(size, PAGE_SIZE) + 1; const size_t queueSize = sizeof *queue + sizeof *(queue->kernelIf); const size_t queuePageSize = numPages * sizeof *queue->kernelIf->u.h.page; queue = VMCI_AllocKernelMem(queueSize + queuePageSize, VMCI_MEMORY_NORMAL); if (queue) { queue->qHeader = NULL; queue->savedHeader = NULL; queue->kernelIf = (VMCIQueueKernelIf *)(queue + 1); queue->kernelIf->host = TRUE; queue->kernelIf->mutex = NULL; queue->kernelIf->numPages = numPages; queue->kernelIf->u.h.headerPage = (struct page **)((uint8*)queue + queueSize); queue->kernelIf->u.h.page = &queue->kernelIf->u.h.headerPage[1]; memset(queue->kernelIf->u.h.headerPage, 0, (sizeof *queue->kernelIf->u.h.headerPage * queue->kernelIf->numPages)); } return queue; } /* *----------------------------------------------------------------------------- * * VMCIHost_FreeQueue -- * * Frees kernel memory for a given queue (header plus translation * structure). * * Results: * None. * * Side effects: * Memory is freed. * *----------------------------------------------------------------------------- */ void VMCIHost_FreeQueue(VMCIQueue *queue, // IN: uint64 queueSize) // IN: { if (queue) { const uint queueSize = sizeof *queue + sizeof *(queue->kernelIf); VMCI_FreeKernelMem(queue, queueSize); } } /* *----------------------------------------------------------------------------- * * VMCI_InitQueueMutex() * * Initialize the mutex for the pair of queues. This mutex is used to * protect the qHeader and the buffer from changing out from under any * users of either queue. Of course, it's only any good if the mutexes * are actually acquired. Queue structure must lie on non-paged memory * or we cannot guarantee access to the mutex. * * Results: * None. * * Side Effects: * None. * *---------------------------------------------------------------------------- */ void VMCI_InitQueueMutex(VMCIQueue *produceQ, // IN/OUT VMCIQueue *consumeQ) // IN/OUT { ASSERT(produceQ); ASSERT(consumeQ); ASSERT(produceQ->kernelIf); ASSERT(consumeQ->kernelIf); /* * Only the host queue has shared state - the guest queues do not * need to synchronize access using a queue mutex. */ if (produceQ->kernelIf->host) { produceQ->kernelIf->mutex = &produceQ->kernelIf->__mutex; consumeQ->kernelIf->mutex = &produceQ->kernelIf->__mutex; sema_init(produceQ->kernelIf->mutex, 1); } } /* *----------------------------------------------------------------------------- * * VMCI_CleanupQueueMutex() * * Cleans up the mutex for the pair of queues. * * Results: * None. * * Side Effects: * None. * *---------------------------------------------------------------------------- */ void VMCI_CleanupQueueMutex(VMCIQueue *produceQ, // IN/OUT VMCIQueue *consumeQ) // IN/OUT { ASSERT(produceQ); ASSERT(consumeQ); ASSERT(produceQ->kernelIf); ASSERT(consumeQ->kernelIf); if (produceQ->kernelIf->host) { produceQ->kernelIf->mutex = NULL; consumeQ->kernelIf->mutex = NULL; } } /* *----------------------------------------------------------------------------- * * VMCI_AcquireQueueMutex() * * Acquire the mutex for the queue. Note that the produceQ and * the consumeQ share a mutex. So, only one of the two need to * be passed in to this routine. Either will work just fine. * * Results: * VMCI_SUCCESS always. * * Side Effects: * May block the caller. * *---------------------------------------------------------------------------- */ int VMCI_AcquireQueueMutex(VMCIQueue *queue, // IN Bool canBlock) // IN: Unused { ASSERT(queue); ASSERT(queue->kernelIf); if (queue->kernelIf->host) { ASSERT(canBlock); ASSERT(queue->kernelIf->mutex); down(queue->kernelIf->mutex); } return VMCI_SUCCESS; } /* *----------------------------------------------------------------------------- * * VMCI_ReleaseQueueMutex() * * Release the mutex for the queue. Note that the produceQ and * the consumeQ share a mutex. So, only one of the two need to * be passed in to this routine. Either will work just fine. * * Results: * None. * * Side Effects: * May block the caller. * *---------------------------------------------------------------------------- */ void VMCI_ReleaseQueueMutex(VMCIQueue *queue) // IN { ASSERT(queue); ASSERT(queue->kernelIf); if (queue->kernelIf->host) { ASSERT(queue->kernelIf->mutex); up(queue->kernelIf->mutex); } } /* *----------------------------------------------------------------------------- * * VMCI_LockQueueHeader() * * Acquire a spinlock guarding the queue header. Note that the produceQ * and the consumeQ share the lock mutex. So, only one of the two need to * be passed in to this routine. Either will work just fine. * * Results: * None. * * Side Effects: * None. * *---------------------------------------------------------------------------- */ void VMCI_LockQueueHeader(VMCIQueue *queue) // IN { ASSERT(queue); ASSERT(queue->kernelIf); ASSERT(!queue->kernelIf->host); /* * We don't support non-blocking on the host right now, so we won't get * here for a host queue. And there's no lock required on the guest. So * this is a NOP. */ } /* *----------------------------------------------------------------------------- * * VMCI_UnlockQueueHeader() * * Release the spinlock guarding the queue header. * * Results: * None. * * Side Effects: * None. * *---------------------------------------------------------------------------- */ void VMCI_UnlockQueueHeader(VMCIQueue *queue) // IN { ASSERT(queue); ASSERT(queue->kernelIf); ASSERT(!queue->kernelIf->host); } /* *----------------------------------------------------------------------------- * * VMCIReleasePageStorePages -- * * Helper function to release pages in the PageStoreAttachInfo * previously obtained using get_user_pages. * * Results: * None. * * Side Effects: * None. * *----------------------------------------------------------------------------- */ static void VMCIReleasePages(struct page **pages, // IN uint64 numPages, // IN Bool dirty) // IN { int i; for (i = 0; i < numPages; i++) { ASSERT(pages[i]); if (dirty) { set_page_dirty(pages[i]); } page_cache_release(pages[i]); pages[i] = NULL; } } /* *----------------------------------------------------------------------------- * * VMCIHost_RegisterUserMemory -- * * Registers the specification of the user pages used for backing a queue * pair. Enough information to map in pages is stored in the OS specific * part of the VMCIQueue structure. * * Results: * VMCI_SUCCESS on sucess, negative error code on failure. * * Side Effects: * None. * *----------------------------------------------------------------------------- */ int VMCIHost_RegisterUserMemory(QueuePairPageStore *pageStore, // IN VMCIQueue *produceQ, // OUT VMCIQueue *consumeQ) // OUT { VA64 produceUVA; VA64 consumeUVA; ASSERT(produceQ->kernelIf->u.h.headerPage && consumeQ->kernelIf->u.h.headerPage); /* * The new style and the old style mapping only differs in that we either * get a single or two UVAs, so we split the single UVA range at the * appropriate spot. */ produceUVA = pageStore->pages; consumeUVA = pageStore->pages + produceQ->kernelIf->numPages * PAGE_SIZE; return VMCIHost_GetUserMemory(produceUVA, consumeUVA, produceQ, consumeQ); } /* *----------------------------------------------------------------------------- * * VMCIHost_UnregisterUserMemory -- * * Releases and removes the references to user pages stored in the attach * struct. * * Results: * None * * Side Effects: * Pages are released from the page cache and may become * swappable again. * *----------------------------------------------------------------------------- */ void VMCIHost_UnregisterUserMemory(VMCIQueue *produceQ, // IN/OUT VMCIQueue *consumeQ) // IN/OUT { ASSERT(produceQ->kernelIf); ASSERT(consumeQ->kernelIf); ASSERT(!produceQ->qHeader && !consumeQ->qHeader); VMCIReleasePages(produceQ->kernelIf->u.h.headerPage, produceQ->kernelIf->numPages, TRUE); memset(produceQ->kernelIf->u.h.headerPage, 0, (sizeof *produceQ->kernelIf->u.h.headerPage * produceQ->kernelIf->numPages)); VMCIReleasePages(consumeQ->kernelIf->u.h.headerPage, consumeQ->kernelIf->numPages, TRUE); memset(consumeQ->kernelIf->u.h.headerPage, 0, (sizeof *consumeQ->kernelIf->u.h.headerPage * consumeQ->kernelIf->numPages)); } /* *----------------------------------------------------------------------------- * * VMCIHost_MapQueues -- * * Once VMCIHost_RegisterUserMemory has been performed on a * queue, the queue pair headers can be mapped into the * kernel. Once mapped, they must be unmapped with * VMCIHost_UnmapQueues prior to calling * VMCIHost_UnregisterUserMemory. * * Results: * VMCI_SUCCESS if pages are mapped, appropriate error code otherwise. * * Side Effects: * Pages are pinned. * *----------------------------------------------------------------------------- */ int VMCIHost_MapQueues(VMCIQueue *produceQ, // IN/OUT VMCIQueue *consumeQ, // IN/OUT uint32 flags) // UNUSED { int result; if (!produceQ->qHeader || !consumeQ->qHeader) { struct page *headers[2]; if (produceQ->qHeader != consumeQ->qHeader) { return VMCI_ERROR_QUEUEPAIR_MISMATCH; } if (produceQ->kernelIf->u.h.headerPage == NULL || *produceQ->kernelIf->u.h.headerPage == NULL) { return VMCI_ERROR_UNAVAILABLE; } ASSERT(*produceQ->kernelIf->u.h.headerPage && *consumeQ->kernelIf->u.h.headerPage); headers[0] = *produceQ->kernelIf->u.h.headerPage; headers[1] = *consumeQ->kernelIf->u.h.headerPage; produceQ->qHeader = vmap(headers, 2, VM_MAP, PAGE_KERNEL); if (produceQ->qHeader != NULL) { consumeQ->qHeader = (VMCIQueueHeader *)((uint8 *)produceQ->qHeader + PAGE_SIZE); result = VMCI_SUCCESS; } else { Log("vmap failed\n"); result = VMCI_ERROR_NO_MEM; } } else { result = VMCI_SUCCESS; } return result; } /* *----------------------------------------------------------------------------- * * VMCIHost_UnmapQueues -- * * Unmaps previously mapped queue pair headers from the kernel. * * Results: * VMCI_SUCCESS always. * * Side Effects: * Pages are unpinned. * *----------------------------------------------------------------------------- */ int VMCIHost_UnmapQueues(VMCIGuestMemID gid, // IN VMCIQueue *produceQ, // IN/OUT VMCIQueue *consumeQ) // IN/OUT { if (produceQ->qHeader) { ASSERT(consumeQ->qHeader); if (produceQ->qHeader < consumeQ->qHeader) { vunmap(produceQ->qHeader); } else { vunmap(consumeQ->qHeader); } produceQ->qHeader = NULL; consumeQ->qHeader = NULL; } return VMCI_SUCCESS; } /* *----------------------------------------------------------------------------- * * VMCIHost_GetUserMemory -- * * * Lock the user pages referenced by the {produce,consume}Buffer * struct into memory and populate the {produce,consume}Pages * arrays in the attach structure with them. * * Results: * VMCI_SUCCESS on sucess, negative error code on failure. * * Side Effects: * None. * *----------------------------------------------------------------------------- */ int VMCIHost_GetUserMemory(VA64 produceUVA, // IN VA64 consumeUVA, // IN VMCIQueue *produceQ, // OUT VMCIQueue *consumeQ) // OUT { int retval; int err = VMCI_SUCCESS; down_write(¤t->mm->mmap_sem); #if LINUX_VERSION_CODE >= KERNEL_VERSION(4, 6, 0) retval = get_user_pages((VA)produceUVA, produceQ->kernelIf->numPages, 1, 0, produceQ->kernelIf->u.h.headerPage, NULL); #else retval = get_user_pages(current, current->mm, (VA)produceUVA, produceQ->kernelIf->numPages, 1, 0, produceQ->kernelIf->u.h.headerPage, NULL); #endif if (retval < produceQ->kernelIf->numPages) { Log("get_user_pages(produce) failed (retval=%d)\n", retval); VMCIReleasePages(produceQ->kernelIf->u.h.headerPage, retval, FALSE); err = VMCI_ERROR_NO_MEM; goto out; } retval = get_user_pages(current, current->mm, (VA)consumeUVA, consumeQ->kernelIf->numPages, 1, 0, consumeQ->kernelIf->u.h.headerPage, NULL); if (retval < consumeQ->kernelIf->numPages) { Log("get_user_pages(consume) failed (retval=%d)\n", retval); VMCIReleasePages(consumeQ->kernelIf->u.h.headerPage, retval, FALSE); VMCIReleasePages(produceQ->kernelIf->u.h.headerPage, produceQ->kernelIf->numPages, FALSE); err = VMCI_ERROR_NO_MEM; } out: up_write(¤t->mm->mmap_sem); return err; } /* *----------------------------------------------------------------------------- * * VMCIHost_ReleaseUserMemory -- * Release the reference to user pages stored in the attach * struct * * Results: * None * * Side Effects: * Pages are released from the page cache and may become * swappable again. * *----------------------------------------------------------------------------- */ void VMCIHost_ReleaseUserMemory(VMCIQueue *produceQ, // IN/OUT VMCIQueue *consumeQ) // IN/OUT { ASSERT(produceQ->kernelIf->u.h.headerPage); VMCIHost_UnregisterUserMemory(produceQ, consumeQ); } /* *----------------------------------------------------------------------------- * * VMCI_ReadPortBytes -- * * Copy memory from an I/O port to kernel memory. * * Results: * No results. * * Side effects: * None. * *----------------------------------------------------------------------------- */ void VMCI_ReadPortBytes(VMCIIoHandle handle, // IN: Unused VMCIIoPort port, // IN uint8 *buffer, // OUT size_t bufferLength) // IN { insb(port, buffer, bufferLength); } vmci-only/linux/vmci_version.h 0000444 0000000 0000000 00000002205 13432725347 015513 0 ustar root root /********************************************************* * Copyright (C) 2007-2017 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_version.h -- * * Version definitions for the Linux vmci driver. */ #ifndef _VMCI_VERSION_H_ #define _VMCI_VERSION_H_ #define VMCI_DRIVER_VERSION 9.8.2.0 #define VMCI_DRIVER_VERSION_COMMAS 9,8,2,0 #define VMCI_DRIVER_VERSION_STRING "9.8.2.0" #endif /* _VMCI_VERSION_H_ */ vmci-only/Makefile.kernel 0000444 0000000 0000000 00000004206 13432725347 014422 0 ustar root root #!/usr/bin/make -f ########################################################## # Copyright (C) 2007,2014 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 # ########################################################## CC_OPTS += -DVMCI INCLUDE += -I$(SRCROOT)/shared -I$(SRCROOT)/common -I$(SRCROOT)/linux EXTRA_CFLAGS := $(CC_OPTS) $(INCLUDE) obj-m += $(DRIVER).o $(DRIVER)-y := $(subst $(SRCROOT)/, , $(patsubst %.c, %.o, \ $(wildcard $(SRCROOT)/linux/*.c $(SRCROOT)/common/*.c))) # # In open-vm-tools, need to compile the common sources from the shared directory. # DRIVERLOG := driverLog.o $(DRIVER)-y += $(DRIVERLOG) VMCI_PATH := $(shell cd $(SRCROOT) && pwd) ifdef OVT_SOURCE_DIR DRIVERLOG_PATH := $(OVT_SOURCE_DIR)/modules/linux/shared else DRIVERLOG_PATH := $(VMCI_PATH)/shared endif $(addprefix $(VMCI_PATH)/,$(DRIVERLOG)): $(VMCI_PATH)/%.o: $(DRIVERLOG_PATH)/%.c $(Q)$(rule_cc_o_c) clean: rm -rf $(wildcard $(DRIVER).mod.c $(DRIVER).ko .tmp_versions \ Module.symvers Modules.symvers Module.markers modules.order \ $(foreach dir,linux/ common/ \ ./,$(addprefix $(dir),.*.cmd .*.o.flags *.o))) ifneq ($(MODULEBUILDDIR),) rm -f $(MODULEBUILDDIR)/VMwareVMCIModule.symvers endif # # If this build generated a Module.symvers, copy it to a public place where # the vSockets build will be able to find it. # postbuild:: ifeq ($(call vm_check_file,$(SRCROOT)/Module.symvers), yes) ifneq ($(MODULEBUILDDIR),) cp -f $(SRCROOT)/Module.symvers $(MODULEBUILDDIR)/VMwareVMCIModule.symvers endif endif