[thirdparty/man-pages.git] / man3 / __ppc_yield.3

.\" Copyright (c) 2015, IBM Corporation.
.\"
.\" %%%LICENSE_START(VERBATIM)
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of
.\" this manual under the conditions for verbatim copying, provided that
.\" the entire resulting derived work is distributed under the terms of
.\" a permission notice identical to this one.
.\"
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume.
.\" no responsibility for errors or omissions, or for damages resulting.
.\" from the use of the information contained herein.  The author(s) may.
.\" not have taken the same level of care in the production of this.
.\" manual, which is licensed free of charge, as they might when working.
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\" %%%LICENSE_END
.\"
.TH __PPC_YIELD 3 2017-09-15 "GNU C Library" "Linux Programmer's\
Manual"
.SH NAME
__ppc_yield, __ppc_mdoio, __ppc_mdoom \-
Hint the processor to release shared resources
.SH SYNOPSIS
.B #include <sys/platform/ppc.h>
.PP
.B void __ppc_yield(void);
.br
.B void __ppc_mdoio(void);
.br
.B void __ppc_mdoom(void);
.SH DESCRIPTION
These functions
provide hints about the usage of resources that are shared with other
processors on the Power architecture.
They can be used, for example, if a program waiting on a lock intends
to divert the shared resources to be used by other processors.
.PP
.BR __ppc_yield ()
provides a hint that performance will probably be improved if shared
resources dedicated to the executing processor are released for use by
other processors.
.PP
.BR __ppc_mdoio ()
provides a hint that performance will probably be improved if shared
resources dedicated to the executing processor are released until all
outstanding storage accesses to caching-inhibited storage have been
completed.
.PP
.BR __ppc_mdoom ()
provides a hint that performance will probably be improved if shared
resources dedicated to the executing processor are released until all
outstanding storage accesses to cacheable storage for which the data
is not in the cache have been completed.
.SH VERSIONS
These functions first appeared in glibc in version 2.18.
.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
.ad l
.TS
allbox;
lbw29 lb lb
l l l.
Interface	Attribute	Value
T{
.BR __ppc_yield (),
.BR __ppc_mdoio (),
.BR __ppc_mdoom ()
T}	Thread safety	MT-Safe
.TE
.ad
.SH CONFORMING TO
These functions are nonstandard GNU extensions.
.SH SEE ALSO
.BR __ppc_set_ppr_med (3)
.PP
.IR "Power ISA, Book\ II - Section\ 3.2 (""or"" architecture)"
Commit	Line	Data
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	.\"
4b8c67d9	25	.TH __PPC_YIELD 3 2017-09-15 "GNU C Library" "Linux Programmer's\
36b53105 GG	26	Manual"
	27	.SH NAME
	28	__ppc_yield, __ppc_mdoio, __ppc_mdoom \-
	29	Hint the processor to release shared resources
	30	.SH SYNOPSIS
	31	.B #include <sys/platform/ppc.h>
68e4db0a	32	.PP
36b53105 GG	33	.B void __ppc_yield(void);
	34	.br
	35	.B void __ppc_mdoio(void);
	36	.br
	37	.B void __ppc_mdoom(void);
	38	.SH DESCRIPTION
2cd276f3	39	These functions
36b53105	40	provide hints about the usage of resources that are shared with other
2cd276f3	41	processors on the Power architecture.
36b53105 GG	42	They can be used, for example, if a program waiting on a lock intends
36b53105 GG	43	to divert the shared resources to be used by other processors.
11ac5b51	44	.PP
36b53105 GG	45	.BR __ppc_yield ()
	46	provides a hint that performance will probably be improved if shared
	47	resources dedicated to the executing processor are released for use by
	48	other processors.
11ac5b51	49	.PP
36b53105 GG	50	.BR __ppc_mdoio ()
	51	provides a hint that performance will probably be improved if shared
	52	resources dedicated to the executing processor are released until all
	53	outstanding storage accesses to caching-inhibited storage have been
	54	completed.
11ac5b51	55	.PP
36b53105 GG	56	.BR __ppc_mdoom ()
	57	provides a hint that performance will probably be improved if shared
	58	resources dedicated to the executing processor are released until all
	59	outstanding storage accesses to cacheable storage for which the data
	60	is not in the cache have been completed.
	61	.SH VERSIONS
2cd276f3	62	These functions first appeared in glibc in version 2.18.
36b53105 GG	63	.SH ATTRIBUTES
	64	For an explanation of the terms used in this section, see
	65	.BR attributes (7).
	66	.ad l
	67	.TS
	68	allbox;
2cd276f3	69	lbw29 lb lb
36b53105 GG	70	l l l.
	71	Interface Attribute Value
	72	T{
	73	.BR __ppc_yield (),
	74	.BR __ppc_mdoio (),
	75	.BR __ppc_mdoom ()
	76	T} Thread safety MT-Safe
	77	.TE
	78	.ad
	79	.SH CONFORMING TO
	80	These functions are nonstandard GNU extensions.
	81	.SH SEE ALSO
	82	.BR __ppc_set_ppr_med (3)
847e0d88	83	.PP
2cd276f3	84	.IR "Power ISA, Book\ II - Section\ 3.2 (""or"" architecture)"