xref: /freebsd/lib/libc/amd64/amd64_archlevel.h (revision ad2fac552c3fcb577feb3055fa083f2d256c06ed)
1*ad2fac55SRobert Clausecker /*-
2*ad2fac55SRobert Clausecker  * Copyright (c) 2023 The FreeBSD Foundation
3*ad2fac55SRobert Clausecker  *
4*ad2fac55SRobert Clausecker  * This software was developed by Robert Clausecker <fuz@FreeBSD.org>
5*ad2fac55SRobert Clausecker  * under sponsorship from the FreeBSD Foundation.
6*ad2fac55SRobert Clausecker  *
7*ad2fac55SRobert Clausecker  * Redistribution and use in source and binary forms, with or without
8*ad2fac55SRobert Clausecker  * modification, are permitted provided that the following conditions
9*ad2fac55SRobert Clausecker  * are met:
10*ad2fac55SRobert Clausecker  * 1. Redistributions of source code must retain the above copyright
11*ad2fac55SRobert Clausecker  *    notice, this list of conditions and the following disclaimer.
12*ad2fac55SRobert Clausecker  * 2. Redistributions in binary form must reproduce the above copyright
13*ad2fac55SRobert Clausecker  *    notice, this list of conditions and the following disclaimer in the
14*ad2fac55SRobert Clausecker  *    documentation and/or other materials provided with the distribution.
15*ad2fac55SRobert Clausecker  *
16*ad2fac55SRobert Clausecker  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ''AS IS'' AND
17*ad2fac55SRobert Clausecker  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18*ad2fac55SRobert Clausecker  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19*ad2fac55SRobert Clausecker  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20*ad2fac55SRobert Clausecker  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21*ad2fac55SRobert Clausecker  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22*ad2fac55SRobert Clausecker  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23*ad2fac55SRobert Clausecker  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24*ad2fac55SRobert Clausecker  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25*ad2fac55SRobert Clausecker  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26*ad2fac55SRobert Clausecker  * SUCH DAMAGE
27*ad2fac55SRobert Clausecker  */
28*ad2fac55SRobert Clausecker 
29*ad2fac55SRobert Clausecker /* must be macros so they can be accessed from assembly */
30*ad2fac55SRobert Clausecker #define X86_64_SCALAR    0 /* disable SIMD optimisations */
31*ad2fac55SRobert Clausecker #define	X86_64_BASELINE  1 /* CMOV, CX8, FPU, FXSR, MMX, OSFXSR, SSE, SSE2 */
32*ad2fac55SRobert Clausecker #define	X86_64_V2        2 /* CMPXCHG16B, LAHF-SAHF, POPCNT, SSE3, SSSE3, SSE4_1, SSE4_2 */
33*ad2fac55SRobert Clausecker #define	X86_64_V3        3 /* AVX, AVX2, BMI1, BMI2, F16C, FMA, LZCNT, MOVBE, OSXSAVE */
34*ad2fac55SRobert Clausecker #define	X86_64_V4        4 /* AVX512F, AVX512BW, AVX512CD, AVX512DQ, AVX512VL */
35*ad2fac55SRobert Clausecker 
36*ad2fac55SRobert Clausecker #define	X86_64_MAX       X86_64_V4 /* highest supported architecture level */
37*ad2fac55SRobert Clausecker #define	X86_64_UNDEFINED -1 /* architecture level not set yet */
38*ad2fac55SRobert Clausecker 
39*ad2fac55SRobert Clausecker #ifndef __ASSEMBLER__
40*ad2fac55SRobert Clausecker #include <dlfcn.h>
41*ad2fac55SRobert Clausecker 
42*ad2fac55SRobert Clausecker dlfunc_t	__archlevel_resolve(u_int, u_int, u_int, u_int,
43*ad2fac55SRobert Clausecker 		    int32_t[X86_64_MAX + 1]) __hidden;
44*ad2fac55SRobert Clausecker #else
45*ad2fac55SRobert Clausecker #include <machine/asm.h>
46*ad2fac55SRobert Clausecker 
47*ad2fac55SRobert Clausecker #define ARCHRESOLVE(func) \
48*ad2fac55SRobert Clausecker 	.globl CNAME(func); \
49*ad2fac55SRobert Clausecker 	.type CNAME(func), @gnu_indirect_function; \
50*ad2fac55SRobert Clausecker 	.set CNAME(func), __CONCAT(func,_resolver); \
51*ad2fac55SRobert Clausecker 	ARCHENTRY(func, resolver); \
52*ad2fac55SRobert Clausecker 	lea __CONCAT(func,_funcs)(%rip), %r8; \
53*ad2fac55SRobert Clausecker 	jmp CNAME(__archlevel_resolve); \
54*ad2fac55SRobert Clausecker 	ARCHEND(func, resolver)
55*ad2fac55SRobert Clausecker 
56*ad2fac55SRobert Clausecker /*
57*ad2fac55SRobert Clausecker  * The func_funcs array stores the location of the implementations
58*ad2fac55SRobert Clausecker  * as the distance from the func_funcs array to the function.  Due
59*ad2fac55SRobert Clausecker  * to compiling for the medium code model, a 32 bit integer suffices
60*ad2fac55SRobert Clausecker  * to hold the distance.
61*ad2fac55SRobert Clausecker  *
62*ad2fac55SRobert Clausecker  * Doing it this way both saves storage and avoids giving rtld
63*ad2fac55SRobert Clausecker  * relocations to process at load time.
64*ad2fac55SRobert Clausecker  */
65*ad2fac55SRobert Clausecker #define ARCHFUNCS(func) \
66*ad2fac55SRobert Clausecker 	ARCHRESOLVE(func); \
67*ad2fac55SRobert Clausecker 	.section .rodata; \
68*ad2fac55SRobert Clausecker 	.align 4; \
69*ad2fac55SRobert Clausecker 	__CONCAT(func,_funcs):
70*ad2fac55SRobert Clausecker 
71*ad2fac55SRobert Clausecker #define NOARCHFUNC \
72*ad2fac55SRobert Clausecker 	.4byte 0
73*ad2fac55SRobert Clausecker 
74*ad2fac55SRobert Clausecker #define ARCHFUNC(func, level) \
75*ad2fac55SRobert Clausecker 	.4byte __CONCAT(__CONCAT(func,_),level) - __CONCAT(func,_funcs)
76*ad2fac55SRobert Clausecker 
77*ad2fac55SRobert Clausecker #define ENDARCHFUNCS(func) \
78*ad2fac55SRobert Clausecker 	.zero 4*(X86_64_MAX+1)-(.-__CONCAT(func,_funcs)); \
79*ad2fac55SRobert Clausecker 	.size __CONCAT(func,_funcs), .-__CONCAT(func,_funcs)
80*ad2fac55SRobert Clausecker 
81*ad2fac55SRobert Clausecker #define ARCHENTRY(func, level) \
82*ad2fac55SRobert Clausecker 	_START_ENTRY; \
83*ad2fac55SRobert Clausecker 	.type __CONCAT(__CONCAT(func,_),level), @function; \
84*ad2fac55SRobert Clausecker 	__CONCAT(__CONCAT(func,_),level):; \
85*ad2fac55SRobert Clausecker 	.cfi_startproc
86*ad2fac55SRobert Clausecker 
87*ad2fac55SRobert Clausecker #define ARCHEND(func, level) \
88*ad2fac55SRobert Clausecker 	END(__CONCAT(__CONCAT(func,_),level))
89*ad2fac55SRobert Clausecker 
90*ad2fac55SRobert Clausecker #endif  /* __ASSEMBLER__ */
91