]> git.saurik.com Git - apple/xnu.git/blame - osfmk/i386/cpu_capabilities.h
xnu-2050.48.11.tar.gz
[apple/xnu.git] / osfmk / i386 / cpu_capabilities.h
CommitLineData
43866e37 1/*
b0d623f7 2 * Copyright (c) 2003-2009 Apple Inc. All rights reserved.
43866e37 3 *
2d21ac55 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
43866e37 5 *
2d21ac55
A
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 License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
8f6c56a5 14 *
2d21ac55
A
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5
A
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55
A
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
8f6c56a5 25 *
2d21ac55 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
43866e37 27 */
91447636 28#ifdef PRIVATE
43866e37
A
29
30#ifndef _I386_CPU_CAPABILITIES_H
31#define _I386_CPU_CAPABILITIES_H
32
91447636
A
33#ifndef __ASSEMBLER__
34#include <stdint.h>
35#endif
55e303ae 36
55e303ae 37/*
43866e37 38 * This API only supported for Apple internal use.
43866e37
A
39 */
40
55e303ae
A
41/* Bit definitions for _cpu_capabilities: */
42
43#define kHasMMX 0x00000001
44#define kHasSSE 0x00000002
45#define kHasSSE2 0x00000004
91447636 46#define kHasSSE3 0x00000008
0c530ab8 47#define kCache32 0x00000010 /* cache line size is 32 bytes */
55e303ae
A
48#define kCache64 0x00000020
49#define kCache128 0x00000040
0c530ab8 50#define kFastThreadLocalStorage 0x00000080 /* TLS ptr is kept in a user-mode-readable register */
2d21ac55 51#define kHasSupplementalSSE3 0x00000100
0c530ab8 52#define k64Bit 0x00000200 /* processor supports EM64T (not what mode you're running in) */
2d21ac55
A
53#define kHasSSE4_1 0x00000400
54#define kHasSSE4_2 0x00000800
d1ecb069 55#define kHasAES 0x00001000
6d2010ae 56#define kInOrderPipeline 0x00002000
2d21ac55 57#define kSlow 0x00004000 /* tsc < nanosecond */
0c530ab8
A
58#define kUP 0x00008000 /* set if (kNumCPUs == 1) */
59#define kNumCPUs 0x00FF0000 /* number of CPUs (see _NumCPUs() below) */
bd504ef0 60#define kNumCPUsShift 16
6d2010ae 61#define kHasAVX1_0 0x01000000
7ddcb079
A
62#define kHasRDRAND 0x02000000
63#define kHasF16C 0x04000000
64#define kHasENFSTRG 0x08000000
bd504ef0
A
65#define kHasFMA 0x10000000
66#define kHasAVX2_0 0x20000000
67#define kHasBMI1 0x40000000
68#define kHasBMI2 0x80000000
69/* Extending into 64-bits from here: */
70#define kHasRTM 0x0000000100000000ULL
71#define kHasHLE 0x0000000200000000ULL
72
55e303ae 73
43866e37 74#ifndef __ASSEMBLER__
91447636
A
75#include <sys/cdefs.h>
76
77__BEGIN_DECLS
bd504ef0 78extern uint64_t _get_cpu_capabilities( void );
91447636 79__END_DECLS
55e303ae
A
80
81inline static
82int _NumCPUs( void )
83{
bd504ef0 84 return (int) (_get_cpu_capabilities() & kNumCPUs) >> kNumCPUsShift;
55e303ae
A
85}
86
87#endif /* __ASSEMBLER__ */
88
6d2010ae
A
89/* The following macro is used to generate the 64-bit commpage address for a given
90 * routine, based on its 32-bit address. This is used in the kernel to compile
91 * the 64-bit commpage. Since the kernel can be a 32-bit object, cpu_capabilities.h
92 * only defines the 32-bit address.
93 */
94#define _COMM_PAGE_32_TO_64( ADDRESS ) ( ADDRESS + _COMM_PAGE64_START_ADDRESS - _COMM_PAGE32_START_ADDRESS )
95
55e303ae
A
96
97/*
98 * The shared kernel/user "comm page(s)":
99 *
0c530ab8
A
100 * The last several pages of every address space are reserved for the kernel/user
101 * "comm area". During system initialization, the kernel populates the comm pages with
55e303ae
A
102 * code customized for the particular processor and platform.
103 *
0c530ab8 104 * Because Mach VM cannot map the last page of an address space, we don't use it.
55e303ae
A
105 */
106
316670eb 107#define _COMM_PAGE32_AREA_LENGTH ( 1 * 4096 ) /* reserved length of entire comm area */
6d2010ae
A
108#define _COMM_PAGE32_BASE_ADDRESS ( 0xffff0000 ) /* base address of allocated memory */
109#define _COMM_PAGE32_START_ADDRESS ( _COMM_PAGE32_BASE_ADDRESS ) /* address traditional commpage code starts on */
316670eb 110#define _COMM_PAGE32_AREA_USED ( 1 * 4096 ) /* this is the amt actually allocated */
6d2010ae 111#define _COMM_PAGE32_SIGS_OFFSET 0x8000 /* offset to routine signatures */
0c530ab8 112
316670eb 113#define _COMM_PAGE64_AREA_LENGTH ( 1 * 4096 ) /* reserved length of entire comm area (2MB) */
6d2010ae
A
114#ifdef __ASSEMBLER__
115#define _COMM_PAGE64_BASE_ADDRESS ( 0x00007fffffe00000 ) /* base address of allocated memory */
116#else /* __ASSEMBLER__ */
117#define _COMM_PAGE64_BASE_ADDRESS ( 0x00007fffffe00000ULL ) /* base address of allocated memory */
118#endif /* __ASSEMBLER__ */
119#define _COMM_PAGE64_START_ADDRESS ( _COMM_PAGE64_BASE_ADDRESS ) /* address traditional commpage code starts on */
316670eb 120#define _COMM_PAGE64_AREA_USED ( 1 * 4096 ) /* this is the amt actually populated */
0c530ab8 121
2d21ac55
A
122/* no need for an Objective-C area on Intel */
123#define _COMM_PAGE32_OBJC_SIZE 0ULL
124#define _COMM_PAGE32_OBJC_BASE 0ULL
125#define _COMM_PAGE64_OBJC_SIZE 0ULL
126#define _COMM_PAGE64_OBJC_BASE 0ULL
0c530ab8 127
b0d623f7
A
128#ifdef KERNEL_PRIVATE
129
130/* Inside the kernel, comm page addresses are absolute addresses
131 * assuming they are a part of the 32-bit commpage. They may
132 * be mapped somewhere else, especially for the 64-bit commpage.
133 */
134#define _COMM_PAGE_START_ADDRESS _COMM_PAGE32_START_ADDRESS
135#define _COMM_PAGE_SIGS_OFFSET _COMM_PAGE32_SIGS_OFFSET
136
137#else /* !KERNEL_PRIVATE */
138
0c530ab8
A
139#if defined(__i386__)
140
141#define _COMM_PAGE_AREA_LENGTH _COMM_PAGE32_AREA_LENGTH
142#define _COMM_PAGE_BASE_ADDRESS _COMM_PAGE32_BASE_ADDRESS
143#define _COMM_PAGE_START_ADDRESS _COMM_PAGE32_START_ADDRESS
144#define _COMM_PAGE_AREA_USED _COMM_PAGE32_AREA_USED
b0d623f7 145#define _COMM_PAGE_SIGS_OFFSET _COMM_PAGE32_SIGS_OFFSET
0c530ab8
A
146
147#elif defined(__x86_64__)
148
149#define _COMM_PAGE_AREA_LENGTH _COMM_PAGE64_AREA_LENGTH
150#define _COMM_PAGE_BASE_ADDRESS _COMM_PAGE64_BASE_ADDRESS
151#define _COMM_PAGE_START_ADDRESS _COMM_PAGE64_START_ADDRESS
152#define _COMM_PAGE_AREA_USED _COMM_PAGE64_AREA_USED
153
154#else
155#error architecture not supported
156#endif
55e303ae 157
b0d623f7
A
158#endif /* !KERNEL_PRIVATE */
159
55e303ae 160/* data in the comm page */
43866e37 161
bd504ef0
A
162#define _COMM_PAGE_SIGNATURE (_COMM_PAGE_START_ADDRESS+0x000) /* first 16 bytes are a signature */
163#define _COMM_PAGE_SIGNATURELEN (0x10)
164#define _COMM_PAGE_CPU_CAPABILITIES64 (_COMM_PAGE_START_ADDRESS+0x010) /* uint64_t _cpu_capabilities */
165#define _COMM_PAGE_UNUSED (_COMM_PAGE_START_ADDRESS+0x018) /* 6 unused bytes */
0c530ab8 166#define _COMM_PAGE_VERSION (_COMM_PAGE_START_ADDRESS+0x01E) /* 16-bit version# */
bd504ef0 167#define _COMM_PAGE_THIS_VERSION 13 /* in ver 13, _COMM_PAGE_NT_SHIFT defaults to 0 (was 32) */
55e303ae 168
bd504ef0 169#define _COMM_PAGE_CPU_CAPABILITIES (_COMM_PAGE_START_ADDRESS+0x020) /* uint32_t _cpu_capabilities (retained for compatibility) */
6d2010ae 170#define _COMM_PAGE_NCPUS (_COMM_PAGE_START_ADDRESS+0x022) /* uint8_t number of configured CPUs (hw.logicalcpu at boot time) */
bd504ef0 171#define _COMM_PAGE_UNUSED0 (_COMM_PAGE_START_ADDRESS+0x024) /* 2 unused bytes, previouly reserved for expansion of cpu_capabilities */
0c530ab8
A
172#define _COMM_PAGE_CACHE_LINESIZE (_COMM_PAGE_START_ADDRESS+0x026) /* uint16_t cache line size */
173
2d21ac55 174#define _COMM_PAGE_SCHED_GEN (_COMM_PAGE_START_ADDRESS+0x028) /* uint32_t scheduler generation number (count of pre-emptions) */
b0d623f7
A
175#define _COMM_PAGE_MEMORY_PRESSURE (_COMM_PAGE_START_ADDRESS+0x02c) /* uint32_t copy of vm_memory_pressure */
176#define _COMM_PAGE_SPIN_COUNT (_COMM_PAGE_START_ADDRESS+0x030) /* uint32_t max spin count for mutex's */
177
6d2010ae
A
178#define _COMM_PAGE_ACTIVE_CPUS (_COMM_PAGE_START_ADDRESS+0x034) /* uint8_t number of active CPUs (hw.activecpu) */
179#define _COMM_PAGE_PHYSICAL_CPUS (_COMM_PAGE_START_ADDRESS+0x035) /* uint8_t number of physical CPUs (hw.physicalcpu_max) */
180#define _COMM_PAGE_LOGICAL_CPUS (_COMM_PAGE_START_ADDRESS+0x036) /* uint8_t number of logical CPUs (hw.logicalcpu_max) */
181#define _COMM_PAGE_UNUSED1 (_COMM_PAGE_START_ADDRESS+0x037) /* 1 unused bytes */
182#define _COMM_PAGE_MEMORY_SIZE (_COMM_PAGE_START_ADDRESS+0x038) /* uint64_t max memory size */
b0d623f7 183
6d2010ae
A
184#define _COMM_PAGE_CPUFAMILY (_COMM_PAGE_START_ADDRESS+0x040) /* uint32_t hw.cpufamily, x86*/
185#define _COMM_PAGE_UNUSED2 (_COMM_PAGE_START_ADDRESS+0x044) /* [0x44,0x50) unused */
b0d623f7 186
2d21ac55 187#define _COMM_PAGE_TIME_DATA_START (_COMM_PAGE_START_ADDRESS+0x050) /* base of offsets below (_NT_SCALE etc) */
0c530ab8
A
188#define _COMM_PAGE_NT_TSC_BASE (_COMM_PAGE_START_ADDRESS+0x050) /* used by nanotime() */
189#define _COMM_PAGE_NT_SCALE (_COMM_PAGE_START_ADDRESS+0x058) /* used by nanotime() */
190#define _COMM_PAGE_NT_SHIFT (_COMM_PAGE_START_ADDRESS+0x05c) /* used by nanotime() */
191#define _COMM_PAGE_NT_NS_BASE (_COMM_PAGE_START_ADDRESS+0x060) /* used by nanotime() */
2d21ac55
A
192#define _COMM_PAGE_NT_GENERATION (_COMM_PAGE_START_ADDRESS+0x068) /* used by nanotime() */
193#define _COMM_PAGE_GTOD_GENERATION (_COMM_PAGE_START_ADDRESS+0x06c) /* used by gettimeofday() */
194#define _COMM_PAGE_GTOD_NS_BASE (_COMM_PAGE_START_ADDRESS+0x070) /* used by gettimeofday() */
195#define _COMM_PAGE_GTOD_SEC_BASE (_COMM_PAGE_START_ADDRESS+0x078) /* used by gettimeofday() */
196
316670eb
A
197#define _COMM_PAGE_END (_COMM_PAGE_START_ADDRESS+0xfff) /* end of common page */
198
2d21ac55
A
199/* Warning: kernel commpage.h has a matching c typedef for the following. They must be kept in sync. */
200/* These offsets are from _COMM_PAGE_TIME_DATA_START */
0c530ab8 201
2d21ac55 202#define _NT_TSC_BASE 0
0c530ab8
A
203#define _NT_SCALE 8
204#define _NT_SHIFT 12
205#define _NT_NS_BASE 16
2d21ac55
A
206#define _NT_GENERATION 24
207#define _GTOD_GENERATION 28
208#define _GTOD_NS_BASE 32
209#define _GTOD_SEC_BASE 40
6601e61a 210
0c530ab8 211 /* jump table (jmp to this address, which may be a branch to the actual code somewhere else) */
b0d623f7
A
212 /* When new jump table entries are added, corresponding symbols should be added below */
213 /* New slots should be allocated with at least 16-byte alignment. Some like bcopy require */
214 /* 32-byte alignment, and should be aligned as such in the assembly source before they are relocated */
316670eb
A
215#define _COMM_PAGE_TEXT_START (_COMM_PAGE_START_ADDRESS+0x1000)
216#define _COMM_PAGE32_TEXT_START (_COMM_PAGE32_BASE_ADDRESS+0x1000) /* start of text section */
217#define _COMM_PAGE64_TEXT_START (_COMM_PAGE64_BASE_ADDRESS+0x1000)
218#define _COMM_PAGE_TEXT_AREA_USED ( 1 * 4096 )
219#define _COMM_PAGE_TEXT_AREA_LENGTH ( 1 * 4096 )
220#define _PFZ32_SLIDE_RANGE ( 14 ) /* pages between 0xfffff000 and _COMM_PAGE32_TEXT_START */
221#define _PFZ64_SLIDE_RANGE ( 510 ) /* pages between 0x00007ffffffff000 and _COMM_PAGE64_TEXT_START */
222
223/* setup start offset in the commpage text region for each jump table entry
224 * the Comm Page Offset is shortened to _COMM_TEXT_[label]_OFFSET
225 */
0c530ab8 226
316670eb
A
227#define _COMM_TEXT_PREEMPT_OFFSET (0x5a0) /* called from withing pfz */
228#define _COMM_TEXT_BACKOFF_OFFSET (0x600) /* called from PFZ */
229#define _COMM_TEXT_PFZ_START_OFFSET (0xc00) /* offset for Preemption Free Zone */
230#define _COMM_TEXT_PFZ_ENQUEUE_OFFSET (0xc00) /* internal FIFO enqueue */
231#define _COMM_TEXT_PFZ_DEQUEUE_OFFSET (0xc80) /* internal FIFO dequeue */
232#define _COMM_TEXT_PFZ_MUTEX_LOCK_OFFSET (0xd00) /* internal pthread_mutex_lock() */
233#define _COMM_TEXT_UNUSED_OFFSET (0xd80) /* end of routines in text page */
234#define _COMM_TEXT_PFZ_END_OFFSET (0xfff) /* offset for end of PFZ */
b0d623f7 235
b0d623f7 236
316670eb
A
237#define _COMM_PAGE_PREEMPT (_COMM_PAGE_TEXT_START+_COMM_TEXT_PREEMPT_OFFSET)
238#define _COMM_PAGE_BACKOFF (_COMM_PAGE_TEXT_START+_COMM_TEXT_BACKOFF_OFFSET)
b0d623f7 239
316670eb 240#define _COMM_PAGE_PFZ_START (_COMM_PAGE_TEXT_START+_COMM_PAGE_PFZ_START_OFFSET)
b0d623f7 241
316670eb
A
242#define _COMM_PAGE_PFZ_ENQUEUE (_COMM_PAGE_TEXT_START+_COMM_TEXT_PFZ_ENQUEUE_OFFSET)
243#define _COMM_PAGE_PFZ_DEQUEUE (_COMM_PAGE_TEXT_START+_COMM_TEXT_PFZ_DEQUEUE_OFFSET)
244#define _COMM_PAGE_PFZ_MUTEX_LOCK (_COMM_PAGE_TEXT_START+_COMM_TEXT_PFZ_MUTEX_LOCK_OFFSET)
55e303ae 245
316670eb
A
246#define _COMM_PAGE_UNUSED6 (_COMM_PAGE_TEXT_START+_COMM_TEXT_UNUSED_OFFSET)
247#define _COMM_PAGE_PFZ_END (_COMM_PAGE_TEXT_START+_COMM_TEXT_PFZ_END_OFFSET)
248#define _COMM_PAGE_TEXT_END (_COMM_PAGE_TEXT_START+_COMM_TEXT_PFZ_END_OFFSET) /* end of common text page */
55e303ae 249
0c530ab8
A
250/* _COMM_PAGE_COMPARE_AND_SWAP{32,64}B are not used on x86 and are
251 * maintained here for source compatability. These will be removed at
252 * some point, so don't go relying on them. */
253#define _COMM_PAGE_COMPARE_AND_SWAP32B (_COMM_PAGE_START_ADDRESS+0xf80) /* compare-and-swap word w barrier */
254#define _COMM_PAGE_COMPARE_AND_SWAP64B (_COMM_PAGE_START_ADDRESS+0xfc0) /* compare-and-swap doubleword w barrier */
55e303ae
A
255
256#ifdef __ASSEMBLER__
257#ifdef __COMM_PAGE_SYMBOLS
258
259#define CREATE_COMM_PAGE_SYMBOL(symbol_name, symbol_address) \
0c530ab8 260 .org (symbol_address - (_COMM_PAGE_START_ADDRESS & 0xFFFFE000)) ;\
55e303ae
A
261symbol_name: nop
262
0c530ab8 263 .text /* Required to make a well behaved symbol file */
55e303ae 264
6d2010ae 265 CREATE_COMM_PAGE_SYMBOL(___preempt, _COMM_PAGE_PREEMPT)
b0d623f7 266 CREATE_COMM_PAGE_SYMBOL(___backoff, _COMM_PAGE_BACKOFF)
b0d623f7
A
267 CREATE_COMM_PAGE_SYMBOL(___pfz_enqueue, _COMM_PAGE_PFZ_ENQUEUE)
268 CREATE_COMM_PAGE_SYMBOL(___pfz_dequeue, _COMM_PAGE_PFZ_DEQUEUE)
269 CREATE_COMM_PAGE_SYMBOL(___pfz_mutex_lock, _COMM_PAGE_PFZ_MUTEX_LOCK)
55e303ae
A
270 CREATE_COMM_PAGE_SYMBOL(___end_comm_page, _COMM_PAGE_END)
271
0c530ab8
A
272 .data /* Required to make a well behaved symbol file */
273 .long 0 /* Required to make a well behaved symbol file */
55e303ae
A
274
275#endif /* __COMM_PAGE_SYMBOLS */
276#endif /* __ASSEMBLER__ */
43866e37 277
43866e37 278#endif /* _I386_CPU_CAPABILITIES_H */
91447636 279#endif /* PRIVATE */