/********************************************************* * Copyright (C) 2003-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 * *********************************************************/ /* * 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)) /* * provides definitions for: * NULL, offsetof * References: * C90 7.17, C99 7.19, C11 7.19 */ #if !defined(VMKERNEL) # include #else /* * Vmkernel's bogus __FreeBSD__ value causes gcc to break. * Work around by doing similar things. Bug 2116887 and 2229647. */ # ifndef offsetof /* * 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. */ # if defined VMKERNEL_GDB_MACRO_BUILDER # define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER) # else # define offsetof __builtin_offsetof # endif # endif # ifndef NULL # ifdef __cplusplus # define NULL 0 # else # define NULL ((void *)0) # endif # endif #endif // VMKERNEL #if defined _WIN32 && defined USERLEVEL #include // for Sleep() and LOWORD() etc. #undef GetFreeSpace // Unpollute preprocessor namespace. #endif /* * Simple macros */ #define VMW_CONTAINER_OF(ptr, type, member) \ ((type *)((char *)(ptr) - 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 #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)) /* * 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 __x86_64__ || defined __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 KBYTES_SHIFT #define KBYTES_SHIFT 10 #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_KBYTES #define BYTES_2_KBYTES(_nbytes) ((_nbytes) >> KBYTES_SHIFT) #endif #ifndef KBYTES_2_BYTES #define KBYTES_2_BYTES(_nbytes) ((uint64)(_nbytes) << KBYTES_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 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 // } _WIN32 #endif // } USERLEVEL #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 #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(...) __VA_ARGS__ #else #define vmx86_debug 0 #define DEBUG_ONLY(...) #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 vmx86_vmm 1 #define VMM_ONLY(x) x #else #define vmx86_vmm 0 #define VMM_ONLY(x) #endif #ifdef ULM #define vmx86_ulm 1 #define ULM_ONLY(x) x #else #define vmx86_ulm 0 #define ULM_ONLY(x) #endif #if defined(VMM) || defined(ULM) #define MONITOR_ONLY(x) x #else #define MONITOR_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 #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 // _WIN32 /* * 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 MONITOR_ONLY(PERVCPU) 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) /* * -Wswitch means that when you pass switch an enum that it's looking for * all values from that enum, and only that enum, to be accounted for. * "default:;" is fine for catching values you don't care about. But today * we have a bunch of code that uses internal and external enum values, or * in other words combines two enums into a single variable. This cast is * the workaround, but we really need to fix this mess. */ #define UNCHECKED_SWITCH__FIXME(x) switch ((uint64)(x)) /* * When clang static analyzer parses source files, it implicitly defines * __clang_analyzer__ macro. We use this to define our custom macro to stop * its execution for the current path of analysis by calling a function that * doesn't return, making it think that it hit a failed assertion. * * DO NOT use to silence the analyzer! See PR2447238. */ #ifdef __clang_analyzer__ #define VMW_CLANG_ANALYZER_NORETURN() Panic("Disable Clang static analyzer") #else #define VMW_CLANG_ANALYZER_NORETURN() ((void)0) #endif #endif // ifndef _VM_BASIC_DEFS_H_