1 /*
2 * Copyright (c) 2000-2012 Apple Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_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 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.
14 *
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
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
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.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28 /*
29 * @OSF_COPYRIGHT@
30 */
31 /*
32 * Mach Operating System
33 * Copyright (c) 1991 Carnegie Mellon University
34 * All Rights Reserved.
35 *
36 * Permission to use, copy, modify and distribute this software and its
37 * documentation is hereby granted, provided that both the copyright
38 * notice and this permission notice appear in all copies of the
39 * software, derivative works or modified versions, and any portions
40 * thereof, and that both notices appear in supporting documentation.
41 *
42 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
43 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
44 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
45 *
46 * Carnegie Mellon requests users of this software to return to
47 *
48 * Software Distribution Coordinator or [email protected]
49 * School of Computer Science
50 * Carnegie Mellon University
51 * Pittsburgh PA 15213-3890
52 *
53 * any improvements or extensions that they make and grant Carnegie Mellon
54 * the rights to redistribute these changes.
55 */
56
57 #ifndef _I386_FPU_H_
58 #define _I386_FPU_H_
59
60 /*
61 * Macro definitions for routines to manipulate the
62 * floating-point processor.
63 */
64 #include <kern/kern_types.h>
65 #include <mach/i386/kern_return.h>
66 #include <mach/i386/thread_status.h>
67 #include <i386/proc_reg.h>
68
69 #define FP_XMASK ((uint32_t) (XFEM_X87 | XFEM_SSE))
70 #define AVX_XMASK ((uint32_t) (XFEM_X87 | XFEM_SSE | XFEM_YMM))
71 #define AVX512_XMASK ((uint32_t) (XFEM_X87 | XFEM_SSE | XFEM_YMM | XFEM_ZMM_OPMASK))
72
73 typedef enum {
74 FXSAVE32 = 1,
75 FXSAVE64 = 2,
76 XSAVE32 = 3,
77 XSAVE64 = 4,
78 FP_UNUSED = 5
79 } fp_save_layout_t;
80
81 #define STATE64_FULL 0x10
82 typedef enum {
83 UNDEFINED,
84 FP,
85 AVX,
86 AVX512,
87 /*
88 * The following states are never associated with a thread or task.
89 * They are used for array declarations of data used during signal dispatch,
90 * but these values are never assigned to threads' (or tasks') xstate members.
91 */
92 UNDEFINED_FULL = UNDEFINED | STATE64_FULL,
93 FP_FULL = FP | STATE64_FULL,
94 AVX_FULL = AVX | STATE64_FULL,
95 AVX512_FULL = AVX512 | STATE64_FULL,
96 } xstate_t;
97
98 static inline uint64_t
xgetbv(uint32_t c)99 xgetbv(uint32_t c)
100 {
101 uint32_t mask_hi, mask_lo;
102 __asm__ __volatile__ ("xgetbv" : "=a"(mask_lo), "=d"(mask_hi) : "c" (c));
103 return ((uint64_t) mask_hi << 32) + (uint64_t) mask_lo;
104 }
105
106 static inline void
xsetbv(uint32_t mask_hi,uint32_t mask_lo)107 xsetbv(uint32_t mask_hi, uint32_t mask_lo)
108 {
109 __asm__ __volatile__ ("xsetbv" :: "a"(mask_lo), "d"(mask_hi), "c" (XCR0));
110 }
111
112 extern void init_fpu(void);
113 extern void fpu_module_init(void);
114 extern void fpu_free(
115 thread_t thr_act,
116 void *fps);
117 extern kern_return_t fpu_set_fxstate(
118 thread_t thr_act,
119 thread_state_t state,
120 thread_flavor_t f);
121 extern kern_return_t fpu_get_fxstate(
122 thread_t thr_act,
123 thread_state_t state,
124 thread_flavor_t f);
125 extern void fpu_dup_fxstate(
126 thread_t parent,
127 thread_t child);
128 extern void fpnoextflt(void);
129 extern void fpextovrflt(void);
130 extern void fpexterrflt(void);
131 extern void fpSSEexterrflt(void);
132 extern void fpflush(thread_t);
133 extern void fp_setvalid(boolean_t);
134
135 extern void clear_fpu(void);
136 extern void fpu_switch_context(
137 thread_t old,
138 thread_t new);
139 extern void fpu_switch_addrmode(
140 thread_t thread,
141 boolean_t is_64bit);
142
143 extern xstate_t fpu_default;
144 extern xstate_t fpu_capability;
145 extern xstate_t current_xstate(void);
146 extern int fpUDflt(user_addr_t rip);
147 #ifdef MACH_KERNEL_PRIVATE
148 #if DEBUG || DEVELOPMENT
149 extern uint32_t thread_fpsimd_hash(thread_t);
150 extern bool thread_fpsimd_hash_enabled(void);
151 #endif
152 extern void vzeroall(void);
153 extern void xmmzeroall(void);
154 extern void avx512_zero(void);
155 #endif /* MKP */
156 #endif /* _I386_FPU_H_ */
157