Blame man3/__ppc_set_ppr_med.3

Packit 7cfc04
.\" Copyright (c) 2015, 2016 IBM Corporation.
Packit 7cfc04
.\"
Packit 7cfc04
.\" %%%LICENSE_START(VERBATIM)
Packit 7cfc04
.\" Permission is granted to make and distribute verbatim copies of this
Packit 7cfc04
.\" manual provided the copyright notice and this permission notice are
Packit 7cfc04
.\" preserved on all copies.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Permission is granted to copy and distribute modified versions of
Packit 7cfc04
.\" this manual under the conditions for verbatim copying, provided that
Packit 7cfc04
.\" the entire resulting derived work is distributed under the terms of
Packit 7cfc04
.\" a permission notice identical to this one.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Since the Linux kernel and libraries are constantly changing, this
Packit 7cfc04
.\" manual page may be incorrect or out-of-date.  The author(s) assume.
Packit 7cfc04
.\" no responsibility for errors or omissions, or for damages resulting.
Packit 7cfc04
.\" from the use of the information contained herein.  The author(s) may.
Packit 7cfc04
.\" not have taken the same level of care in the production of this.
Packit 7cfc04
.\" manual, which is licensed free of charge, as they might when working.
Packit 7cfc04
.\" professionally.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Formatted or processed versions of this manual, if unaccompanied by
Packit 7cfc04
.\" the source, must acknowledge the copyright and authors of this work.
Packit 7cfc04
.\" %%%LICENSE_END
Packit 7cfc04
.\"
Packit 7cfc04
.TH __PPC_SET_PPR_MED 3 2017-09-15 "GNU C Library" "Linux\
Packit 7cfc04
Programmer's Manual"
Packit 7cfc04
.SH NAME
Packit 7cfc04
__ppc_set_ppr_med, __ppc_set_ppr_very_low, __ppc_set_ppr_low, __ppc_set_ppr_med_low, __ppc_set_ppr_med_high \-
Packit 7cfc04
Set the Program Priority Register
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.B #include <sys/platform/ppc.h>
Packit 7cfc04
.PP
Packit 7cfc04
.B void __ppc_set_ppr_med(void);
Packit 7cfc04
.br
Packit 7cfc04
.B void __ppc_set_ppr_very_low(void);
Packit 7cfc04
.br
Packit 7cfc04
.B void __ppc_set_ppr_low(void);
Packit 7cfc04
.br
Packit 7cfc04
.B void __ppc_set_ppr_med_low(void);
Packit 7cfc04
.br
Packit 7cfc04
.B void __ppc_set_ppr_med_high(void);
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
These functions provide access to the
Packit 7cfc04
.I Program Priority Register
Packit 7cfc04
(PPR) on the Power architecture.
Packit 7cfc04
.PP
Packit 7cfc04
The PPR is a 64-bit register that controls the program's priority.
Packit 7cfc04
By adjusting the PPR value the programmer may improve system
Packit 7cfc04
throughput by causing system resources to be used more
Packit 7cfc04
efficiently, especially in contention situations.
Packit 7cfc04
The available unprivileged states are covered by the following functions:
Packit 7cfc04
.IP * 3
Packit 7cfc04
.BR __ppc_set_ppr_med ()
Packit 7cfc04
sets the Program Priority Register value to
Packit 7cfc04
.IR medium
Packit 7cfc04
(default).
Packit 7cfc04
.IP *
Packit 7cfc04
.BR __ppc_set_ppr_very_low ()
Packit 7cfc04
sets the Program Priority Register value to
Packit 7cfc04
.IR "very low" .
Packit 7cfc04
.IP *
Packit 7cfc04
.BR __ppc_set_ppr_low ()
Packit 7cfc04
sets the Program Priority Register value to
Packit 7cfc04
.IR low .
Packit 7cfc04
.IP *
Packit 7cfc04
.BR __ppc_set_ppr_med_low ()
Packit 7cfc04
sets the Program Priority Register value to
Packit 7cfc04
.IR "medium low" .
Packit 7cfc04
.PP
Packit 7cfc04
The privileged state
Packit 7cfc04
.IR "medium high"
Packit 7cfc04
may also be set during certain time intervals by problem-state (unprivileged)
Packit 7cfc04
programs, with the following function:
Packit 7cfc04
.IP * 3
Packit 7cfc04
.BR __ppc_set_ppr_med_high ()
Packit 7cfc04
sets the Program Priority to
Packit 7cfc04
.IR "medium high" .
Packit 7cfc04
.PP
Packit 7cfc04
If the program priority is medium high when the time interval expires or if an
Packit 7cfc04
attempt is made to set the priority to medium high when it is not allowed, the
Packit 7cfc04
priority is set to medium.
Packit 7cfc04
.SH VERSIONS
Packit 7cfc04
The functions
Packit 7cfc04
.BR __ppc_set_ppr_med (),
Packit 7cfc04
.BR __ppc_set_ppr_low ()
Packit 7cfc04
and
Packit 7cfc04
.BR __ppc_set_ppr_med_low ()
Packit 7cfc04
are provided by glibc since version 2.18.
Packit 7cfc04
The functions
Packit 7cfc04
.BR __ppc_set_ppr_very_low ()
Packit 7cfc04
and
Packit 7cfc04
.BR __ppc_set_ppr_med_high ()
Packit 7cfc04
first appeared in glibc in version 2.23.
Packit 7cfc04
.SH ATTRIBUTES
Packit 7cfc04
For an explanation of the terms used in this section, see
Packit 7cfc04
.BR attributes (7).
Packit 7cfc04
.ad l
Packit 7cfc04
.TS
Packit 7cfc04
allbox;
Packit 7cfc04
lbw26 lb lb
Packit 7cfc04
l l l.
Packit 7cfc04
Interface	Attribute	Value
Packit 7cfc04
T{
Packit 7cfc04
.BR __ppc_set_ppr_med (),
Packit 7cfc04
.br
Packit 7cfc04
.BR __ppc_set_ppr_very_low (),
Packit 7cfc04
.br
Packit 7cfc04
.BR __ppc_set_ppr_low (),
Packit 7cfc04
.br
Packit 7cfc04
.BR __ppc_set_ppr_med_low (),
Packit 7cfc04
.br
Packit 7cfc04
.BR __ppc_set_ppr_med_high ()
Packit 7cfc04
T}	Thread safety	MT-Safe
Packit 7cfc04
.TE
Packit 7cfc04
.ad
Packit 7cfc04
.SH CONFORMING TO
Packit 7cfc04
These functions are nonstandard GNU extensions.
Packit 7cfc04
.SH NOTES
Packit 7cfc04
The functions
Packit 7cfc04
.BR __ppc_set_ppr_very_low ()
Packit 7cfc04
and
Packit 7cfc04
.BR __ppc_set_ppr_med_high ()
Packit 7cfc04
will be defined by
Packit 7cfc04
.I <sys/platform/ppc.h>
Packit 7cfc04
if
Packit 7cfc04
.B _ARCH_PWR8
Packit 7cfc04
is defined.
Packit 7cfc04
Availability of these functions can be tested using
Packit 7cfc04
.BR "#ifdef _ARCH_PWR8" .
Packit 7cfc04
.SH SEE ALSO
Packit 7cfc04
.BR __ppc_yield (3)
Packit 7cfc04
.PP
Packit 7cfc04
.IR "Power ISA, Book\ II - Section\ 3.1 (Program Priority Registers)"
Packit 7cfc04
.SH COLOPHON
Packit 7cfc04
This page is part of release 4.15 of the Linux
Packit 7cfc04
.I man-pages
Packit 7cfc04
project.
Packit 7cfc04
A description of the project,
Packit 7cfc04
information about reporting bugs,
Packit 7cfc04
and the latest version of this page,
Packit 7cfc04
can be found at
Packit 7cfc04
\%https://www.kernel.org/doc/man\-pages/.