1 What: /sys/bus/event_source/devices/ 1 What: /sys/bus/event_source/devices/hv_gpci/format
2 Date: September 2020 2 Date: September 2020
3 Contact: Linux on PowerPC Developer Lis< 3 Contact: Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
4 Description: Read-only. Attribute group to 4 Description: Read-only. Attribute group to describe the magic bits
5 that go into perf_event_attr.c 5 that go into perf_event_attr.config for a particular pmu.
6 (See ABI/testing/sysfs-bus-eve 6 (See ABI/testing/sysfs-bus-event_source-devices-format).
7 7
8 Each attribute under this grou 8 Each attribute under this group defines a bit range of the
9 perf_event_attr.config. All su 9 perf_event_attr.config. All supported attributes are listed
10 below:: 10 below::
11 11
12 counter_info_v 12 counter_info_version = "config:16-23"
13 length = "con 13 length = "config:24-31"
14 partition_id 14 partition_id = "config:32-63"
15 request = "con 15 request = "config:0-31"
16 sibling_part_i 16 sibling_part_id = "config:32-63"
17 hw_chip_id = " 17 hw_chip_id = "config:32-63"
18 offset = "conf 18 offset = "config:32-63"
19 phys_processor 19 phys_processor_idx = "config:32-63"
20 secondary_inde 20 secondary_index = "config:0-15"
21 starting_index 21 starting_index = "config:32-63"
22 22
23 For example:: 23 For example::
24 24
25 processor_core_utilization_i 25 processor_core_utilization_instructions_completed = "request=0x94,
26 phys_p 26 phys_processor_idx=?,counter_info_version=0x8,
27 length 27 length=8,offset=0x18"
28 28
29 In this event, '?' after phys_ 29 In this event, '?' after phys_processor_idx specifies this value
30 this value will be provided by 30 this value will be provided by user while running this event.
31 31
32 What: /sys/bus/event_source/devices/ 32 What: /sys/bus/event_source/devices/hv_gpci/interface/collect_privileged
33 Date: February 2014 33 Date: February 2014
34 Contact: Linux on PowerPC Developer Lis< 34 Contact: Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
35 Description: 35 Description:
36 '0' if the hypervisor is confi 36 '0' if the hypervisor is configured to forbid access to event
37 counters being accumulated by 37 counters being accumulated by other guests and to physical
38 domain event counters. 38 domain event counters.
39 39
40 '1' if that access is allowed. 40 '1' if that access is allowed.
41 41
42 What: /sys/bus/event_source/devices/ 42 What: /sys/bus/event_source/devices/hv_gpci/interface/ga
43 Date: February 2014 43 Date: February 2014
44 Contact: Linux on PowerPC Developer Lis< 44 Contact: Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
45 Description: 45 Description:
46 0 or 1. Indicates whether we h 46 0 or 1. Indicates whether we have access to "GA" events (listed
47 in arch/powerpc/perf/hv-gpci.h 47 in arch/powerpc/perf/hv-gpci.h).
48 48
49 What: /sys/bus/event_source/devices/ 49 What: /sys/bus/event_source/devices/hv_gpci/interface/expanded
50 Date: February 2014 50 Date: February 2014
51 Contact: Linux on PowerPC Developer Lis< 51 Contact: Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
52 Description: 52 Description:
53 0 or 1. Indicates whether we h 53 0 or 1. Indicates whether we have access to "EXPANDED" events (listed
54 in arch/powerpc/perf/hv-gpci.h 54 in arch/powerpc/perf/hv-gpci.h).
55 55
56 What: /sys/bus/event_source/devices/ 56 What: /sys/bus/event_source/devices/hv_gpci/interface/lab
57 Date: February 2014 57 Date: February 2014
58 Contact: Linux on PowerPC Developer Lis< 58 Contact: Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
59 Description: 59 Description:
60 0 or 1. Indicates whether we h 60 0 or 1. Indicates whether we have access to "LAB" events (listed
61 in arch/powerpc/perf/hv-gpci.h 61 in arch/powerpc/perf/hv-gpci.h).
62 62
63 What: /sys/bus/event_source/devices/ 63 What: /sys/bus/event_source/devices/hv_gpci/interface/version
64 Date: February 2014 64 Date: February 2014
65 Contact: Linux on PowerPC Developer Lis< 65 Contact: Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
66 Description: 66 Description:
67 A number indicating the versio 67 A number indicating the version of the gpci interface that the
68 hypervisor reports supporting. 68 hypervisor reports supporting.
69 69
70 What: /sys/bus/event_source/devices/ 70 What: /sys/bus/event_source/devices/hv_gpci/interface/kernel_version
71 Date: February 2014 71 Date: February 2014
72 Contact: Linux on PowerPC Developer Lis< 72 Contact: Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
73 Description: 73 Description:
74 A number indicating the latest 74 A number indicating the latest version of the gpci interface
75 that the kernel is aware of. 75 that the kernel is aware of.
76 76
77 What: /sys/devices/hv_gpci/cpumask 77 What: /sys/devices/hv_gpci/cpumask
78 Date: October 2020 78 Date: October 2020
79 Contact: Linux on PowerPC Developer Lis< 79 Contact: Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
80 Description: read only 80 Description: read only
81 This sysfs file exposes the cp 81 This sysfs file exposes the cpumask which is designated to make
82 HCALLs to retrieve hv-gpci pmu 82 HCALLs to retrieve hv-gpci pmu event counter data.
83 83
84 What: /sys/devices/hv_gpci/interface 84 What: /sys/devices/hv_gpci/interface/processor_bus_topology
85 Date: July 2023 85 Date: July 2023
86 Contact: Linux on PowerPC Developer Lis< 86 Contact: Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
87 Description: admin read only 87 Description: admin read only
88 This sysfs file exposes the sy 88 This sysfs file exposes the system topology information by making HCALL
89 H_GET_PERF_COUNTER_INFO. The H 89 H_GET_PERF_COUNTER_INFO. The HCALL is made with counter request value
90 PROCESSOR_BUS_TOPOLOGY(0xD0). 90 PROCESSOR_BUS_TOPOLOGY(0xD0).
91 91
92 * This sysfs file will be crea 92 * This sysfs file will be created only for power10 and above platforms.
93 93
94 * User needs root privileges t 94 * User needs root privileges to read data from this sysfs file.
95 95
96 * This sysfs file will be crea 96 * This sysfs file will be created, only when the HCALL returns "H_SUCCESS",
97 "H_AUTHORITY" or "H_PARAMETE 97 "H_AUTHORITY" or "H_PARAMETER" as the return type.
98 98
99 HCALL with return error type 99 HCALL with return error type "H_AUTHORITY" can be resolved during
100 runtime by setting "Enable P 100 runtime by setting "Enable Performance Information Collection" option.
101 101
102 * The end user reading this sy 102 * The end user reading this sysfs file must decode the content as per
103 underlying platform/firmware 103 underlying platform/firmware.
104 104
105 Possible error codes while rea 105 Possible error codes while reading this sysfs file:
106 106
107 * "-EPERM" : Partition is not 107 * "-EPERM" : Partition is not permitted to retrieve performance information,
108 required to set "E 108 required to set "Enable Performance Information Collection" option.
109 109
110 * "-EIO" : Can't retrieve syst 110 * "-EIO" : Can't retrieve system information because of invalid buffer length/invalid address
111 or because of some 111 or because of some hardware error. Refer to getPerfCountInfo documentation for
112 more information. 112 more information.
113 113
114 * "-EFBIG" : System informatio 114 * "-EFBIG" : System information exceeds PAGE_SIZE.
115 115
116 What: /sys/devices/hv_gpci/interface 116 What: /sys/devices/hv_gpci/interface/processor_config
117 Date: July 2023 117 Date: July 2023
118 Contact: Linux on PowerPC Developer Lis< 118 Contact: Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
119 Description: admin read only 119 Description: admin read only
120 This sysfs file exposes the sy 120 This sysfs file exposes the system topology information by making HCALL
121 H_GET_PERF_COUNTER_INFO. The H 121 H_GET_PERF_COUNTER_INFO. The HCALL is made with counter request value
122 PROCESSOR_CONFIG(0x90). 122 PROCESSOR_CONFIG(0x90).
123 123
124 * This sysfs file will be crea 124 * This sysfs file will be created only for power10 and above platforms.
125 125
126 * User needs root privileges t 126 * User needs root privileges to read data from this sysfs file.
127 127
128 * This sysfs file will be crea 128 * This sysfs file will be created, only when the HCALL returns "H_SUCCESS",
129 "H_AUTHORITY" or "H_PARAMETE 129 "H_AUTHORITY" or "H_PARAMETER" as the return type.
130 130
131 HCALL with return error type 131 HCALL with return error type "H_AUTHORITY" can be resolved during
132 runtime by setting "Enable P 132 runtime by setting "Enable Performance Information Collection" option.
133 133
134 * The end user reading this sy 134 * The end user reading this sysfs file must decode the content as per
135 underlying platform/firmware 135 underlying platform/firmware.
136 136
137 Possible error codes while rea 137 Possible error codes while reading this sysfs file:
138 138
139 * "-EPERM" : Partition is not 139 * "-EPERM" : Partition is not permitted to retrieve performance information,
140 required to set "E 140 required to set "Enable Performance Information Collection" option.
141 141
142 * "-EIO" : Can't retrieve syst 142 * "-EIO" : Can't retrieve system information because of invalid buffer length/invalid address
143 or because of some 143 or because of some hardware error. Refer to getPerfCountInfo documentation for
144 more information. 144 more information.
145 145
146 * "-EFBIG" : System informatio 146 * "-EFBIG" : System information exceeds PAGE_SIZE.
147 147
148 What: /sys/devices/hv_gpci/interface 148 What: /sys/devices/hv_gpci/interface/affinity_domain_via_virtual_processor
149 Date: July 2023 149 Date: July 2023
150 Contact: Linux on PowerPC Developer Lis< 150 Contact: Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
151 Description: admin read only 151 Description: admin read only
152 This sysfs file exposes the sy 152 This sysfs file exposes the system topology information by making HCALL
153 H_GET_PERF_COUNTER_INFO. The H 153 H_GET_PERF_COUNTER_INFO. The HCALL is made with counter request value
154 AFFINITY_DOMAIN_INFORMATION_BY 154 AFFINITY_DOMAIN_INFORMATION_BY_VIRTUAL_PROCESSOR(0xA0).
155 155
156 * This sysfs file will be crea 156 * This sysfs file will be created only for power10 and above platforms.
157 157
158 * User needs root privileges t 158 * User needs root privileges to read data from this sysfs file.
159 159
160 * This sysfs file will be crea 160 * This sysfs file will be created, only when the HCALL returns "H_SUCCESS",
161 "H_AUTHORITY" or "H_PARAMETE 161 "H_AUTHORITY" or "H_PARAMETER" as the return type.
162 162
163 HCALL with return error type 163 HCALL with return error type "H_AUTHORITY" can be resolved during
164 runtime by setting "Enable P 164 runtime by setting "Enable Performance Information Collection" option.
165 165
166 * The end user reading this sy 166 * The end user reading this sysfs file must decode the content as per
167 underlying platform/firmware 167 underlying platform/firmware.
168 168
169 Possible error codes while rea 169 Possible error codes while reading this sysfs file:
170 170
171 * "-EPERM" : Partition is not 171 * "-EPERM" : Partition is not permitted to retrieve performance information,
172 required to set "E 172 required to set "Enable Performance Information Collection" option.
173 173
174 * "-EIO" : Can't retrieve syst 174 * "-EIO" : Can't retrieve system information because of invalid buffer length/invalid address
175 or because of some 175 or because of some hardware error. Refer to getPerfCountInfo documentation for
176 more information. 176 more information.
177 177
178 * "-EFBIG" : System informatio 178 * "-EFBIG" : System information exceeds PAGE_SIZE.
179 179
180 What: /sys/devices/hv_gpci/interface 180 What: /sys/devices/hv_gpci/interface/affinity_domain_via_domain
181 Date: July 2023 181 Date: July 2023
182 Contact: Linux on PowerPC Developer Lis< 182 Contact: Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
183 Description: admin read only 183 Description: admin read only
184 This sysfs file exposes the sy 184 This sysfs file exposes the system topology information by making HCALL
185 H_GET_PERF_COUNTER_INFO. The H 185 H_GET_PERF_COUNTER_INFO. The HCALL is made with counter request value
186 AFFINITY_DOMAIN_INFORMATION_BY 186 AFFINITY_DOMAIN_INFORMATION_BY_DOMAIN(0xB0).
187 187
188 * This sysfs file will be crea 188 * This sysfs file will be created only for power10 and above platforms.
189 189
190 * User needs root privileges t 190 * User needs root privileges to read data from this sysfs file.
191 191
192 * This sysfs file will be crea 192 * This sysfs file will be created, only when the HCALL returns "H_SUCCESS",
193 "H_AUTHORITY" or "H_PARAMETE 193 "H_AUTHORITY" or "H_PARAMETER" as the return type.
194 194
195 HCALL with return error type 195 HCALL with return error type "H_AUTHORITY" can be resolved during
196 runtime by setting "Enable P 196 runtime by setting "Enable Performance Information Collection" option.
197 197
198 * The end user reading this sy 198 * The end user reading this sysfs file must decode the content as per
199 underlying platform/firmware 199 underlying platform/firmware.
200 200
201 Possible error codes while rea 201 Possible error codes while reading this sysfs file:
202 202
203 * "-EPERM" : Partition is not 203 * "-EPERM" : Partition is not permitted to retrieve performance information,
204 required to set "E 204 required to set "Enable Performance Information Collection" option.
205 205
206 * "-EIO" : Can't retrieve syst 206 * "-EIO" : Can't retrieve system information because of invalid buffer length/invalid address
207 or because of some 207 or because of some hardware error. Refer to getPerfCountInfo documentation for
208 more information. 208 more information.
209 209
210 * "-EFBIG" : System informatio 210 * "-EFBIG" : System information exceeds PAGE_SIZE.
211 211
212 What: /sys/devices/hv_gpci/interface 212 What: /sys/devices/hv_gpci/interface/affinity_domain_via_partition
213 Date: July 2023 213 Date: July 2023
214 Contact: Linux on PowerPC Developer Lis< 214 Contact: Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
215 Description: admin read only 215 Description: admin read only
216 This sysfs file exposes the sy 216 This sysfs file exposes the system topology information by making HCALL
217 H_GET_PERF_COUNTER_INFO. The H 217 H_GET_PERF_COUNTER_INFO. The HCALL is made with counter request value
218 AFFINITY_DOMAIN_INFORMATION_BY 218 AFFINITY_DOMAIN_INFORMATION_BY_PARTITION(0xB1).
219 219
220 * This sysfs file will be crea 220 * This sysfs file will be created only for power10 and above platforms.
221 221
222 * User needs root privileges t 222 * User needs root privileges to read data from this sysfs file.
223 223
224 * This sysfs file will be crea 224 * This sysfs file will be created, only when the HCALL returns "H_SUCCESS",
225 "H_AUTHORITY" or "H_PARAMETE 225 "H_AUTHORITY" or "H_PARAMETER" as the return type.
226 226
227 HCALL with return error type 227 HCALL with return error type "H_AUTHORITY" can be resolved during
228 runtime by setting "Enable P 228 runtime by setting "Enable Performance Information Collection" option.
229 229
230 * The end user reading this sy 230 * The end user reading this sysfs file must decode the content as per
231 underlying platform/firmware 231 underlying platform/firmware.
232 232
233 Possible error codes while rea 233 Possible error codes while reading this sysfs file:
234 234
235 * "-EPERM" : Partition is not 235 * "-EPERM" : Partition is not permitted to retrieve performance information,
236 required to set "E 236 required to set "Enable Performance Information Collection" option.
237 237
238 * "-EIO" : Can't retrieve syst 238 * "-EIO" : Can't retrieve system information because of invalid buffer length/invalid address
239 or because of some 239 or because of some hardware error. Refer to getPerfCountInfo documentation for
240 more information. 240 more information.
241 241
242 * "-EFBIG" : System informatio 242 * "-EFBIG" : System information exceeds PAGE_SIZE.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.