osfmk/i386/cpu_capabilities.h

   1 /*
   2  * Copyright (c) 2003-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 #ifdef  PRIVATE
  23
  24 #ifndef _I386_CPU_CAPABILITIES_H
  25 #define _I386_CPU_CAPABILITIES_H
  26
  27 #ifndef __ASSEMBLER__
  28 #include <stdint.h>
  29 #endif
  30
  31 /*
  32  * This is the authoritative way to determine from user mode what
  33  * implementation-specific processor features are available.
  34  * This API only supported for Apple internal use.
  35  *
  36  */
  37
  38 /* Bit definitions for _cpu_capabilities: */
  39
  40 #define kHasMMX                         0x00000001
  41 #define kHasSSE                         0x00000002
  42 #define kHasSSE2                        0x00000004
  43 #define kHasSSE3                        0x00000008
  44 #define kCache32                        0x00000010      // cache line size is 32 bytes
  45 #define kCache64                        0x00000020
  46 #define kCache128                       0x00000040
  47 #define kFastThreadLocalStorage         0x00000080      // TLS ptr is kept in a user-mode-readable register
  48
  49 #define kUP                             0x00008000      // set if (kNumCPUs == 1)
  50 #define kNumCPUs                        0x00FF0000      // number of CPUs (see _NumCPUs() below)
  51
  52 #define kNumCPUsShift           16                      // see _NumCPUs() below
  53
  54 #ifndef __ASSEMBLER__
  55 #include <sys/cdefs.h>
  56
  57 __BEGIN_DECLS
  58 extern int  _get_cpu_capabilities( void );
  59 __END_DECLS
  60
  61 inline static
  62 int _NumCPUs( void )
  63 {
  64         return (_get_cpu_capabilities() & kNumCPUs) >> kNumCPUsShift;
  65 }
  66
  67 #endif /* __ASSEMBLER__ */
  68
  69
  70 /*
  71  * The shared kernel/user "comm page(s)":
  72  *
  73  * The last eight pages of every address space are reserved for the kernel/user
  74  * "comm area". During system initialization, the kernel populates the comm page with
  75  * code customized for the particular processor and platform.
  76  *
  77  * Because Mach VM cannot map the last page of an address space, the max length of
  78  * the comm area is seven pages.
  79  */
  80
  81 #define _COMM_PAGE_AREA_LENGTH  (19*4096)
  82                                         // reserved length of entire comm area
  83 #define _COMM_PAGE_BASE_ADDRESS (-20*4096)
  84                                         // VM_MAX_ADDRESS-_COMM_PAGE_AREA_LENGTH
  85 #define _COMM_PAGE_START_ADDRESS (-16*4096)
  86                                         // VM_MAX_ADDRESS-_COMM_PAGE_AREA_LENGTH
  87 #define _COMM_PAGE_SIGS_OFFSET  0x8000
  88                                         // offset to routine signatures
  89
  90 /* data in the comm page */
  91
  92 #define _COMM_PAGE_SIGNATURE                    (_COMM_PAGE_START_ADDRESS+0x000)        // first few bytes are a signature
  93 #define _COMM_PAGE_VERSION                              (_COMM_PAGE_START_ADDRESS+0x01E)        // 16-bit version#
  94 #define _COMM_PAGE_THIS_VERSION                 3                                                               // version of the commarea format
  95
  96 #define _COMM_PAGE_CPU_CAPABILITIES             (_COMM_PAGE_START_ADDRESS+0x020)        // uint32_t _cpu_capabilities
  97 #define _COMM_PAGE_NCPUS                                (_COMM_PAGE_START_ADDRESS+0x021)        // uint8_t number of configured CPUs
  98 #define _COMM_PAGE_VECTOR_FLAVOR                (_COMM_PAGE_START_ADDRESS+0x024)        // uint8_t SSE/SSE2/SSE3
  99 #define _COMM_PAGE_CACHE_LINESIZE               (_COMM_PAGE_START_ADDRESS+0x026)        // uint16_t cache line size
 100
 101 #define _COMM_PAGE_UNUSED1                              (_COMM_PAGE_START_ADDRESS+0x030)        // 16 unused bytes
 102
 103 #define _COMM_PAGE_2_TO_52                              (_COMM_PAGE_START_ADDRESS+0x040)        // double float constant 2**52
 104 #define _COMM_PAGE_10_TO_6                              (_COMM_PAGE_START_ADDRESS+0x048)        // double float constant 10**6
 105
 106 #define _COMM_PAGE_UNUSED2                              (_COMM_PAGE_START_ADDRESS+0x050)        // 16 unused bytes
 107
 108 #define _COMM_PAGE_TIMEBASE                             (_COMM_PAGE_START_ADDRESS+0x060)        // used by gettimeofday()
 109 #define _COMM_PAGE_TIMESTAMP                    (_COMM_PAGE_START_ADDRESS+0x068)        // used by gettimeofday()
 110 #define _COMM_PAGE_SEC_PER_TICK                 (_COMM_PAGE_START_ADDRESS+0x070)        // used by gettimeofday()
 111
 112  /* jump table (bla to this address, which may be a branch to the actual code somewhere else) */
 113  /* When new jump table entries are added, corresponding symbols should be added below         */
 114
 115 #define _COMM_PAGE_COMPARE_AND_SWAP32   (_COMM_PAGE_START_ADDRESS+0x080) // compare-and-swap word
 116 #define _COMM_PAGE_COMPARE_AND_SWAP64   (_COMM_PAGE_START_ADDRESS+0x0c0) // compare-and-swap doubleword
 117 #define _COMM_PAGE_ENQUEUE              (_COMM_PAGE_START_ADDRESS+0x100) // enqueue
 118 #define _COMM_PAGE_DEQUEUE              (_COMM_PAGE_START_ADDRESS+0x140) // dequeue
 119 #define _COMM_PAGE_MEMORY_BARRIER       (_COMM_PAGE_START_ADDRESS+0x180) // add atomic doubleword
 120 #define _COMM_PAGE_ATOMIC_ADD32         (_COMM_PAGE_START_ADDRESS+0x1a0) // add atomic word
 121 #define _COMM_PAGE_ATOMIC_ADD64         (_COMM_PAGE_START_ADDRESS+0x1c0) // add atomic doubleword
 122
 123 #define _COMM_PAGE_NANOTIME_INFO        (_COMM_PAGE_START_ADDRESS+0x1e0) // 32 bytes used by nanotime()
 124
 125 #define _COMM_PAGE_ABSOLUTE_TIME                (_COMM_PAGE_START_ADDRESS+0x200)        // mach_absolute_time()
 126 #define _COMM_PAGE_SPINLOCK_TRY                 (_COMM_PAGE_START_ADDRESS+0x220)        // spinlock_try()
 127 #define _COMM_PAGE_SPINLOCK_LOCK                (_COMM_PAGE_START_ADDRESS+0x260)        // spinlock_lock()
 128 #define _COMM_PAGE_SPINLOCK_UNLOCK              (_COMM_PAGE_START_ADDRESS+0x2a0)        // spinlock_unlock()
 129 #define _COMM_PAGE_PTHREAD_GETSPECIFIC  (_COMM_PAGE_START_ADDRESS+0x2c0)        // pthread_getspecific()
 130 #define _COMM_PAGE_GETTIMEOFDAY                 (_COMM_PAGE_START_ADDRESS+0x2e0)        // used by gettimeofday()
 131 #define _COMM_PAGE_FLUSH_DCACHE                 (_COMM_PAGE_START_ADDRESS+0x4e0)        // sys_dcache_flush()
 132 #define _COMM_PAGE_FLUSH_ICACHE                 (_COMM_PAGE_START_ADDRESS+0x520)        // sys_icache_invalidate()
 133 #define _COMM_PAGE_PTHREAD_SELF                 (_COMM_PAGE_START_ADDRESS+0x580)        // pthread_self()
 134 #define _COMM_PAGE_UNUSED4                              (_COMM_PAGE_START_ADDRESS+0x5a0)        // 32 unused bytes
 135 #define _COMM_PAGE_RELINQUISH                   (_COMM_PAGE_START_ADDRESS+0x5c0) // used by spinlocks
 136
 137 #define _COMM_PAGE_BTS                          (_COMM_PAGE_START_ADDRESS+0x5e0) // bit test-and-set
 138 #define _COMM_PAGE_BTC                                  (_COMM_PAGE_START_ADDRESS+0x5f0) // bit test-and-clear
 139
 140 #define _COMM_PAGE_BZERO                                (_COMM_PAGE_START_ADDRESS+0x600)        // bzero()
 141 #define _COMM_PAGE_BCOPY                                (_COMM_PAGE_START_ADDRESS+0x780)        // bcopy()
 142 #define _COMM_PAGE_MEMCPY                               (_COMM_PAGE_START_ADDRESS+0x7a0)        // memcpy()
 143 #define _COMM_PAGE_MEMMOVE                              (_COMM_PAGE_START_ADDRESS+0x7a0)        // memmove()
 144
 145 #define _COMM_PAGE_NANOTIME                             (_COMM_PAGE_START_ADDRESS+0xF80) // nanotime()
 146
 147 #define _COMM_PAGE_BIGCOPY                              (_COMM_PAGE_START_ADDRESS+0x1000)// very-long-operand copies
 148
 149 #define _COMM_PAGE_END                                  (_COMM_PAGE_START_ADDRESS+0x1600)// end of common page
 150
 151 #ifdef __ASSEMBLER__
 152 #ifdef __COMM_PAGE_SYMBOLS
 153
 154 #define CREATE_COMM_PAGE_SYMBOL(symbol_name, symbol_address)            \
 155                                 .org    (symbol_address - (_COMM_PAGE_BASE_ADDRESS & 0xFFFFE000)) ;\
 156 symbol_name: nop
 157
 158         .text           // Required to make a well behaved symbol file
 159
 160         CREATE_COMM_PAGE_SYMBOL(___compare_and_swap32, _COMM_PAGE_COMPARE_AND_SWAP32)
 161         CREATE_COMM_PAGE_SYMBOL(___compare_and_swap64, _COMM_PAGE_COMPARE_AND_SWAP64)
 162         CREATE_COMM_PAGE_SYMBOL(___atomic_enqueue, _COMM_PAGE_ENQUEUE)
 163         CREATE_COMM_PAGE_SYMBOL(___atomic_dequeue, _COMM_PAGE_DEQUEUE)
 164         CREATE_COMM_PAGE_SYMBOL(___memory_barrier, _COMM_PAGE_MEMORY_BARRIER)
 165         CREATE_COMM_PAGE_SYMBOL(___atomic_add32, _COMM_PAGE_ATOMIC_ADD32)
 166         CREATE_COMM_PAGE_SYMBOL(___atomic_add64, _COMM_PAGE_ATOMIC_ADD64)
 167         CREATE_COMM_PAGE_SYMBOL(___mach_absolute_time, _COMM_PAGE_ABSOLUTE_TIME)
 168         CREATE_COMM_PAGE_SYMBOL(___spin_lock_try, _COMM_PAGE_SPINLOCK_TRY)
 169         CREATE_COMM_PAGE_SYMBOL(___spin_lock, _COMM_PAGE_SPINLOCK_LOCK)
 170         CREATE_COMM_PAGE_SYMBOL(___spin_unlock, _COMM_PAGE_SPINLOCK_UNLOCK)
 171         CREATE_COMM_PAGE_SYMBOL(___pthread_getspecific, _COMM_PAGE_PTHREAD_GETSPECIFIC)
 172         CREATE_COMM_PAGE_SYMBOL(___gettimeofday, _COMM_PAGE_GETTIMEOFDAY)
 173         CREATE_COMM_PAGE_SYMBOL(___sys_dcache_flush, _COMM_PAGE_FLUSH_DCACHE)
 174         CREATE_COMM_PAGE_SYMBOL(___sys_icache_invalidate, _COMM_PAGE_FLUSH_ICACHE)
 175         CREATE_COMM_PAGE_SYMBOL(___pthread_self, _COMM_PAGE_PTHREAD_SELF)
 176         CREATE_COMM_PAGE_SYMBOL(___spin_lock_relinquish, _COMM_PAGE_RELINQUISH)
 177         CREATE_COMM_PAGE_SYMBOL(___bit_test_and_set, _COMM_PAGE_BTS)
 178         CREATE_COMM_PAGE_SYMBOL(___bit_test_and_clear, _COMM_PAGE_BTC)
 179         CREATE_COMM_PAGE_SYMBOL(___bzero, _COMM_PAGE_BZERO)
 180         CREATE_COMM_PAGE_SYMBOL(___bcopy, _COMM_PAGE_BCOPY)
 181         CREATE_COMM_PAGE_SYMBOL(___memcpy, _COMM_PAGE_MEMCPY)
 182 //      CREATE_COMM_PAGE_SYMBOL(___memmove, _COMM_PAGE_MEMMOVE)
 183         CREATE_COMM_PAGE_SYMBOL(___bigcopy, _COMM_PAGE_BIGCOPY)
 184         CREATE_COMM_PAGE_SYMBOL(___nanotime, _COMM_PAGE_NANOTIME)
 185         CREATE_COMM_PAGE_SYMBOL(___end_comm_page, _COMM_PAGE_END)
 186
 187         .data           // Required to make a well behaved symbol file
 188         .long   0       // Required to make a well behaved symbol file
 189
 190 #endif /* __COMM_PAGE_SYMBOLS */
 191 #endif /* __ASSEMBLER__ */
 192
 193 #endif /* _I386_CPU_CAPABILITIES_H */
 194 #endif /* PRIVATE */