Add IP_PROTOCOL from Linux 6.4 to bits/in.h
[glibc.git] / manual / platform.texi
blob2a2d557067ad60910ebec4d47734b00094180679
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_COMPLEX} -- Tile computational operations on complex FP16 numbers.
203 @item
204 @code{AMX_INT8} -- Tile computational operations on 8-bit numbers.
206 @item
207 @code{AMX_FP16} -- Tile computational operations on FP16 numbers.
209 @item
210 @code{AMX_TILE} -- Tile architecture.
212 @item
213 @code{APX_F} -- The APX instruction extensions.
215 @item
216 @code{ARCH_CAPABILITIES} -- IA32_ARCH_CAPABILITIES MSR.
218 @item
219 @code{ArchPerfmonExt} -- Architectural Performance Monitoring Extended
220 Leaf (EAX = 23H).
222 @item
223 @code{AVX} -- The AVX instruction extensions.
225 @item
226 @code{AVX2} -- The AVX2 instruction extensions.
228 @item
229 @code{AVX_IFMA} -- The AVX-IFMA instruction extensions.
231 @item
232 @code{AVX_NE_CONVERT} -- The AVX-NE-CONVERT instruction extensions.
234 @item
235 @code{AVX_VNNI} -- The AVX-VNNI instruction extensions.
237 @item
238 @code{AVX_VNNI_INT8} -- The AVX-VNNI-INT8 instruction extensions.
240 @item
241 @code{AVX512_4FMAPS} -- The AVX512_4FMAPS instruction extensions.
243 @item
244 @code{AVX512_4VNNIW} -- The AVX512_4VNNIW instruction extensions.
246 @item
247 @code{AVX512_BF16} -- The AVX512_BF16 instruction extensions.
249 @item
250 @code{AVX512_BITALG} -- The AVX512_BITALG instruction extensions.
252 @item
253 @code{AVX512_FP16} -- The AVX512_FP16 instruction extensions.
255 @item
256 @code{AVX512_IFMA} -- The AVX512_IFMA instruction extensions.
258 @item
259 @code{AVX512_VBMI} -- The AVX512_VBMI instruction extensions.
261 @item
262 @code{AVX512_VBMI2} -- The AVX512_VBMI2 instruction extensions.
264 @item
265 @code{AVX512_VNNI} -- The AVX512_VNNI instruction extensions.
267 @item
268 @code{AVX512_VP2INTERSECT} -- The AVX512_VP2INTERSECT instruction
269 extensions.
271 @item
272 @code{AVX512_VPOPCNTDQ} -- The AVX512_VPOPCNTDQ instruction extensions.
274 @item
275 @code{AVX512BW} -- The AVX512BW instruction extensions.
277 @item
278 @code{AVX512CD} -- The AVX512CD instruction extensions.
280 @item
281 @code{AVX512ER} -- The AVX512ER instruction extensions.
283 @item
284 @code{AVX512DQ} -- The AVX512DQ instruction extensions.
286 @item
287 @code{AVX512F} -- The AVX512F instruction extensions.
289 @item
290 @code{AVX512PF} -- The AVX512PF instruction extensions.
292 @item
293 @code{AVX512VL} -- The AVX512VL instruction extensions.
295 @item
296 @code{BMI1} -- BMI1 instructions.
298 @item
299 @code{BMI2} -- BMI2 instructions.
301 @item
302 @code{BUS_LOCK_DETECT} -- Bus lock debug exceptions.
304 @item
305 @code{CLDEMOTE} -- CLDEMOTE instruction.
307 @item
308 @code{CLFLUSHOPT} -- CLFLUSHOPT instruction.
310 @item
311 @code{CLFSH} -- CLFLUSH instruction.
313 @item
314 @code{CLWB} -- CLWB instruction.
316 @item
317 @code{CMOV} -- Conditional Move instructions.
319 @item
320 @code{CMPCCXADD} -- CMPccXADD instruction.
322 @item
323 @code{CMPXCHG16B} -- CMPXCHG16B instruction.
325 @item
326 @code{CNXT_ID} -- L1 Context ID.
328 @item
329 @code{CORE_CAPABILITIES} -- IA32_CORE_CAPABILITIES MSR.
331 @item
332 @code{CX8} -- CMPXCHG8B instruction.
334 @item
335 @code{DCA} -- Data prefetch from a memory mapped device.
337 @item
338 @code{DE} -- Debugging Extensions.
340 @item
341 @code{DEPR_FPU_CS_DS} -- Deprecates FPU CS and FPU DS values.
343 @item
344 @code{DS} -- Debug Store.
346 @item
347 @code{DS_CPL} -- CPL Qualified Debug Store.
349 @item
350 @code{DTES64} -- 64-bit DS Area.
352 @item
353 @code{EIST} -- Enhanced Intel SpeedStep technology.
355 @item
356 @code{ENQCMD} -- Enqueue Stores instructions.
358 @item
359 @code{ERMS} -- Enhanced REP MOVSB/STOSB.
361 @item
362 @code{F16C} -- 16-bit floating-point conversion instructions.
364 @item
365 @code{FMA} -- FMA extensions using YMM state.
367 @item
368 @code{FMA4} -- FMA4 instruction extensions.
370 @item
371 @code{FPU} -- X87 Floating Point Unit On-Chip.
373 @item
374 @code{FSGSBASE} -- RDFSBASE/RDGSBASE/WRFSBASE/WRGSBASE instructions.
376 @item
377 @code{FSRCS} -- Fast Short REP CMP and SCA.
379 @item
380 @code{FSRM} -- Fast Short REP MOV.
382 @item
383 @code{FSRS} -- Fast Short REP STO.
385 @item
386 @code{FXSR} -- FXSAVE and FXRSTOR instructions.
388 @item
389 @code{FZLRM} -- Fast Zero-Length REP MOV.
391 @item
392 @code{GFNI} -- GFNI instruction extensions.
394 @item
395 @code{HLE} -- HLE instruction extensions.
397 @item
398 @code{HTT} -- Max APIC IDs reserved field is Valid.
400 @item
401 @code{HRESET} -- History reset.
403 @item
404 @code{HYBRID} -- Hybrid processor.
406 @item
407 @code{IBRS_IBPB} -- Indirect branch restricted speculation (IBRS) and
408 the indirect branch predictor barrier (IBPB).
410 @item
411 @code{IBT} -- Intel Indirect Branch Tracking instruction extensions.
413 @item
414 @code{INVARIANT_TSC} -- Invariant TSC.
416 @item
417 @code{INVPCID} -- INVPCID instruction.
419 @item
420 @code{KL} -- AES Key Locker instructions.
422 @item
423 @code{L1D_FLUSH} -- IA32_FLUSH_CMD MSR.
425 @item
426 @code{LA57} -- 57-bit linear addresses and five-level paging.
428 @item
429 @code{LAHF64_SAHF64} -- LAHF/SAHF available in 64-bit mode.
431 @item
432 @code{LAM} -- Linear Address Masking.
434 @item
435 @code{LASS} -- Linear Address Space Separation.
437 @item
438 @code{LBR} -- Architectural LBR.
440 @item
441 @code{LM} -- Long mode.
443 @item
444 @code{LWP} -- Lightweight profiling.
446 @item
447 @code{LZCNT} -- LZCNT instruction.
449 @item
450 @code{MCA} -- Machine Check Architecture.
452 @item
453 @code{MCE} -- Machine Check Exception.
455 @item
456 @code{MD_CLEAR} -- MD_CLEAR.
458 @item
459 @code{MMX} -- Intel MMX Technology.
461 @item
462 @code{MONITOR} --  MONITOR/MWAIT instructions.
464 @item
465 @code{MOVBE} -- MOVBE instruction.
467 @item
468 @code{MOVDIRI} -- MOVDIRI instruction.
470 @item
471 @code{MOVDIR64B} -- MOVDIR64B instruction.
473 @item
474 @code{MPX} -- Intel Memory Protection Extensions.
476 @item
477 @code{MSR} -- Model Specific Registers RDMSR and WRMSR instructions.
479 @item
480 @code{MSRLIST} -- RDMSRLIST/WRMSRLIST instructions and IA32_BARRIER
481 MSR.
483 @item
484 @code{MTRR} -- Memory Type Range Registers.
486 @item
487 @code{NX} -- No-execute page protection.
489 @item
490 @code{OSPKE} -- OS has set CR4.PKE to enable protection keys.
492 @item
493 @code{OSXSAVE} -- The OS has set CR4.OSXSAVE[bit 18] to enable
494 XSETBV/XGETBV instructions to access XCR0 and to support processor
495 extended state management using XSAVE/XRSTOR.
497 @item
498 @code{PAE} -- Physical Address Extension.
500 @item
501 @code{PAGE1GB} -- 1-GByte page.
503 @item
504 @code{PAT} -- Page Attribute Table.
506 @item
507 @code{PBE} -- Pending Break Enable.
509 @item
510 @code{PCID} -- Process-context identifiers.
512 @item
513 @code{PCLMULQDQ} -- PCLMULQDQ instruction.
515 @item
516 @code{PCONFIG} -- PCONFIG instruction.
518 @item
519 @code{PDCM} -- Perfmon and Debug Capability.
521 @item
522 @code{PGE} -- Page Global Bit.
524 @item
525 @code{PKS} -- Protection keys for supervisor-mode pages.
527 @item
528 @code{PKU} -- Protection keys for user-mode pages.
530 @item
531 @code{POPCNT} -- POPCNT instruction.
533 @item
534 @code{PREFETCHW} -- PREFETCHW instruction.
536 @item
537 @code{PREFETCHWT1} -- PREFETCHWT1 instruction.
539 @item
540 @code{PREFETCHI} -- PREFETCHIT0/1 instructions.
542 @item
543 @code{PSE} -- Page Size Extension.
545 @item
546 @code{PSE_36} -- 36-Bit Page Size Extension.
548 @item
549 @code{PSN} -- Processor Serial Number.
551 @item
552 @code{PTWRITE} -- PTWRITE instruction.
554 @item
555 @code{RAO_INT} -- RAO-INT instructions.
557 @item
558 @code{RDPID} -- RDPID instruction.
560 @item
561 @code{RDRAND} -- RDRAND instruction.
563 @item
564 @code{RDSEED} -- RDSEED instruction.
566 @item
567 @code{RDT_A} -- Intel Resource Director Technology (Intel RDT) Allocation
568 capability.
570 @item
571 @code{RDT_M} -- Intel Resource Director Technology (Intel RDT) Monitoring
572 capability.
574 @item
575 @code{RDTSCP} -- RDTSCP instruction.
577 @item
578 @code{RTM} -- RTM instruction extensions.
580 @item
581 @code{RTM_ALWAYS_ABORT} -- Transactions always abort, making RTM unusable.
583 @item
584 @code{RTM_FORCE_ABORT} -- TSX_FORCE_ABORT MSR.
586 @item
587 @code{SDBG} -- IA32_DEBUG_INTERFACE MSR for silicon debug.
589 @item
590 @code{SEP} -- SYSENTER and SYSEXIT instructions.
592 @item
593 @code{SERIALIZE} -- SERIALIZE instruction.
595 @item
596 @code{SGX} -- Intel Software Guard Extensions.
598 @item
599 @code{SGX_KEYS} -- Attestation Services for SGX.
601 @item
602 @code{SGX_LC} -- SGX Launch Configuration.
604 @item
605 @code{SHA} -- SHA instruction extensions.
607 @item
608 @code{SHSTK} -- Intel Shadow Stack instruction extensions.
610 @item
611 @code{SMAP} -- Supervisor-Mode Access Prevention.
613 @item
614 @code{SMEP} -- Supervisor-Mode Execution Prevention.
616 @item
617 @code{SMX} -- Safer Mode Extensions.
619 @item
620 @code{SS} -- Self Snoop.
622 @item
623 @code{SSBD} -- Speculative Store Bypass Disable (SSBD).
625 @item
626 @code{SSE} -- Streaming SIMD Extensions.
628 @item
629 @code{SSE2} -- Streaming SIMD Extensions 2.
631 @item
632 @code{SSE3} -- Streaming SIMD Extensions 3.
634 @item
635 @code{SSE4_1} -- Streaming SIMD Extensions 4.1.
637 @item
638 @code{SSE4_2} -- Streaming SIMD Extensions 4.2.
640 @item
641 @code{SSE4A} -- SSE4A instruction extensions.
643 @item
644 @code{SSSE3} -- Supplemental Streaming SIMD Extensions 3.
646 @item
647 @code{STIBP} -- Single thread indirect branch predictors (STIBP).
649 @item
650 @code{SVM} -- Secure Virtual Machine.
652 @item
653 @code{SYSCALL_SYSRET} -- SYSCALL/SYSRET instructions.
655 @item
656 @code{TBM} -- Trailing bit manipulation instructions.
658 @item
659 @code{TM} -- Thermal Monitor.
661 @item
662 @code{TM2} -- Thermal Monitor 2.
664 @item
665 @code{TRACE} -- Intel Processor Trace.
667 @item
668 @code{TSC} -- Time Stamp Counter.  RDTSC instruction.
670 @item
671 @code{TSC_ADJUST} -- IA32_TSC_ADJUST MSR.
673 @item
674 @code{TSC_DEADLINE} -- Local APIC timer supports one-shot operation
675 using a TSC deadline value.
677 @item
678 @code{TSXLDTRK} -- TSXLDTRK instructions.
680 @item
681 @code{UINTR} -- User interrupts.
683 @item
684 @code{UMIP} -- User-mode instruction prevention.
686 @item
687 @code{VAES} -- VAES instruction extensions.
689 @item
690 @code{VME} -- Virtual 8086 Mode Enhancements.
692 @item
693 @code{VMX} -- Virtual Machine Extensions.
695 @item
696 @code{VPCLMULQDQ} -- VPCLMULQDQ instruction.
698 @item
699 @code{WAITPKG} -- WAITPKG instruction extensions.
701 @item
702 @code{WBNOINVD} -- WBINVD/WBNOINVD instructions.
704 @item
705 @code{WIDE_KL} -- AES wide Key Locker instructions.
707 @item
708 @code{WRMSRNS} -- WRMSRNS instruction.
710 @item
711 @code{X2APIC} -- x2APIC.
713 @item
714 @code{XFD} -- Extended Feature Disable (XFD).
716 @item
717 @code{XGETBV_ECX_1} -- XGETBV with ECX = 1.
719 @item
720 @code{XOP} -- XOP instruction extensions.
722 @item
723 @code{XSAVE} -- The XSAVE/XRSTOR processor extended states feature, the
724 XSETBV/XGETBV instructions, and XCR0.
726 @item
727 @code{XSAVEC} -- XSAVEC instruction.
729 @item
730 @code{XSAVEOPT} -- XSAVEOPT instruction.
732 @item
733 @code{XSAVES} -- XSAVES/XRSTORS instructions.
735 @item
736 @code{XTPRUPDCTRL} -- xTPR Update Control.
738 @end itemize
740 You could query if a processor supports @code{AVX} with:
742 @smallexample
743 #include <sys/platform/x86.h>
746 avx_present (void)
748   return CPU_FEATURE_PRESENT (AVX);
750 @end smallexample
752 and if @code{AVX} is active and may be used with:
754 @smallexample
755 #include <sys/platform/x86.h>
758 avx_active (void)
760   return CPU_FEATURE_ACTIVE (AVX);
762 @end smallexample