]> git.saurik.com Git - apple/xnu.git/blobdiff - osfmk/i386/cpu_capabilities.h
xnu-792.12.6.tar.gz
[apple/xnu.git] / osfmk / i386 / cpu_capabilities.h
index 6270145f1d699c1bbb52a4779b27b6fd0e4b6456..2c10fc47898784da65c62600350ce91796399765 100644 (file)
@@ -1,23 +1,31 @@
 /*
- * Copyright (c) 2003-2006 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2003-2005 Apple Computer, Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
  * 
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
- * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
- * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
- * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
- * 
- * @APPLE_LICENSE_HEADER_END@
+ * This file contains Original Code and/or Modifications of Original Code 
+ * as defined in and that are subject to the Apple Public Source License 
+ * Version 2.0 (the 'License'). You may not use this file except in 
+ * compliance with the License.  The rights granted to you under the 
+ * License may not be used to create, or enable the creation or 
+ * redistribution of, unlawful or unlicensed copies of an Apple operating 
+ * system, or to circumvent, violate, or enable the circumvention or 
+ * violation of, any terms of an Apple operating system software license 
+ * agreement.
+ *
+ * Please obtain a copy of the License at 
+ * http://www.opensource.apple.com/apsl/ and read it before using this 
+ * file.
+ *
+ * The Original Code and all software distributed under the License are 
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 
+ * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 
+ * Please see the License for the specific language governing rights and 
+ * limitations under the License.
+ *
+ * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  */
 #ifdef PRIVATE
 
 #endif
  
 /*
+ * This is the authoritative way to determine from user mode what
+ * implementation-specific processor features are available.
  * This API only supported for Apple internal use.
+ * 
  */
 
 /* Bit definitions for _cpu_capabilities: */
 #define        kHasSSE                         0x00000002
 #define        kHasSSE2                        0x00000004
 #define        kHasSSE3                        0x00000008
-#define        kCache32                        0x00000010      /* cache line size is 32 bytes */
+#define        kCache32                        0x00000010      // cache line size is 32 bytes
 #define        kCache64                        0x00000020
 #define        kCache128                       0x00000040
-#define        kFastThreadLocalStorage         0x00000080      /* TLS ptr is kept in a user-mode-readable register */
-#define kHasSupplementalSSE3   0x00000100
-#define kHasMNI                                kHasSupplementalSSE3
-#define        k64Bit                          0x00000200      /* processor supports EM64T (not what mode you're running in) */
+#define        kFastThreadLocalStorage         0x00000080      // TLS ptr is kept in a user-mode-readable register
 
-#define        kUP                             0x00008000      /* set if (kNumCPUs == 1) */
-#define        kNumCPUs                        0x00FF0000      /* number of CPUs (see _NumCPUs() below) */
+#define        kUP                             0x00008000      // set if (kNumCPUs == 1)
+#define        kNumCPUs                        0x00FF0000      // number of CPUs (see _NumCPUs() below)
 
-#define        kNumCPUsShift                   16              /* see _NumCPUs() below */
+#define        kNumCPUsShift           16                      // see _NumCPUs() below
 
 #ifndef        __ASSEMBLER__
 #include <sys/cdefs.h>
@@ -70,137 +78,92 @@ int _NumCPUs( void )
 /*
  * The shared kernel/user "comm page(s)":
  *
- * The last several pages of every address space are reserved for the kernel/user
- * "comm area". During system initialization, the kernel populates the comm pages with
+ * The last eight pages of every address space are reserved for the kernel/user
+ * "comm area". During system initialization, the kernel populates the comm page with
  * code customized for the particular processor and platform.
  *
- * Because Mach VM cannot map the last page of an address space, we don't use it.
+ * Because Mach VM cannot map the last page of an address space, the max length of
+ * the comm area is seven pages.
  */
  
-#define        _COMM_PAGE32_AREA_LENGTH        ( 19 * 4096 )                           /* reserved length of entire comm area */
-#define _COMM_PAGE32_BASE_ADDRESS      ( -20 * 4096 )                          /* base address of allocated memory */
-#define _COMM_PAGE32_START_ADDRESS     ( -16 * 4096 )                          /* address traditional commpage code starts on */
-#define _COMM_PAGE32_AREA_USED         ( 19 * 4096 )                           /* this is the amt actually allocated */
-
-#define        _COMM_PAGE64_AREA_LENGTH        ( 2 * 1024 * 1024 )                     /* reserved length of entire comm area (2MB) */
-#define _COMM_PAGE64_BASE_ADDRESS      ( 0x00007fffffe00000ULL )               /* base address of allocated memory */
-#define _COMM_PAGE64_START_ADDRESS     ( _COMM_PAGE64_BASE_ADDRESS )           /* address traditional commpage code starts on */
-#define _COMM_PAGE64_AREA_USED         ( 2 * 4096 )                            /* this is the amt actually populated */
-
-
-#if defined(__i386__)
-
-#define        _COMM_PAGE_AREA_LENGTH          _COMM_PAGE32_AREA_LENGTH
-#define _COMM_PAGE_BASE_ADDRESS                _COMM_PAGE32_BASE_ADDRESS
-#define _COMM_PAGE_START_ADDRESS       _COMM_PAGE32_START_ADDRESS
-#define _COMM_PAGE_AREA_USED           _COMM_PAGE32_AREA_USED
-#define _COMM_PAGE_SIGS_OFFSET         0x8000                                  /* offset to routine signatures */
-
-#elif defined(__x86_64__)
-
-#define        _COMM_PAGE_AREA_LENGTH          _COMM_PAGE64_AREA_LENGTH
-#define _COMM_PAGE_BASE_ADDRESS                _COMM_PAGE64_BASE_ADDRESS
-#define _COMM_PAGE_START_ADDRESS       _COMM_PAGE64_START_ADDRESS
-#define _COMM_PAGE_AREA_USED           _COMM_PAGE64_AREA_USED
-
-#else
-#error architecture not supported
-#endif
+#define        _COMM_PAGE_AREA_LENGTH  (19*4096)
+                                       // reserved length of entire comm area
+#define _COMM_PAGE_BASE_ADDRESS (-20*4096)
+                                       // VM_MAX_ADDRESS-_COMM_PAGE_AREA_LENGTH
+#define _COMM_PAGE_START_ADDRESS (-16*4096)
+                                       // VM_MAX_ADDRESS-_COMM_PAGE_AREA_LENGTH
+#define _COMM_PAGE_SIGS_OFFSET 0x8000
+                                       // offset to routine signatures
  
 /* data in the comm page */
  
-#define _COMM_PAGE_SIGNATURE           (_COMM_PAGE_START_ADDRESS+0x000)        /* first few bytes are a signature */
-#define _COMM_PAGE_VERSION             (_COMM_PAGE_START_ADDRESS+0x01E)        /* 16-bit version# */
-#define        _COMM_PAGE_THIS_VERSION         6                                       /* version of the commarea format */
+#define _COMM_PAGE_SIGNATURE                   (_COMM_PAGE_START_ADDRESS+0x000)        // first few bytes are a signature
+#define _COMM_PAGE_VERSION                             (_COMM_PAGE_START_ADDRESS+0x01E)        // 16-bit version#
+#define        _COMM_PAGE_THIS_VERSION                 3                                                               // version of the commarea format
   
-#define _COMM_PAGE_CPU_CAPABILITIES    (_COMM_PAGE_START_ADDRESS+0x020)        /* uint32_t _cpu_capabilities */
-#define _COMM_PAGE_NCPUS               (_COMM_PAGE_START_ADDRESS+0x022)        /* uint8_t number of configured CPUs */
-#define _COMM_PAGE_CACHE_LINESIZE      (_COMM_PAGE_START_ADDRESS+0x026)        /* uint16_t cache line size */
-
-#define _COMM_PAGE_UNUSED1             (_COMM_PAGE_START_ADDRESS+0x028)        /* 24 unused bytes */
+#define _COMM_PAGE_CPU_CAPABILITIES            (_COMM_PAGE_START_ADDRESS+0x020)        // uint32_t _cpu_capabilities
+#define _COMM_PAGE_NCPUS                               (_COMM_PAGE_START_ADDRESS+0x021)        // uint8_t number of configured CPUs
+#define _COMM_PAGE_VECTOR_FLAVOR               (_COMM_PAGE_START_ADDRESS+0x024)        // uint8_t SSE/SSE2/SSE3 
+#define _COMM_PAGE_CACHE_LINESIZE              (_COMM_PAGE_START_ADDRESS+0x026)        // uint16_t cache line size
  
-#if defined(__i386__)                                                          /* following are not defined in 64-bit */
-#define _COMM_PAGE_2_TO_52             (_COMM_PAGE_START_ADDRESS+0x040)        /* double float constant 2**52 */
-#define _COMM_PAGE_10_TO_6             (_COMM_PAGE_START_ADDRESS+0x048)        /* double float constant 10**6 */
-#else
-#define _COMM_PAGE_UNUSED2             (_COMM_PAGE_START_ADDRESS+0x040)        /* 16 unused bytes */
-#endif
-
-#define _COMM_PAGE_NT_TSC_BASE         (_COMM_PAGE_START_ADDRESS+0x050)        /* used by nanotime() */
-#define _COMM_PAGE_NT_SCALE            (_COMM_PAGE_START_ADDRESS+0x058)        /* used by nanotime() */
-#define _COMM_PAGE_NT_SHIFT            (_COMM_PAGE_START_ADDRESS+0x05c)        /* used by nanotime() */
-#define _COMM_PAGE_NT_NS_BASE          (_COMM_PAGE_START_ADDRESS+0x060)        /* used by nanotime() */
+#define _COMM_PAGE_UNUSED1                             (_COMM_PAGE_START_ADDRESS+0x030)        // 16 unused bytes
  
-#define _COMM_PAGE_TIMEBASE            (_COMM_PAGE_START_ADDRESS+0x068)        /* used by gettimeofday() */
-#define _COMM_PAGE_TIMESTAMP           (_COMM_PAGE_START_ADDRESS+0x070)        /* used by gettimeofday() */
-#define _COMM_PAGE_TIMEENABLE          (_COMM_PAGE_START_ADDRESS+0x078)        /* used by gettimeofday() */
-
-#define        _NT_TSC_BASE                    0                                       /* offsets into nanotime data */
-#define        _NT_SCALE                       8
-#define        _NT_SHIFT                       12
-#define        _NT_NS_BASE                     16
-#define        _TIMEBASE                       0                                       /* offsets into gettimeofday data */
-#define        _TIMESTAMP                      8
-#define        _TIMEENABLE                     16
+#define _COMM_PAGE_2_TO_52                             (_COMM_PAGE_START_ADDRESS+0x040)        // double float constant 2**52
+#define _COMM_PAGE_10_TO_6                             (_COMM_PAGE_START_ADDRESS+0x048)        // double float constant 10**6
  
- /* jump table (jmp to this address, which may be a branch to the actual code somewhere else) */
- /* When new jump table entries are added, corresponding symbols should be added below         */
-
-#define _COMM_PAGE_COMPARE_AND_SWAP32   (_COMM_PAGE_START_ADDRESS+0x080)       /* compare-and-swap word */
-#define _COMM_PAGE_COMPARE_AND_SWAP64   (_COMM_PAGE_START_ADDRESS+0x0c0)       /* compare-and-swap doubleword */
-#define _COMM_PAGE_ENQUEUE              (_COMM_PAGE_START_ADDRESS+0x100)       /* enqueue */
-#define _COMM_PAGE_DEQUEUE              (_COMM_PAGE_START_ADDRESS+0x140)       /* dequeue */
-#define _COMM_PAGE_MEMORY_BARRIER       (_COMM_PAGE_START_ADDRESS+0x180)       /* memory barrier */
-#define _COMM_PAGE_ATOMIC_ADD32         (_COMM_PAGE_START_ADDRESS+0x1a0)       /* add atomic word */
-#define _COMM_PAGE_ATOMIC_ADD64         (_COMM_PAGE_START_ADDRESS+0x1c0)       /* add atomic doubleword */
-
-#define        _COMM_PAGE_UNUSED3              (_COMM_PAGE_START_ADDRESS+0x1e0)        /* 32 unused bytes */
-
-#define _COMM_PAGE_ABSOLUTE_TIME       (_COMM_PAGE_START_ADDRESS+0x200)        /* mach_absolute_time() */
-#define _COMM_PAGE_SPINLOCK_TRY                (_COMM_PAGE_START_ADDRESS+0x220)        /* spinlock_try() */
-#define _COMM_PAGE_SPINLOCK_LOCK       (_COMM_PAGE_START_ADDRESS+0x260)        /* spinlock_lock() */
-#define _COMM_PAGE_SPINLOCK_UNLOCK     (_COMM_PAGE_START_ADDRESS+0x2a0)        /* spinlock_unlock() */
-#define _COMM_PAGE_PTHREAD_GETSPECIFIC  (_COMM_PAGE_START_ADDRESS+0x2c0)       /* pthread_getspecific() */
-#define _COMM_PAGE_GETTIMEOFDAY                (_COMM_PAGE_START_ADDRESS+0x2e0)        /* used by gettimeofday() */
-#define _COMM_PAGE_FLUSH_DCACHE                (_COMM_PAGE_START_ADDRESS+0x4e0)        /* sys_dcache_flush() */
-#define _COMM_PAGE_FLUSH_ICACHE                (_COMM_PAGE_START_ADDRESS+0x520)        /* sys_icache_invalidate() */
-#define _COMM_PAGE_PTHREAD_SELF                (_COMM_PAGE_START_ADDRESS+0x580)        /* pthread_self() */
-
-#define _COMM_PAGE_UNUSED4             (_COMM_PAGE_START_ADDRESS+0x5a0)        /* 32 unused bytes */
-
-#define _COMM_PAGE_RELINQUISH          (_COMM_PAGE_START_ADDRESS+0x5c0)        /* used by spinlocks */ 
-#define _COMM_PAGE_BTS                 (_COMM_PAGE_START_ADDRESS+0x5e0)        /* bit test-and-set */
-#define _COMM_PAGE_BTC                 (_COMM_PAGE_START_ADDRESS+0x5f0)        /* bit test-and-clear */
+#define _COMM_PAGE_UNUSED2                             (_COMM_PAGE_START_ADDRESS+0x050)        // 16 unused bytes
+#define _COMM_PAGE_TIMEBASE                            (_COMM_PAGE_START_ADDRESS+0x060)        // used by gettimeofday()
+#define _COMM_PAGE_TIMESTAMP                   (_COMM_PAGE_START_ADDRESS+0x068)        // used by gettimeofday()
+#define _COMM_PAGE_SEC_PER_TICK                        (_COMM_PAGE_START_ADDRESS+0x070)        // used by gettimeofday()
  
-#define _COMM_PAGE_BZERO               (_COMM_PAGE_START_ADDRESS+0x600)        /* bzero() */
-#define _COMM_PAGE_BCOPY               (_COMM_PAGE_START_ADDRESS+0x780)        /* bcopy() */
-#define        _COMM_PAGE_MEMCPY               (_COMM_PAGE_START_ADDRESS+0x7a0)        /* memcpy() */
-#define        _COMM_PAGE_MEMMOVE              (_COMM_PAGE_START_ADDRESS+0x7a0)        /* memmove() */
+ /* jump table (bla to this address, which may be a branch to the actual code somewhere else) */
+ /* When new jump table entries are added, corresponding symbols should be added below         */
 
-#define        _COMM_PAGE_OLD_NANOTIME         (_COMM_PAGE_START_ADDRESS+0xf80)        /* old nanotime location (deprecated) */
-#define        _COMM_PAGE_MEMSET_PATTERN       (_COMM_PAGE_START_ADDRESS+0x1000)       /* used by nonzero memset() */
-#define        _COMM_PAGE_LONGCOPY             (_COMM_PAGE_START_ADDRESS+0x1200)       /* used by bcopy() for very long operands */
+#define _COMM_PAGE_COMPARE_AND_SWAP32   (_COMM_PAGE_START_ADDRESS+0x080) // compare-and-swap word
+#define _COMM_PAGE_COMPARE_AND_SWAP64   (_COMM_PAGE_START_ADDRESS+0x0c0) // compare-and-swap doubleword
+#define _COMM_PAGE_ENQUEUE              (_COMM_PAGE_START_ADDRESS+0x100) // enqueue
+#define _COMM_PAGE_DEQUEUE              (_COMM_PAGE_START_ADDRESS+0x140) // dequeue
+#define _COMM_PAGE_MEMORY_BARRIER       (_COMM_PAGE_START_ADDRESS+0x180) // add atomic doubleword
+#define _COMM_PAGE_ATOMIC_ADD32         (_COMM_PAGE_START_ADDRESS+0x1a0) // add atomic word
+#define _COMM_PAGE_ATOMIC_ADD64         (_COMM_PAGE_START_ADDRESS+0x1c0) // add atomic doubleword
 
-#define _COMM_PAGE_SYSTEM_INTEGRITY    (_COMM_PAGE_START_ADDRESS+0x1600)       /* system integrity data, 256 bytes */
+#define _COMM_PAGE_NANOTIME_INFO        (_COMM_PAGE_START_ADDRESS+0x1e0) // 32 bytes used by nanotime()
+#define _COMM_PAGE_ABSOLUTE_TIME               (_COMM_PAGE_START_ADDRESS+0x200)        // mach_absolute_time()
+#define _COMM_PAGE_SPINLOCK_TRY                        (_COMM_PAGE_START_ADDRESS+0x220)        // spinlock_try()
+#define _COMM_PAGE_SPINLOCK_LOCK               (_COMM_PAGE_START_ADDRESS+0x260)        // spinlock_lock()
+#define _COMM_PAGE_SPINLOCK_UNLOCK             (_COMM_PAGE_START_ADDRESS+0x2a0)        // spinlock_unlock()
+#define _COMM_PAGE_PTHREAD_GETSPECIFIC  (_COMM_PAGE_START_ADDRESS+0x2c0)       // pthread_getspecific()
+#define _COMM_PAGE_GETTIMEOFDAY                        (_COMM_PAGE_START_ADDRESS+0x2e0)        // used by gettimeofday()
+#define _COMM_PAGE_FLUSH_DCACHE                        (_COMM_PAGE_START_ADDRESS+0x4e0)        // sys_dcache_flush()
+#define _COMM_PAGE_FLUSH_ICACHE                        (_COMM_PAGE_START_ADDRESS+0x520)        // sys_icache_invalidate()
+#define _COMM_PAGE_PTHREAD_SELF                        (_COMM_PAGE_START_ADDRESS+0x580)        // pthread_self()
+#define _COMM_PAGE_UNUSED4                             (_COMM_PAGE_START_ADDRESS+0x5a0)        // 32 unused bytes
+#define _COMM_PAGE_RELINQUISH                  (_COMM_PAGE_START_ADDRESS+0x5c0) // used by spinlocks
+#define _COMM_PAGE_BTS                         (_COMM_PAGE_START_ADDRESS+0x5e0) // bit test-and-set 
+#define _COMM_PAGE_BTC                                 (_COMM_PAGE_START_ADDRESS+0x5f0) // bit test-and-clear 
+#define _COMM_PAGE_BZERO                               (_COMM_PAGE_START_ADDRESS+0x600)        // bzero()
+#define _COMM_PAGE_BCOPY                               (_COMM_PAGE_START_ADDRESS+0x780)        // bcopy()
+#define        _COMM_PAGE_MEMCPY                               (_COMM_PAGE_START_ADDRESS+0x7a0)        // memcpy()
+#define        _COMM_PAGE_MEMMOVE                              (_COMM_PAGE_START_ADDRESS+0x7a0)        // memmove()
 
-#define        _COMM_PAGE_NANOTIME             (_COMM_PAGE_START_ADDRESS+0x1700)       /* nanotime() */
+#define        _COMM_PAGE_NANOTIME                             (_COMM_PAGE_START_ADDRESS+0xF80) // nanotime()
 
-#define _COMM_PAGE_END                 (_COMM_PAGE_START_ADDRESS+0x1780)       /* end of common page - insert new stuff here */
+#define        _COMM_PAGE_BIGCOPY                              (_COMM_PAGE_START_ADDRESS+0x1000)// very-long-operand copies
 
-/* _COMM_PAGE_COMPARE_AND_SWAP{32,64}B are not used on x86 and are
- * maintained here for source compatability.  These will be removed at
- * some point, so don't go relying on them. */
-#define _COMM_PAGE_COMPARE_AND_SWAP32B  (_COMM_PAGE_START_ADDRESS+0xf80)       /* compare-and-swap word w barrier */
-#define _COMM_PAGE_COMPARE_AND_SWAP64B  (_COMM_PAGE_START_ADDRESS+0xfc0)       /* compare-and-swap doubleword w barrier */
+#define _COMM_PAGE_END                                 (_COMM_PAGE_START_ADDRESS+0x1600)// end of common page
 
 #ifdef __ASSEMBLER__
 #ifdef __COMM_PAGE_SYMBOLS
 
 #define CREATE_COMM_PAGE_SYMBOL(symbol_name, symbol_address)           \
-                               .org    (symbol_address - (_COMM_PAGE_START_ADDRESS & 0xFFFFE000)) ;\
+                               .org    (symbol_address - (_COMM_PAGE_BASE_ADDRESS & 0xFFFFE000)) ;\
 symbol_name: nop
 
-       .text           /* Required to make a well behaved symbol file */
+       .text           // Required to make a well behaved symbol file
 
        CREATE_COMM_PAGE_SYMBOL(___compare_and_swap32, _COMM_PAGE_COMPARE_AND_SWAP32)
        CREATE_COMM_PAGE_SYMBOL(___compare_and_swap64, _COMM_PAGE_COMPARE_AND_SWAP64)
@@ -224,15 +187,13 @@ symbol_name: nop
        CREATE_COMM_PAGE_SYMBOL(___bzero, _COMM_PAGE_BZERO)
        CREATE_COMM_PAGE_SYMBOL(___bcopy, _COMM_PAGE_BCOPY)
        CREATE_COMM_PAGE_SYMBOL(___memcpy, _COMM_PAGE_MEMCPY)
-/*     CREATE_COMM_PAGE_SYMBOL(___memmove, _COMM_PAGE_MEMMOVE) */
-       CREATE_COMM_PAGE_SYMBOL(___old_nanotime, _COMM_PAGE_OLD_NANOTIME)
-       CREATE_COMM_PAGE_SYMBOL(___memset_pattern, _COMM_PAGE_MEMSET_PATTERN)
-       CREATE_COMM_PAGE_SYMBOL(___longcopy, _COMM_PAGE_LONGCOPY)
+//     CREATE_COMM_PAGE_SYMBOL(___memmove, _COMM_PAGE_MEMMOVE)
+       CREATE_COMM_PAGE_SYMBOL(___bigcopy, _COMM_PAGE_BIGCOPY)
        CREATE_COMM_PAGE_SYMBOL(___nanotime, _COMM_PAGE_NANOTIME)
        CREATE_COMM_PAGE_SYMBOL(___end_comm_page, _COMM_PAGE_END)
 
-       .data           /* Required to make a well behaved symbol file */
-       .long   0       /* Required to make a well behaved symbol file */
+       .data           // Required to make a well behaved symbol file
+       .long   0       // Required to make a well behaved symbol file
 
 #endif /* __COMM_PAGE_SYMBOLS */
 #endif /* __ASSEMBLER__ */