<sys/platform/x86.h>: Add AVX-VNNI-INT8 support
[glibc.git] / manual / platform.texi
blob873ea0a84a6aa43f332792644db11a3cf307c89b
1 @node Platform, Contributors, Maintenance, Top
2 @c %MENU% Describe all platform-specific facilities provided
3 @appendix Platform-specific facilities
5 @Theglibc{} can provide machine-specific functionality.
7 @menu
8 * PowerPC::           Facilities Specific to the PowerPC Architecture
9 * RISC-V::            Facilities Specific to the RISC-V Architecture
10 * X86::               Facilities Specific to the X86 Architecture
11 @end menu
13 @node PowerPC
14 @appendixsec PowerPC-specific Facilities
16 Facilities specific to PowerPC that are not specific to a particular
17 operating system are declared in @file{sys/platform/ppc.h}.
19 @deftypefun {uint64_t} __ppc_get_timebase (void)
20 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
21 Read the current value of the Time Base Register.
23 The @dfn{Time Base Register} is a 64-bit register that stores a monotonically
24 incremented value updated at a system-dependent frequency that may be
25 different from the processor frequency.  More information is available in
26 @cite{Power ISA 2.06b - Book II - Section 5.2}.
28 @code{__ppc_get_timebase} uses the processor's time base facility directly
29 without requiring assistance from the operating system, so it is very
30 efficient.
31 @end deftypefun
33 @deftypefun {uint64_t} __ppc_get_timebase_freq (void)
34 @safety{@prelim{}@mtunsafe{@mtuinit{}}@asunsafe{@asucorrupt{:init}}@acunsafe{@acucorrupt{:init}}}
35 @c __ppc_get_timebase_freq=__get_timebase_freq @mtuinit @acsfd
36 @c  __get_clockfreq @mtuinit @asucorrupt:init @acucorrupt:init @acsfd
37 @c    the initialization of the static timebase_freq is not exactly
38 @c    safe, because hp_timing_t cannot be atomically set up.
39 @c   syscall:get_tbfreq ok
40 @c   open dup @acsfd
41 @c   read dup ok
42 @c   memcpy dup ok
43 @c   memmem dup ok
44 @c   close dup @acsfd
45 Read the current frequency at which the Time Base Register is updated.
47 This frequency is not related to the processor clock or the bus clock.
48 It is also possible that this frequency is not constant.  More information is
49 available in @cite{Power ISA 2.06b - Book II - Section 5.2}.
50 @end deftypefun
52 The following functions provide hints about the usage of resources that are
53 shared with other processors.  They can be used, for example, if a program
54 waiting on a lock intends to divert the shared resources to be used by other
55 processors.  More information is available in @cite{Power ISA 2.06b - Book II -
56 Section 3.2}.
58 @deftypefun {void} __ppc_yield (void)
59 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
60 Provide a hint that performance will probably be improved if shared resources
61 dedicated to the executing processor are released for use by other processors.
62 @end deftypefun
64 @deftypefun {void} __ppc_mdoio (void)
65 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
66 Provide a hint that performance will probably be improved if shared resources
67 dedicated to the executing processor are released until all outstanding storage
68 accesses to caching-inhibited storage have been completed.
69 @end deftypefun
71 @deftypefun {void} __ppc_mdoom (void)
72 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
73 Provide a hint that performance will probably be improved if shared resources
74 dedicated to the executing processor are released until all outstanding storage
75 accesses to cacheable storage for which the data is not in the cache have been
76 completed.
77 @end deftypefun
79 @deftypefun {void} __ppc_set_ppr_med (void)
80 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
81 Set the Program Priority Register to medium value (default).
83 The @dfn{Program Priority Register} (PPR) is a 64-bit register that controls
84 the program's priority.  By adjusting the PPR value the programmer may
85 improve system throughput by causing the system resources to be used
86 more efficiently, especially in contention situations.
87 The three unprivileged states available are covered by the functions
88 @code{__ppc_set_ppr_med} (medium -- default), @code{__ppc_set_ppc_low} (low)
89 and @code{__ppc_set_ppc_med_low} (medium low).  More information
90 available in @cite{Power ISA 2.06b - Book II - Section 3.1}.
91 @end deftypefun
93 @deftypefun {void} __ppc_set_ppr_low (void)
94 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
95 Set the Program Priority Register to low value.
96 @end deftypefun
98 @deftypefun {void} __ppc_set_ppr_med_low (void)
99 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
100 Set the Program Priority Register to medium low value.
101 @end deftypefun
103 Power ISA 2.07 extends the priorities that can be set to the Program Priority
104 Register (PPR).  The following functions implement the new priority levels:
105 very low and medium high.
107 @deftypefun {void} __ppc_set_ppr_very_low (void)
108 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
109 Set the Program Priority Register to very low value.
110 @end deftypefun
112 @deftypefun {void} __ppc_set_ppr_med_high (void)
113 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
114 Set the Program Priority Register to medium high value.  The medium high
115 priority is privileged and may only be set during certain time intervals by
116 problem-state programs.  If the program priority is medium high when the time
117 interval expires or if an attempt is made to set the priority to medium high
118 when it is not allowed, the priority is set to medium.
119 @end deftypefun
121 @node RISC-V
122 @appendixsec RISC-V-specific Facilities
124 Cache management facilities specific to RISC-V systems that implement the Linux
125 ABI are declared in @file{sys/cachectl.h}.
127 @deftypefun {void} __riscv_flush_icache (void *@var{start}, void *@var{end}, unsigned long int @var{flags})
128 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
129 Enforce ordering between stores and instruction cache fetches.  The range of
130 addresses over which ordering is enforced is specified by @var{start} and
131 @var{end}.  The @var{flags} argument controls the extent of this ordering, with
132 the default behavior (a @var{flags} value of 0) being to enforce the fence on
133 all threads in the current process.  Setting the
134 @code{SYS_RISCV_FLUSH_ICACHE_LOCAL} bit allows users to indicate that enforcing
135 ordering on only the current thread is necessary.  All other flag bits are
136 reserved.
137 @end deftypefun
139 @node X86
140 @appendixsec X86-specific Facilities
142 Facilities specific to X86 that are not specific to a particular
143 operating system are declared in @file{sys/platform/x86.h}.
145 @deftypefun {const struct cpuid_feature *} __x86_get_cpuid_feature_leaf (unsigned int @var{leaf})
146 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
147 Return a pointer to x86 CPU feature structure used by query macros for x86
148 CPU feature @var{leaf}.
149 @end deftypefun
151 @deftypefn Macro int CPU_FEATURE_PRESENT (@var{name})
152 This macro returns a nonzero value (true) if the processor has the feature
153 @var{name}.
154 @end deftypefn
156 @deftypefn Macro int CPU_FEATURE_ACTIVE (@var{name})
157 This macro returns a nonzero value (true) if the processor has the feature
158 @var{name} and the feature is active.  There may be other preconditions,
159 like sufficient stack space or further setup for AMX, which must be
160 satisfied before the feature can be used.
161 @end deftypefn
163 The supported processor features are:
165 @itemize @bullet
167 @item
168 @code{ACPI} -- Thermal Monitor and Software Controlled Clock Facilities.
170 @item
171 @code{ADX} -- ADX instruction extensions.
173 @item
174 @code{APIC} -- APIC On-Chip.
176 @item
177 @code{AES} -- The AES instruction extensions.
179 @item
180 @code{AESKLE} -- AES Key Locker instructions are enabled by OS.
182 @item
183 @code{AMD_IBPB} -- Indirect branch predictor barrier (IBPB) for AMD cpus.
185 @item
186 @code{AMD_IBRS} -- Indirect branch restricted speculation (IBPB) for AMD cpus.
188 @item
189 @code{AMD_SSBD} -- Speculative Store Bypass Disable (SSBD) for AMD cpus.
191 @item
192 @code{AMD_STIBP} -- Single thread indirect branch predictors (STIBP) for AMD cpus.
194 @item
195 @code{AMD_VIRT_SSBD} -- Speculative Store Bypass Disable (SSBD) for AMD cpus (older systems).
197 @item
198 @code{AMX_BF16} -- Tile computational operations on bfloat16 numbers.
200 @item
201 @code{AMX_INT8} -- Tile computational operations on 8-bit numbers.
203 @item
204 @code{AMX_FP16} -- Tile computational operations on FP16 numbers.
206 @item
207 @code{AMX_TILE} -- Tile architecture.
209 @item
210 @code{ARCH_CAPABILITIES} -- IA32_ARCH_CAPABILITIES MSR.
212 @item
213 @code{ArchPerfmonExt} -- Architectural Performance Monitoring Extended
214 Leaf (EAX = 23H).
216 @item
217 @code{AVX} -- The AVX instruction extensions.
219 @item
220 @code{AVX2} -- The AVX2 instruction extensions.
222 @item
223 @code{AVX_IFMA} -- The AVX-IFMA instruction extensions.
225 @item
226 @code{AVX_VNNI} -- The AVX-VNNI instruction extensions.
228 @item
229 @code{AVX_VNNI_INT8} -- The AVX-VNNI-INT8 instruction extensions.
231 @item
232 @code{AVX512_4FMAPS} -- The AVX512_4FMAPS instruction extensions.
234 @item
235 @code{AVX512_4VNNIW} -- The AVX512_4VNNIW instruction extensions.
237 @item
238 @code{AVX512_BF16} -- The AVX512_BF16 instruction extensions.
240 @item
241 @code{AVX512_BITALG} -- The AVX512_BITALG instruction extensions.
243 @item
244 @code{AVX512_FP16} -- The AVX512_FP16 instruction extensions.
246 @item
247 @code{AVX512_IFMA} -- The AVX512_IFMA instruction extensions.
249 @item
250 @code{AVX512_VBMI} -- The AVX512_VBMI instruction extensions.
252 @item
253 @code{AVX512_VBMI2} -- The AVX512_VBMI2 instruction extensions.
255 @item
256 @code{AVX512_VNNI} -- The AVX512_VNNI instruction extensions.
258 @item
259 @code{AVX512_VP2INTERSECT} -- The AVX512_VP2INTERSECT instruction
260 extensions.
262 @item
263 @code{AVX512_VPOPCNTDQ} -- The AVX512_VPOPCNTDQ instruction extensions.
265 @item
266 @code{AVX512BW} -- The AVX512BW instruction extensions.
268 @item
269 @code{AVX512CD} -- The AVX512CD instruction extensions.
271 @item
272 @code{AVX512ER} -- The AVX512ER instruction extensions.
274 @item
275 @code{AVX512DQ} -- The AVX512DQ instruction extensions.
277 @item
278 @code{AVX512F} -- The AVX512F instruction extensions.
280 @item
281 @code{AVX512PF} -- The AVX512PF instruction extensions.
283 @item
284 @code{AVX512VL} -- The AVX512VL instruction extensions.
286 @item
287 @code{BMI1} -- BMI1 instructions.
289 @item
290 @code{BMI2} -- BMI2 instructions.
292 @item
293 @code{BUS_LOCK_DETECT} -- Bus lock debug exceptions.
295 @item
296 @code{CLDEMOTE} -- CLDEMOTE instruction.
298 @item
299 @code{CLFLUSHOPT} -- CLFLUSHOPT instruction.
301 @item
302 @code{CLFSH} -- CLFLUSH instruction.
304 @item
305 @code{CLWB} -- CLWB instruction.
307 @item
308 @code{CMOV} -- Conditional Move instructions.
310 @item
311 @code{CMPCCXADD} -- CMPccXADD instruction.
313 @item
314 @code{CMPXCHG16B} -- CMPXCHG16B instruction.
316 @item
317 @code{CNXT_ID} -- L1 Context ID.
319 @item
320 @code{CORE_CAPABILITIES} -- IA32_CORE_CAPABILITIES MSR.
322 @item
323 @code{CX8} -- CMPXCHG8B instruction.
325 @item
326 @code{DCA} -- Data prefetch from a memory mapped device.
328 @item
329 @code{DE} -- Debugging Extensions.
331 @item
332 @code{DEPR_FPU_CS_DS} -- Deprecates FPU CS and FPU DS values.
334 @item
335 @code{DS} -- Debug Store.
337 @item
338 @code{DS_CPL} -- CPL Qualified Debug Store.
340 @item
341 @code{DTES64} -- 64-bit DS Area.
343 @item
344 @code{EIST} -- Enhanced Intel SpeedStep technology.
346 @item
347 @code{ENQCMD} -- Enqueue Stores instructions.
349 @item
350 @code{ERMS} -- Enhanced REP MOVSB/STOSB.
352 @item
353 @code{F16C} -- 16-bit floating-point conversion instructions.
355 @item
356 @code{FMA} -- FMA extensions using YMM state.
358 @item
359 @code{FMA4} -- FMA4 instruction extensions.
361 @item
362 @code{FPU} -- X87 Floating Point Unit On-Chip.
364 @item
365 @code{FSGSBASE} -- RDFSBASE/RDGSBASE/WRFSBASE/WRGSBASE instructions.
367 @item
368 @code{FSRCS} -- Fast Short REP CMP and SCA.
370 @item
371 @code{FSRM} -- Fast Short REP MOV.
373 @item
374 @code{FSRS} -- Fast Short REP STO.
376 @item
377 @code{FXSR} -- FXSAVE and FXRSTOR instructions.
379 @item
380 @code{FZLRM} -- Fast Zero-Length REP MOV.
382 @item
383 @code{GFNI} -- GFNI instruction extensions.
385 @item
386 @code{HLE} -- HLE instruction extensions.
388 @item
389 @code{HTT} -- Max APIC IDs reserved field is Valid.
391 @item
392 @code{HRESET} -- History reset.
394 @item
395 @code{HYBRID} -- Hybrid processor.
397 @item
398 @code{IBRS_IBPB} -- Indirect branch restricted speculation (IBRS) and
399 the indirect branch predictor barrier (IBPB).
401 @item
402 @code{IBT} -- Intel Indirect Branch Tracking instruction extensions.
404 @item
405 @code{INVARIANT_TSC} -- Invariant TSC.
407 @item
408 @code{INVPCID} -- INVPCID instruction.
410 @item
411 @code{KL} -- AES Key Locker instructions.
413 @item
414 @code{L1D_FLUSH} -- IA32_FLUSH_CMD MSR.
416 @item
417 @code{LA57} -- 57-bit linear addresses and five-level paging.
419 @item
420 @code{LAHF64_SAHF64} -- LAHF/SAHF available in 64-bit mode.
422 @item
423 @code{LAM} -- Linear Address Masking.
425 @item
426 @code{LASS} -- Linear Address Space Separation.
428 @item
429 @code{LBR} -- Architectural LBR.
431 @item
432 @code{LM} -- Long mode.
434 @item
435 @code{LWP} -- Lightweight profiling.
437 @item
438 @code{LZCNT} -- LZCNT instruction.
440 @item
441 @code{MCA} -- Machine Check Architecture.
443 @item
444 @code{MCE} -- Machine Check Exception.
446 @item
447 @code{MD_CLEAR} -- MD_CLEAR.
449 @item
450 @code{MMX} -- Intel MMX Technology.
452 @item
453 @code{MONITOR} --  MONITOR/MWAIT instructions.
455 @item
456 @code{MOVBE} -- MOVBE instruction.
458 @item
459 @code{MOVDIRI} -- MOVDIRI instruction.
461 @item
462 @code{MOVDIR64B} -- MOVDIR64B instruction.
464 @item
465 @code{MPX} -- Intel Memory Protection Extensions.
467 @item
468 @code{MSR} -- Model Specific Registers RDMSR and WRMSR instructions.
470 @item
471 @code{MSRLIST} -- RDMSRLIST/WRMSRLIST instructions and IA32_BARRIER
472 MSR.
474 @item
475 @code{MTRR} -- Memory Type Range Registers.
477 @item
478 @code{NX} -- No-execute page protection.
480 @item
481 @code{OSPKE} -- OS has set CR4.PKE to enable protection keys.
483 @item
484 @code{OSXSAVE} -- The OS has set CR4.OSXSAVE[bit 18] to enable
485 XSETBV/XGETBV instructions to access XCR0 and to support processor
486 extended state management using XSAVE/XRSTOR.
488 @item
489 @code{PAE} -- Physical Address Extension.
491 @item
492 @code{PAGE1GB} -- 1-GByte page.
494 @item
495 @code{PAT} -- Page Attribute Table.
497 @item
498 @code{PBE} -- Pending Break Enable.
500 @item
501 @code{PCID} -- Process-context identifiers.
503 @item
504 @code{PCLMULQDQ} -- PCLMULQDQ instruction.
506 @item
507 @code{PCONFIG} -- PCONFIG instruction.
509 @item
510 @code{PDCM} -- Perfmon and Debug Capability.
512 @item
513 @code{PGE} -- Page Global Bit.
515 @item
516 @code{PKS} -- Protection keys for supervisor-mode pages.
518 @item
519 @code{PKU} -- Protection keys for user-mode pages.
521 @item
522 @code{POPCNT} -- POPCNT instruction.
524 @item
525 @code{PREFETCHW} -- PREFETCHW instruction.
527 @item
528 @code{PREFETCHWT1} -- PREFETCHWT1 instruction.
530 @item
531 @code{PSE} -- Page Size Extension.
533 @item
534 @code{PSE_36} -- 36-Bit Page Size Extension.
536 @item
537 @code{PSN} -- Processor Serial Number.
539 @item
540 @code{PTWRITE} -- PTWRITE instruction.
542 @item
543 @code{RAO_INT} -- RAO-INT instructions.
545 @item
546 @code{RDPID} -- RDPID instruction.
548 @item
549 @code{RDRAND} -- RDRAND instruction.
551 @item
552 @code{RDSEED} -- RDSEED instruction.
554 @item
555 @code{RDT_A} -- Intel Resource Director Technology (Intel RDT) Allocation
556 capability.
558 @item
559 @code{RDT_M} -- Intel Resource Director Technology (Intel RDT) Monitoring
560 capability.
562 @item
563 @code{RDTSCP} -- RDTSCP instruction.
565 @item
566 @code{RTM} -- RTM instruction extensions.
568 @item
569 @code{RTM_ALWAYS_ABORT} -- Transactions always abort, making RTM unusable.
571 @item
572 @code{RTM_FORCE_ABORT} -- TSX_FORCE_ABORT MSR.
574 @item
575 @code{SDBG} -- IA32_DEBUG_INTERFACE MSR for silicon debug.
577 @item
578 @code{SEP} -- SYSENTER and SYSEXIT instructions.
580 @item
581 @code{SERIALIZE} -- SERIALIZE instruction.
583 @item
584 @code{SGX} -- Intel Software Guard Extensions.
586 @item
587 @code{SGX_KEYS} -- Attestation Services for SGX.
589 @item
590 @code{SGX_LC} -- SGX Launch Configuration.
592 @item
593 @code{SHA} -- SHA instruction extensions.
595 @item
596 @code{SHSTK} -- Intel Shadow Stack instruction extensions.
598 @item
599 @code{SMAP} -- Supervisor-Mode Access Prevention.
601 @item
602 @code{SMEP} -- Supervisor-Mode Execution Prevention.
604 @item
605 @code{SMX} -- Safer Mode Extensions.
607 @item
608 @code{SS} -- Self Snoop.
610 @item
611 @code{SSBD} -- Speculative Store Bypass Disable (SSBD).
613 @item
614 @code{SSE} -- Streaming SIMD Extensions.
616 @item
617 @code{SSE2} -- Streaming SIMD Extensions 2.
619 @item
620 @code{SSE3} -- Streaming SIMD Extensions 3.
622 @item
623 @code{SSE4_1} -- Streaming SIMD Extensions 4.1.
625 @item
626 @code{SSE4_2} -- Streaming SIMD Extensions 4.2.
628 @item
629 @code{SSE4A} -- SSE4A instruction extensions.
631 @item
632 @code{SSSE3} -- Supplemental Streaming SIMD Extensions 3.
634 @item
635 @code{STIBP} -- Single thread indirect branch predictors (STIBP).
637 @item
638 @code{SVM} -- Secure Virtual Machine.
640 @item
641 @code{SYSCALL_SYSRET} -- SYSCALL/SYSRET instructions.
643 @item
644 @code{TBM} -- Trailing bit manipulation instructions.
646 @item
647 @code{TM} -- Thermal Monitor.
649 @item
650 @code{TM2} -- Thermal Monitor 2.
652 @item
653 @code{TRACE} -- Intel Processor Trace.
655 @item
656 @code{TSC} -- Time Stamp Counter.  RDTSC instruction.
658 @item
659 @code{TSC_ADJUST} -- IA32_TSC_ADJUST MSR.
661 @item
662 @code{TSC_DEADLINE} -- Local APIC timer supports one-shot operation
663 using a TSC deadline value.
665 @item
666 @code{TSXLDTRK} -- TSXLDTRK instructions.
668 @item
669 @code{UINTR} -- User interrupts.
671 @item
672 @code{UMIP} -- User-mode instruction prevention.
674 @item
675 @code{VAES} -- VAES instruction extensions.
677 @item
678 @code{VME} -- Virtual 8086 Mode Enhancements.
680 @item
681 @code{VMX} -- Virtual Machine Extensions.
683 @item
684 @code{VPCLMULQDQ} -- VPCLMULQDQ instruction.
686 @item
687 @code{WAITPKG} -- WAITPKG instruction extensions.
689 @item
690 @code{WBNOINVD} -- WBINVD/WBNOINVD instructions.
692 @item
693 @code{WIDE_KL} -- AES wide Key Locker instructions.
695 @item
696 @code{WRMSRNS} -- WRMSRNS instruction.
698 @item
699 @code{X2APIC} -- x2APIC.
701 @item
702 @code{XFD} -- Extended Feature Disable (XFD).
704 @item
705 @code{XGETBV_ECX_1} -- XGETBV with ECX = 1.
707 @item
708 @code{XOP} -- XOP instruction extensions.
710 @item
711 @code{XSAVE} -- The XSAVE/XRSTOR processor extended states feature, the
712 XSETBV/XGETBV instructions, and XCR0.
714 @item
715 @code{XSAVEC} -- XSAVEC instruction.
717 @item
718 @code{XSAVEOPT} -- XSAVEOPT instruction.
720 @item
721 @code{XSAVES} -- XSAVES/XRSTORS instructions.
723 @item
724 @code{XTPRUPDCTRL} -- xTPR Update Control.
726 @end itemize
728 You could query if a processor supports @code{AVX} with:
730 @smallexample
731 #include <sys/platform/x86.h>
734 avx_present (void)
736   return CPU_FEATURE_PRESENT (AVX);
738 @end smallexample
740 and if @code{AVX} is active and may be used with:
742 @smallexample
743 #include <sys/platform/x86.h>
746 avx_active (void)
748   return CPU_FEATURE_ACTIVE (AVX);
750 @end smallexample