Debian Codegraph @

ppr/doc/libpaf-ppr.3

raw
1 .\" Copyright IBM Corp. 2015
2 .\"
3 .\" The MIT License (MIT)
4 .\"
5 .\" Permission is hereby granted, free of charge, to any person obtaining a copy
6 .\" of this software and associated documentation files (the "Software"), to
7 .\" deal in the Software without restriction, including without limitation the
8 .\" rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
9 .\" sell copies of the Software, and to permit persons to whom the Software is
10 .\" furnished to do so, subject to the following conditions:
11 .\"
12 .\" The above copyright notice and this permission notice shall be included in
13 .\" all copies or substantial portions of the Software.
14 .\"
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 .\" AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 .\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21 .\" IN THE SOFTWARE.
22 .\"
23 .\" Contributors:
24 .\" IBM Corporation, Adhemerval Zanella - Initial implementation.
25 .\" IBM Corporation, Rajalakshmi S - Initial implementation.
26 .TH LIBPAF 2015-08-06 "Linux" "Program Priority Register"
27 .SH NAME
28 The Power Architecture Facilities - Program Priority Register
29 .SH SYNOPSIS
30 .sp
31 .B #include <paf/ppr.h>
32 .sp
33 .B void paf_yield(void);
34 .sp
35 .B void paf_mdoio(void);
36 .sp
37 .B void paf_mdoom(void);
38 .sp
39 .B void paf_ppr_very_low(void);
40 .sp
41 .B void paf_ppr_low(void);
42 .sp
43 .B void paf_ppr_med_low(void);
44 .sp
45 .B void paf_ppr_med(void);
46 .sp
47 .B void paf_ppr_med_high(void);
48 .sp
49
50 .SH DESCRIPTION
51
52 The Program Priority Register header
53 .I ppr.h
54 provides a mechanism to adjust the
55 thread priorities based on lock acquisition, wait and release
56 available on Power Architecture.
57
58 .PP
59 The function
60 .BR paf_yield ()
61 provides a hint that performance will probably be improved if shared resources
62 dedicated to the executing processor are released for use by other processors.
63
64 .PP
65 The function
66 .BR paf_mdoio ()
67 provides a hint that performance will probably be improved if shared resources
68 dedicated to the executing processor are released until all outstanding storage
69 accesses to caching-inhibited storage have been completed.
70
71 .PP
72 The function
73 .BR paf_mdoom ()
74 provides a hint that performance will probably be improved if shared resources
75 dedicated to the executing processor are released until all outstanding storage
76 accesses to cacheable storage for which the data is not in the cache have been completed.
77
78 .PP
79 The function
80 .BR paf_ppr_very_low ()
81 sets the Program Priority Register to very low value.
82 This is available from Power ISA 2.07.
83
84 .PP
85 The function
86 .BR paf_ppr_low ()
87 sets the Program Priority Register to low value.
88
89 .PP
90 The function
91 .BR paf_ppr_med_low ()
92 sets the Program Priority Register to medium low value.
93
94 .PP
95 The function
96 .BR paf_ppr_med ()
97 sets the Program Priority Register to medium value (default).
98
99 .PP
100 The function
101 .BR paf_ppr_med_high ()
102 sets the Program Priority Register to medium high value.
103 This is available from Power ISA 2.07.
104
105 .SH REFERENCES
106 .TP
107 .B Power ISA\(tm Version 2.05
108 .TP
109 .B Power ISA\(tm Version 2.06
110 .TP
111 .B Power ISA\(tm Version 2.06+
112 .TP
113 .B Power ISA\(tm Version 2.07
114
115 .SH REPORTING BUGS
116 .PP
117 Email bug reports to Rajalakshmi S <[email protected]>.
118 .SH AUTHORS
119 This manual page was written by Rajalakshmi S <[email protected]>
120 and Adhemerval Zanella <[email protected]>.
121
122