]> git.ipfire.org Git - thirdparty/man-pages.git/blame - man3/__ppc_yield.3
__ppc_yield.3: Document PPC performance-hint functions
[thirdparty/man-pages.git] / man3 / __ppc_yield.3
CommitLineData
36b53105
GG
1.\" Copyright (c) 2015, IBM Corporation.
2.\"
3.\" %%%LICENSE_START(VERBATIM)
4.\" Permission is granted to make and distribute verbatim copies of this
5.\" manual provided the copyright notice and this permission notice are
6.\" preserved on all copies.
7.\"
8.\" Permission is granted to copy and distribute modified versions of
9.\" this manual under the conditions for verbatim copying, provided that
10.\" the entire resulting derived work is distributed under the terms of
11.\" a permission notice identical to this one.
12.\"
13.\" Since the Linux kernel and libraries are constantly changing, this
14.\" manual page may be incorrect or out-of-date. The author(s) assume.
15.\" no responsibility for errors or omissions, or for damages resulting.
16.\" from the use of the information contained herein. The author(s) may.
17.\" not have taken the same level of care in the production of this.
18.\" manual, which is licensed free of charge, as they might when working.
19.\" professionally.
20.\"
21.\" Formatted or processed versions of this manual, if unaccompanied by
22.\" the source, must acknowledge the copyright and authors of this work.
23.\" %%%LICENSE_END
24.\"
25.\" Process this file with
26.\" groff -man -Tascii foo.1
27.\"
28.TH __PPC_YIELD 3 2015-08-05 "GNU C Library" "Linux Programmer's\
29Manual"
30.SH NAME
31__ppc_yield, __ppc_mdoio, __ppc_mdoom \-
32Hint the processor to release shared resources
33.SH SYNOPSIS
34.B #include <sys/platform/ppc.h>
35.sp
36.B void __ppc_yield(void);
37.br
38.B void __ppc_mdoio(void);
39.br
40.B void __ppc_mdoom(void);
41.SH DESCRIPTION
42The functions
43.BR __ppc_yield (),
44.BR __ppc_mdoio ()
45and
46.BR __ppc_mdoom ()
47provide hints about the usage of resources that are shared with other
48processors.
49They can be used, for example, if a program waiting on a lock intends
50to divert the shared resources to be used by other processors.
51More information is available in Power ISA 2.06b - Book II - Section
523.2.
53.P
54.BR __ppc_yield ()
55provides a hint that performance will probably be improved if shared
56resources dedicated to the executing processor are released for use by
57other processors.
58.P
59.BR __ppc_mdoio ()
60provides a hint that performance will probably be improved if shared
61resources dedicated to the executing processor are released until all
62outstanding storage accesses to caching-inhibited storage have been
63completed.
64.P
65.BR __ppc_mdoom ()
66provides a hint that performance will probably be improved if shared
67resources dedicated to the executing processor are released until all
68outstanding storage accesses to cacheable storage for which the data
69is not in the cache have been completed.
70.SH VERSIONS
71GNU C Library added support for
72.BR __ppc_yield (),
73.BR __ppc_mdoio ()
74and
75.BR __ppc_mdoom ()
76in version 2.18.
77.SH ATTRIBUTES
78For an explanation of the terms used in this section, see
79.BR attributes (7).
80.ad l
81.TS
82allbox;
83lb lb lb
84l l l.
85Interface Attribute Value
86T{
87.BR __ppc_yield (),
88.BR __ppc_mdoio (),
89.BR __ppc_mdoom ()
90T} Thread safety MT-Safe
91.TE
92.ad
93.SH CONFORMING TO
94These functions are nonstandard GNU extensions.
95.SH SEE ALSO
96.BR __ppc_set_ppr_med (3)