osfmk/ppc/cpu_capabilities.h

   1 /*
   2  * Copyright (c) 2003 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 _PPC_CPU_CAPABILITIES_H
  33 #define _PPC_CPU_CAPABILITIES_H
  34
  35 /* _cpu_capabilities
  36  *
  37  * This is the authoritative way to determine from user mode what
  38  * implementation-specific processor features are available.
  39  * This API is only supported for Apple internal use.
  40  */
  41
  42 #ifndef __ASSEMBLER__
  43
  44 extern int _cpu_capabilities;
  45
  46 #endif /* __ASSEMBLER__ */
  47
  48 /* Bit definitions for _cpu_capabilities: */
  49
  50 #define kHasAltivec                             0x00000001
  51 #define k64Bit                                  0x00000002      // 64-bit GPRs
  52 #define kCache32                                0x00000004      // cache line size is 32 bytes
  53 #define kCache64                                0x00000008
  54 #define kCache128                               0x00000010
  55 #define kDcbaRecommended                0x00000020      // PPC: dcba is available and recommended
  56 #define kDcbaAvailable                  0x00000040      // PPC: dcba is available (but may or may not be recommended)
  57 #define kDataStreamsRecommended 0x00000080      // PPC: dst, dstt, dstst, dss, and dssall instructions available and recommended
  58 #define kDataStreamsAvailable   0x00000100      // PPC: dst, dstt, dstst, dss, and dssall instructions available (may or may not be rec'd)
  59 #define kDcbtStreamsRecommended 0x00000200      // PPC: enhanced dcbt instruction available and recommended
  60 #define kDcbtStreamsAvailable   0x00000400      // PPC: enhanced dcbt instruction available (but may or may not be recommended)
  61 #define kFastThreadLocalStorage 0x00000800      // TLS ptr is kept in a user-mode-readable register
  62
  63 #define kUP                                             0x00008000      // set if (kNumCPUs == 1)
  64 #define kNumCPUs                                0x00FF0000      // number of CPUs (see _NumCPUs() below)
  65
  66 #define kNumCPUsShift                   16                      // see _NumCPUs() below
  67
  68 #define kHasGraphicsOps                 0x08000000      // PPC: has fres, frsqrte, and fsel instructions
  69 #define kHasStfiwx                              0x10000000      // PPC: has stfiwx instruction
  70 #define kHasFsqrt                               0x20000000      // PPC: has fsqrt and fsqrts instructions
  71
  72 #ifndef __ASSEMBLER__
  73
  74 static __inline__ int _NumCPUs( void ) { return (_cpu_capabilities & kNumCPUs) >> kNumCPUsShift; }
  75
  76 #endif /* __ASSEMBLER__ */
  77
  78
  79 /*
  80  * The shared kernel/user "comm page(s)":
  81  *
  82  * The last eight pages of every address space are reserved for the kernel/user
  83  * "comm area".  Because they can be addressed via a sign-extended 16-bit field,
  84  * it is particularly efficient to access code or data in the comm area with
  85  * absolute branches (ba, bla, bca) or absolute load/stores ("lwz r0,-4096(0)").
  86  * Because the comm area can be reached from anywhere, dyld is not needed.
  87  * Although eight pages are reserved, presently only two are populated and mapped.
  88  *
  89  * Routines on the comm page(s) can be thought of as the firmware for extended processor
  90  * instructions, whose opcodes are special forms of "bla".  Ie, they are cpu
  91  * capabilities.  During system initialization, the kernel populates the comm page with
  92  * code customized for the particular processor and platform.
  93  *
  94  * Because Mach VM cannot map the last page of an address space, the max length of
  95  * the comm area is seven pages.
  96  */
  97
  98 #define _COMM_PAGE_BASE_ADDRESS                 (-8*4096)                                               // start at page -8, ie 0xFFFF8000
  99 #define _COMM_PAGE_AREA_LENGTH                  ( 7*4096)                                               // reserved length of entire comm area
 100 #define _COMM_PAGE_AREA_USED                    ( 2*4096)                                               // we use two pages so far
 101
 102 /* The Objective-C runtime fixed address page to optimize message dispatch */
 103 #define _OBJC_PAGE_BASE_ADDRESS                 (-20*4096)                                              // start at page -20, ie 0xFFFEC000
 104
 105 /* data in the comm page */
 106
 107 #define _COMM_PAGE_SIGNATURE                    (_COMM_PAGE_BASE_ADDRESS+0x000) // first few bytes are a signature
 108 #define _COMM_PAGE_VERSION                              (_COMM_PAGE_BASE_ADDRESS+0x01E) // 16-bit version#
 109 #define _COMM_PAGE_THIS_VERSION                 2                                                               // this is version 2 of the commarea format
 110
 111 #define _COMM_PAGE_CPU_CAPABILITIES             (_COMM_PAGE_BASE_ADDRESS+0x020) // mirror of extern int _cpu_capabilities
 112 #define _COMM_PAGE_NCPUS                                (_COMM_PAGE_BASE_ADDRESS+0x021) // number of configured CPUs
 113 #define _COMM_PAGE_ALTIVEC                              (_COMM_PAGE_BASE_ADDRESS+0x024) // nonzero if Altivec available
 114 #define _COMM_PAGE_64_BIT                               (_COMM_PAGE_BASE_ADDRESS+0x025) // nonzero if 64-bit processor
 115 #define _COMM_PAGE_CACHE_LINESIZE               (_COMM_PAGE_BASE_ADDRESS+0x026) // cache line size (16-bit field)
 116
 117 #define _COMM_PAGE_UNUSED1                              (_COMM_PAGE_BASE_ADDRESS+0x028) // 24 unused bytes
 118
 119 #define _COMM_PAGE_2_TO_52                              (_COMM_PAGE_BASE_ADDRESS+0x040) // double float constant 2**52
 120 #define _COMM_PAGE_10_TO_6                              (_COMM_PAGE_BASE_ADDRESS+0x048) // double float constant 10**6
 121 #define _COMM_PAGE_MAGIC_FE             (_COMM_PAGE_BASE_ADDRESS+0x050) // magic constant 0xFEFEFEFEFEFEFEFF (to find 0s)
 122 #define _COMM_PAGE_MAGIC_80             (_COMM_PAGE_BASE_ADDRESS+0x058) // magic constant 0x8080808080808080 (to find 0s)
 123
 124 #define _COMM_PAGE_TIMEBASE                             (_COMM_PAGE_BASE_ADDRESS+0x060) // used by gettimeofday()
 125 #define _COMM_PAGE_TIMESTAMP                    (_COMM_PAGE_BASE_ADDRESS+0x068) // used by gettimeofday()
 126 #define _COMM_PAGE_SEC_PER_TICK                 (_COMM_PAGE_BASE_ADDRESS+0x070) // used by gettimeofday()
 127
 128  /* jump table (bla to this address, which may be a branch to the actual code somewhere else) */
 129  /* When new jump table entries are added, corresponding symbols should be added below         */
 130
 131 #define _COMM_PAGE_COMPARE_AND_SWAP32   (_COMM_PAGE_BASE_ADDRESS+0x080) // compare-and-swap word, no barrier
 132 #define _COMM_PAGE_COMPARE_AND_SWAP64   (_COMM_PAGE_BASE_ADDRESS+0x0c0) // compare-and-swap doubleword, no barrier
 133 #define _COMM_PAGE_ENQUEUE                              (_COMM_PAGE_BASE_ADDRESS+0x100) // enqueue
 134 #define _COMM_PAGE_DEQUEUE                              (_COMM_PAGE_BASE_ADDRESS+0x140) // dequeue
 135 #define _COMM_PAGE_MEMORY_BARRIER               (_COMM_PAGE_BASE_ADDRESS+0x180) // memory barrier
 136 #define _COMM_PAGE_ATOMIC_ADD32                 (_COMM_PAGE_BASE_ADDRESS+0x1a0) // add atomic word
 137 #define _COMM_PAGE_ATOMIC_ADD64                 (_COMM_PAGE_BASE_ADDRESS+0x1c0) // add atomic doubleword
 138
 139 #define _COMM_PAGE_UNUSED3                              (_COMM_PAGE_BASE_ADDRESS+0x1e0) // 32 unused bytes
 140
 141 #define _COMM_PAGE_ABSOLUTE_TIME                (_COMM_PAGE_BASE_ADDRESS+0x200) // mach_absolute_time()
 142 #define _COMM_PAGE_SPINLOCK_TRY                 (_COMM_PAGE_BASE_ADDRESS+0x220) // spinlock_try()
 143 #define _COMM_PAGE_SPINLOCK_LOCK                (_COMM_PAGE_BASE_ADDRESS+0x260) // spinlock_lock()
 144 #define _COMM_PAGE_SPINLOCK_UNLOCK              (_COMM_PAGE_BASE_ADDRESS+0x2a0) // spinlock_unlock()
 145 #define _COMM_PAGE_PTHREAD_GETSPECIFIC  (_COMM_PAGE_BASE_ADDRESS+0x2c0) // pthread_getspecific()
 146 #define _COMM_PAGE_GETTIMEOFDAY                 (_COMM_PAGE_BASE_ADDRESS+0x2e0) // used by gettimeofday()
 147 #define _COMM_PAGE_FLUSH_DCACHE                 (_COMM_PAGE_BASE_ADDRESS+0x4e0) // sys_dcache_flush()
 148 #define _COMM_PAGE_FLUSH_ICACHE                 (_COMM_PAGE_BASE_ADDRESS+0x520) // sys_icache_invalidate()
 149 #define _COMM_PAGE_PTHREAD_SELF                 (_COMM_PAGE_BASE_ADDRESS+0x580) // pthread_self()
 150
 151 #define _COMM_PAGE_UNUSED4                              (_COMM_PAGE_BASE_ADDRESS+0x5a0) // 32 unused bytes
 152
 153 #define _COMM_PAGE_RELINQUISH                   (_COMM_PAGE_BASE_ADDRESS+0x5c0) // used by spinlocks
 154
 155 #define _COMM_PAGE_UNUSED5                              (_COMM_PAGE_BASE_ADDRESS+0x5e0) // 32 unused bytes
 156
 157 #define _COMM_PAGE_BZERO                                (_COMM_PAGE_BASE_ADDRESS+0x600) // bzero()
 158 #define _COMM_PAGE_BCOPY                                (_COMM_PAGE_BASE_ADDRESS+0x780) // bcopy()
 159 #define _COMM_PAGE_MEMCPY                               (_COMM_PAGE_BASE_ADDRESS+0x7a0) // memcpy()
 160 #define _COMM_PAGE_MEMMOVE                              (_COMM_PAGE_BASE_ADDRESS+0x7a0) // memmove()
 161
 162 #define _COMM_PAGE_COMPARE_AND_SWAP32B  (_COMM_PAGE_BASE_ADDRESS+0xf80) // compare-and-swap word w barrier
 163 #define _COMM_PAGE_COMPARE_AND_SWAP64B  (_COMM_PAGE_BASE_ADDRESS+0xfc0) // compare-and-swap doubleword w barrier
 164
 165 #define _COMM_PAGE_MEMSET_PATTERN       (_COMM_PAGE_BASE_ADDRESS+0x1000)// used by nonzero memset()
 166 #define _COMM_PAGE_BIGCOPY                              (_COMM_PAGE_BASE_ADDRESS+0x1140)// very-long-operand copies
 167
 168 #define _COMM_PAGE_END                                  (_COMM_PAGE_BASE_ADDRESS+0x1700)// end of commpage area
 169
 170 #ifdef __ASSEMBLER__
 171 #ifdef __COMM_PAGE_SYMBOLS
 172
 173 #define CREATE_COMM_PAGE_SYMBOL(symbol_name, symbol_address)            \
 174                                 .org    (symbol_address - _COMM_PAGE_BASE_ADDRESS) @\
 175 symbol_name: nop
 176
 177         .text           // Required to make a well behaved symbol file
 178
 179         CREATE_COMM_PAGE_SYMBOL(___compare_and_swap32, _COMM_PAGE_COMPARE_AND_SWAP32)
 180         CREATE_COMM_PAGE_SYMBOL(___compare_and_swap64, _COMM_PAGE_COMPARE_AND_SWAP64)
 181         CREATE_COMM_PAGE_SYMBOL(___atomic_enqueue, _COMM_PAGE_ENQUEUE)
 182         CREATE_COMM_PAGE_SYMBOL(___atomic_dequeue, _COMM_PAGE_DEQUEUE)
 183         CREATE_COMM_PAGE_SYMBOL(___memory_barrier, _COMM_PAGE_MEMORY_BARRIER)
 184         CREATE_COMM_PAGE_SYMBOL(___atomic_add32, _COMM_PAGE_ATOMIC_ADD32)
 185         CREATE_COMM_PAGE_SYMBOL(___atomic_add64, _COMM_PAGE_ATOMIC_ADD64)
 186         CREATE_COMM_PAGE_SYMBOL(___mach_absolute_time, _COMM_PAGE_ABSOLUTE_TIME)
 187         CREATE_COMM_PAGE_SYMBOL(___spin_lock_try, _COMM_PAGE_SPINLOCK_TRY)
 188         CREATE_COMM_PAGE_SYMBOL(___spin_lock, _COMM_PAGE_SPINLOCK_LOCK)
 189         CREATE_COMM_PAGE_SYMBOL(___spin_unlock, _COMM_PAGE_SPINLOCK_UNLOCK)
 190         CREATE_COMM_PAGE_SYMBOL(___pthread_getspecific, _COMM_PAGE_PTHREAD_GETSPECIFIC)
 191         CREATE_COMM_PAGE_SYMBOL(___gettimeofday, _COMM_PAGE_GETTIMEOFDAY)
 192         CREATE_COMM_PAGE_SYMBOL(___sys_dcache_flush, _COMM_PAGE_FLUSH_DCACHE)
 193         CREATE_COMM_PAGE_SYMBOL(___sys_icache_invalidate, _COMM_PAGE_FLUSH_ICACHE)
 194         CREATE_COMM_PAGE_SYMBOL(___pthread_self, _COMM_PAGE_PTHREAD_SELF)
 195         CREATE_COMM_PAGE_SYMBOL(___spin_lock_relinquish, _COMM_PAGE_RELINQUISH)
 196         CREATE_COMM_PAGE_SYMBOL(___bzero, _COMM_PAGE_BZERO)
 197         CREATE_COMM_PAGE_SYMBOL(___bcopy, _COMM_PAGE_BCOPY)
 198         CREATE_COMM_PAGE_SYMBOL(___memcpy, _COMM_PAGE_MEMCPY)
 199 //      CREATE_COMM_PAGE_SYMBOL(___memmove, _COMM_PAGE_MEMMOVE)
 200         CREATE_COMM_PAGE_SYMBOL(___compare_and_swap32b, _COMM_PAGE_COMPARE_AND_SWAP32B)
 201         CREATE_COMM_PAGE_SYMBOL(___compare_and_swap64b, _COMM_PAGE_COMPARE_AND_SWAP64B)
 202     CREATE_COMM_PAGE_SYMBOL(___memset_pattern, _COMM_PAGE_MEMSET_PATTERN)
 203         CREATE_COMM_PAGE_SYMBOL(___bigcopy, _COMM_PAGE_BIGCOPY)
 204
 205         CREATE_COMM_PAGE_SYMBOL(___end_comm_page, _COMM_PAGE_END)
 206
 207         .data           // Required to make a well behaved symbol file
 208         .long   0       // Required to make a well behaved symbol file
 209
 210 #endif /* __COMM_PAGE_SYMBOLS */
 211 #endif /* __ASSEMBLER__ */
 212
 213 #endif /* _PPC_CPU_CAPABILITIES_H */
 214 #endif /* PRIVATE */