osfmk/i386/cpu_capabilities.h

   1 /*
   2  * Copyright (c) 2003-2006 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License.  The rights granted to you under the
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 #ifdef  PRIVATE
  31
  32 #ifndef _I386_CPU_CAPABILITIES_H
  33 #define _I386_CPU_CAPABILITIES_H
  34
  35 #ifndef __ASSEMBLER__
  36 #include <stdint.h>
  37 #endif
  38
  39 /*
  40  * This API only supported for Apple internal use.
  41  */
  42
  43 /* Bit definitions for _cpu_capabilities: */
  44
  45 #define kHasMMX                         0x00000001
  46 #define kHasSSE                         0x00000002
  47 #define kHasSSE2                        0x00000004
  48 #define kHasSSE3                        0x00000008
  49 #define kCache32                        0x00000010      /* cache line size is 32 bytes */
  50 #define kCache64                        0x00000020
  51 #define kCache128                       0x00000040
  52 #define kFastThreadLocalStorage         0x00000080      /* TLS ptr is kept in a user-mode-readable register */
  53 #define kHasSupplementalSSE3    0x00000100
  54 #define kHasMNI                         kHasSupplementalSSE3
  55 #define k64Bit                          0x00000200      /* processor supports EM64T (not what mode you're running in) */
  56
  57 #define kUP                             0x00008000      /* set if (kNumCPUs == 1) */
  58 #define kNumCPUs                        0x00FF0000      /* number of CPUs (see _NumCPUs() below) */
  59
  60 #define kNumCPUsShift                   16              /* see _NumCPUs() below */
  61
  62 #ifndef __ASSEMBLER__
  63 #include <sys/cdefs.h>
  64
  65 __BEGIN_DECLS
  66 extern int  _get_cpu_capabilities( void );
  67 __END_DECLS
  68
  69 inline static
  70 int _NumCPUs( void )
  71 {
  72         return (_get_cpu_capabilities() & kNumCPUs) >> kNumCPUsShift;
  73 }
  74
  75 #endif /* __ASSEMBLER__ */
  76
  77
  78 /*
  79  * The shared kernel/user "comm page(s)":
  80  *
  81  * The last several pages of every address space are reserved for the kernel/user
  82  * "comm area". During system initialization, the kernel populates the comm pages with
  83  * code customized for the particular processor and platform.
  84  *
  85  * Because Mach VM cannot map the last page of an address space, we don't use it.
  86  */
  87
  88 #define _COMM_PAGE32_AREA_LENGTH        ( 19 * 4096 )                           /* reserved length of entire comm area */
  89 #define _COMM_PAGE32_BASE_ADDRESS       ( -20 * 4096 )                          /* base address of allocated memory */
  90 #define _COMM_PAGE32_START_ADDRESS      ( -16 * 4096 )                          /* address traditional commpage code starts on */
  91 #define _COMM_PAGE32_AREA_USED          ( 19 * 4096 )                           /* this is the amt actually allocated */
  92
  93 #define _COMM_PAGE64_AREA_LENGTH        ( 2 * 1024 * 1024 )                     /* reserved length of entire comm area (2MB) */
  94 #define _COMM_PAGE64_BASE_ADDRESS       ( 0x00007fffffe00000ULL )               /* base address of allocated memory */
  95 #define _COMM_PAGE64_START_ADDRESS      ( _COMM_PAGE64_BASE_ADDRESS )           /* address traditional commpage code starts on */
  96 #define _COMM_PAGE64_AREA_USED          ( 2 * 4096 )                            /* this is the amt actually populated */
  97
  98
  99 #if defined(__i386__)
 100
 101 #define _COMM_PAGE_AREA_LENGTH          _COMM_PAGE32_AREA_LENGTH
 102 #define _COMM_PAGE_BASE_ADDRESS         _COMM_PAGE32_BASE_ADDRESS
 103 #define _COMM_PAGE_START_ADDRESS        _COMM_PAGE32_START_ADDRESS
 104 #define _COMM_PAGE_AREA_USED            _COMM_PAGE32_AREA_USED
 105 #define _COMM_PAGE_SIGS_OFFSET          0x8000                                  /* offset to routine signatures */
 106
 107 #elif defined(__x86_64__)
 108
 109 #define _COMM_PAGE_AREA_LENGTH          _COMM_PAGE64_AREA_LENGTH
 110 #define _COMM_PAGE_BASE_ADDRESS         _COMM_PAGE64_BASE_ADDRESS
 111 #define _COMM_PAGE_START_ADDRESS        _COMM_PAGE64_START_ADDRESS
 112 #define _COMM_PAGE_AREA_USED            _COMM_PAGE64_AREA_USED
 113
 114 #else
 115 #error architecture not supported
 116 #endif
 117
 118 /* data in the comm page */
 119
 120 #define _COMM_PAGE_SIGNATURE            (_COMM_PAGE_START_ADDRESS+0x000)        /* first few bytes are a signature */
 121 #define _COMM_PAGE_VERSION              (_COMM_PAGE_START_ADDRESS+0x01E)        /* 16-bit version# */
 122 #define _COMM_PAGE_THIS_VERSION         6                                       /* version of the commarea format */
 123
 124 #define _COMM_PAGE_CPU_CAPABILITIES     (_COMM_PAGE_START_ADDRESS+0x020)        /* uint32_t _cpu_capabilities */
 125 #define _COMM_PAGE_NCPUS                (_COMM_PAGE_START_ADDRESS+0x022)        /* uint8_t number of configured CPUs */
 126 #define _COMM_PAGE_CACHE_LINESIZE       (_COMM_PAGE_START_ADDRESS+0x026)        /* uint16_t cache line size */
 127
 128 #define _COMM_PAGE_UNUSED1              (_COMM_PAGE_START_ADDRESS+0x028)        /* 24 unused bytes */
 129
 130 #if defined(__i386__)                                                           /* following are not defined in 64-bit */
 131 #define _COMM_PAGE_2_TO_52              (_COMM_PAGE_START_ADDRESS+0x040)        /* double float constant 2**52 */
 132 #define _COMM_PAGE_10_TO_6              (_COMM_PAGE_START_ADDRESS+0x048)        /* double float constant 10**6 */
 133 #else
 134 #define _COMM_PAGE_UNUSED2              (_COMM_PAGE_START_ADDRESS+0x040)        /* 16 unused bytes */
 135 #endif
 136
 137 #define _COMM_PAGE_NT_TSC_BASE          (_COMM_PAGE_START_ADDRESS+0x050)        /* used by nanotime() */
 138 #define _COMM_PAGE_NT_SCALE             (_COMM_PAGE_START_ADDRESS+0x058)        /* used by nanotime() */
 139 #define _COMM_PAGE_NT_SHIFT             (_COMM_PAGE_START_ADDRESS+0x05c)        /* used by nanotime() */
 140 #define _COMM_PAGE_NT_NS_BASE           (_COMM_PAGE_START_ADDRESS+0x060)        /* used by nanotime() */
 141
 142 #define _COMM_PAGE_TIMEBASE             (_COMM_PAGE_START_ADDRESS+0x068)        /* used by gettimeofday() */
 143 #define _COMM_PAGE_TIMESTAMP            (_COMM_PAGE_START_ADDRESS+0x070)        /* used by gettimeofday() */
 144 #define _COMM_PAGE_TIMEENABLE           (_COMM_PAGE_START_ADDRESS+0x078)        /* used by gettimeofday() */
 145
 146 #define _NT_TSC_BASE                    0                                       /* offsets into nanotime data */
 147 #define _NT_SCALE                       8
 148 #define _NT_SHIFT                       12
 149 #define _NT_NS_BASE                     16
 150 #define _TIMEBASE                       0                                       /* offsets into gettimeofday data */
 151 #define _TIMESTAMP                      8
 152 #define _TIMEENABLE                     16
 153
 154  /* jump table (jmp to this address, which may be a branch to the actual code somewhere else) */
 155  /* When new jump table entries are added, corresponding symbols should be added below         */
 156
 157 #define _COMM_PAGE_COMPARE_AND_SWAP32   (_COMM_PAGE_START_ADDRESS+0x080)        /* compare-and-swap word */
 158 #define _COMM_PAGE_COMPARE_AND_SWAP64   (_COMM_PAGE_START_ADDRESS+0x0c0)        /* compare-and-swap doubleword */
 159 #define _COMM_PAGE_ENQUEUE              (_COMM_PAGE_START_ADDRESS+0x100)        /* enqueue */
 160 #define _COMM_PAGE_DEQUEUE              (_COMM_PAGE_START_ADDRESS+0x140)        /* dequeue */
 161 #define _COMM_PAGE_MEMORY_BARRIER       (_COMM_PAGE_START_ADDRESS+0x180)        /* memory barrier */
 162 #define _COMM_PAGE_ATOMIC_ADD32         (_COMM_PAGE_START_ADDRESS+0x1a0)        /* add atomic word */
 163 #define _COMM_PAGE_ATOMIC_ADD64         (_COMM_PAGE_START_ADDRESS+0x1c0)        /* add atomic doubleword */
 164
 165 #define _COMM_PAGE_UNUSED3              (_COMM_PAGE_START_ADDRESS+0x1e0)        /* 32 unused bytes */
 166
 167 #define _COMM_PAGE_ABSOLUTE_TIME        (_COMM_PAGE_START_ADDRESS+0x200)        /* mach_absolute_time() */
 168 #define _COMM_PAGE_SPINLOCK_TRY         (_COMM_PAGE_START_ADDRESS+0x220)        /* spinlock_try() */
 169 #define _COMM_PAGE_SPINLOCK_LOCK        (_COMM_PAGE_START_ADDRESS+0x260)        /* spinlock_lock() */
 170 #define _COMM_PAGE_SPINLOCK_UNLOCK      (_COMM_PAGE_START_ADDRESS+0x2a0)        /* spinlock_unlock() */
 171 #define _COMM_PAGE_PTHREAD_GETSPECIFIC  (_COMM_PAGE_START_ADDRESS+0x2c0)        /* pthread_getspecific() */
 172 #define _COMM_PAGE_GETTIMEOFDAY         (_COMM_PAGE_START_ADDRESS+0x2e0)        /* used by gettimeofday() */
 173 #define _COMM_PAGE_FLUSH_DCACHE         (_COMM_PAGE_START_ADDRESS+0x4e0)        /* sys_dcache_flush() */
 174 #define _COMM_PAGE_FLUSH_ICACHE         (_COMM_PAGE_START_ADDRESS+0x520)        /* sys_icache_invalidate() */
 175 #define _COMM_PAGE_PTHREAD_SELF         (_COMM_PAGE_START_ADDRESS+0x580)        /* pthread_self() */
 176
 177 #define _COMM_PAGE_UNUSED4              (_COMM_PAGE_START_ADDRESS+0x5a0)        /* 32 unused bytes */
 178
 179 #define _COMM_PAGE_RELINQUISH           (_COMM_PAGE_START_ADDRESS+0x5c0)        /* used by spinlocks */
 180 #define _COMM_PAGE_BTS                  (_COMM_PAGE_START_ADDRESS+0x5e0)        /* bit test-and-set */
 181 #define _COMM_PAGE_BTC                  (_COMM_PAGE_START_ADDRESS+0x5f0)        /* bit test-and-clear */
 182
 183 #define _COMM_PAGE_BZERO                (_COMM_PAGE_START_ADDRESS+0x600)        /* bzero() */
 184 #define _COMM_PAGE_BCOPY                (_COMM_PAGE_START_ADDRESS+0x780)        /* bcopy() */
 185 #define _COMM_PAGE_MEMCPY               (_COMM_PAGE_START_ADDRESS+0x7a0)        /* memcpy() */
 186 #define _COMM_PAGE_MEMMOVE              (_COMM_PAGE_START_ADDRESS+0x7a0)        /* memmove() */
 187
 188 #define _COMM_PAGE_OLD_NANOTIME         (_COMM_PAGE_START_ADDRESS+0xf80)        /* old nanotime location (deprecated) */
 189 #define _COMM_PAGE_MEMSET_PATTERN       (_COMM_PAGE_START_ADDRESS+0x1000)       /* used by nonzero memset() */
 190 #define _COMM_PAGE_LONGCOPY             (_COMM_PAGE_START_ADDRESS+0x1200)       /* used by bcopy() for very long operands */
 191
 192 #define _COMM_PAGE_SYSTEM_INTEGRITY     (_COMM_PAGE_START_ADDRESS+0x1600)       /* system integrity data, 256 bytes */
 193
 194 #define _COMM_PAGE_NANOTIME             (_COMM_PAGE_START_ADDRESS+0x1700)       /* nanotime() */
 195
 196 #define _COMM_PAGE_END                  (_COMM_PAGE_START_ADDRESS+0x1780)       /* end of common page - insert new stuff here */
 197
 198 /* _COMM_PAGE_COMPARE_AND_SWAP{32,64}B are not used on x86 and are
 199  * maintained here for source compatability.  These will be removed at
 200  * some point, so don't go relying on them. */
 201 #define _COMM_PAGE_COMPARE_AND_SWAP32B  (_COMM_PAGE_START_ADDRESS+0xf80)        /* compare-and-swap word w barrier */
 202 #define _COMM_PAGE_COMPARE_AND_SWAP64B  (_COMM_PAGE_START_ADDRESS+0xfc0)        /* compare-and-swap doubleword w barrier */
 203
 204 #ifdef __ASSEMBLER__
 205 #ifdef __COMM_PAGE_SYMBOLS
 206
 207 #define CREATE_COMM_PAGE_SYMBOL(symbol_name, symbol_address)            \
 208                                 .org    (symbol_address - (_COMM_PAGE_START_ADDRESS & 0xFFFFE000)) ;\
 209 symbol_name: nop
 210
 211         .text           /* Required to make a well behaved symbol file */
 212
 213         CREATE_COMM_PAGE_SYMBOL(___compare_and_swap32, _COMM_PAGE_COMPARE_AND_SWAP32)
 214         CREATE_COMM_PAGE_SYMBOL(___compare_and_swap64, _COMM_PAGE_COMPARE_AND_SWAP64)
 215         CREATE_COMM_PAGE_SYMBOL(___atomic_enqueue, _COMM_PAGE_ENQUEUE)
 216         CREATE_COMM_PAGE_SYMBOL(___atomic_dequeue, _COMM_PAGE_DEQUEUE)
 217         CREATE_COMM_PAGE_SYMBOL(___memory_barrier, _COMM_PAGE_MEMORY_BARRIER)
 218         CREATE_COMM_PAGE_SYMBOL(___atomic_add32, _COMM_PAGE_ATOMIC_ADD32)
 219         CREATE_COMM_PAGE_SYMBOL(___atomic_add64, _COMM_PAGE_ATOMIC_ADD64)
 220         CREATE_COMM_PAGE_SYMBOL(___mach_absolute_time, _COMM_PAGE_ABSOLUTE_TIME)
 221         CREATE_COMM_PAGE_SYMBOL(___spin_lock_try, _COMM_PAGE_SPINLOCK_TRY)
 222         CREATE_COMM_PAGE_SYMBOL(___spin_lock, _COMM_PAGE_SPINLOCK_LOCK)
 223         CREATE_COMM_PAGE_SYMBOL(___spin_unlock, _COMM_PAGE_SPINLOCK_UNLOCK)
 224         CREATE_COMM_PAGE_SYMBOL(___pthread_getspecific, _COMM_PAGE_PTHREAD_GETSPECIFIC)
 225         CREATE_COMM_PAGE_SYMBOL(___gettimeofday, _COMM_PAGE_GETTIMEOFDAY)
 226         CREATE_COMM_PAGE_SYMBOL(___sys_dcache_flush, _COMM_PAGE_FLUSH_DCACHE)
 227         CREATE_COMM_PAGE_SYMBOL(___sys_icache_invalidate, _COMM_PAGE_FLUSH_ICACHE)
 228         CREATE_COMM_PAGE_SYMBOL(___pthread_self, _COMM_PAGE_PTHREAD_SELF)
 229         CREATE_COMM_PAGE_SYMBOL(___spin_lock_relinquish, _COMM_PAGE_RELINQUISH)
 230         CREATE_COMM_PAGE_SYMBOL(___bit_test_and_set, _COMM_PAGE_BTS)
 231         CREATE_COMM_PAGE_SYMBOL(___bit_test_and_clear, _COMM_PAGE_BTC)
 232         CREATE_COMM_PAGE_SYMBOL(___bzero, _COMM_PAGE_BZERO)
 233         CREATE_COMM_PAGE_SYMBOL(___bcopy, _COMM_PAGE_BCOPY)
 234         CREATE_COMM_PAGE_SYMBOL(___memcpy, _COMM_PAGE_MEMCPY)
 235 /*      CREATE_COMM_PAGE_SYMBOL(___memmove, _COMM_PAGE_MEMMOVE) */
 236         CREATE_COMM_PAGE_SYMBOL(___old_nanotime, _COMM_PAGE_OLD_NANOTIME)
 237         CREATE_COMM_PAGE_SYMBOL(___memset_pattern, _COMM_PAGE_MEMSET_PATTERN)
 238         CREATE_COMM_PAGE_SYMBOL(___longcopy, _COMM_PAGE_LONGCOPY)
 239         CREATE_COMM_PAGE_SYMBOL(___nanotime, _COMM_PAGE_NANOTIME)
 240         CREATE_COMM_PAGE_SYMBOL(___end_comm_page, _COMM_PAGE_END)
 241
 242         .data           /* Required to make a well behaved symbol file */
 243         .long   0       /* Required to make a well behaved symbol file */
 244
 245 #endif /* __COMM_PAGE_SYMBOLS */
 246 #endif /* __ASSEMBLER__ */
 247
 248 #endif /* _I386_CPU_CAPABILITIES_H */
 249 #endif /* PRIVATE */