osfmk/ppc/cpu_capabilities.h

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