-
Notifications
You must be signed in to change notification settings - Fork 0
/
perfidious.stub.php
229 lines (206 loc) · 5.6 KB
/
perfidious.stub.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
<?php
/**
* Copyright (c) anno Domini nostri Jesu Christi MMXXIV John Boehr & contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
namespace Perfidious;
const VERSION = "0.1.0";
const OVERFLOW_THROW = 0;
const OVERFLOW_WARN = 1;
const OVERFLOW_SATURATE = 2;
const OVERFLOW_WRAP = 3;
/**
* @throws PmuNotFoundException
* @see https://perfmon2.sourceforge.net/manv4/pfm_get_pmu_info.html
*/
function get_pmu_info(int $pmu): PmuInfo
{
}
/**
* @phpstan-return ?Handle<list<string>>
*/
function global_handle(): ?Handle
{
}
/**
* @return list<PmuInfo>
* @see https://perfmon2.sourceforge.net/manv4/pfm_get_pmu_info.html
*/
function list_pmus(): array
{
}
/**
* @return list<PmuEventInfo>
* @throws PmuNotFoundException|PmuEventNotFoundException
* @see https://perfmon2.sourceforge.net/manv4/pfm_get_event_info.html
*/
function list_pmu_events(int $pmu): array
{
}
/**
* @param list<string> $event_names a list of libpfm event names, see list_pmu_events
* @throws PmuEventNotFoundException|IOException|OverflowException
*
* @phpstan-template T of string
* @phpstan-param list<T> $event_names
* @phpstan-return Handle<list<T>>
*/
function open(array $event_names, int $pid = 0, int $cpu = -1): Handle
{
}
/**
* @phpstan-return ?Handle<list<string>>
*/
function request_handle(): ?Handle
{
}
interface Exception
{
}
final class IOException extends \RuntimeException implements Exception
{
}
final class OverflowException extends \OverflowException implements Exception
{
}
final class PmuNotFoundException extends \InvalidArgumentException implements Exception
{
}
final class PmuEventNotFoundException extends \InvalidArgumentException implements Exception
{
}
/**
* @phpstan-template T of list<string>
*/
final class Handle
{
/**
* @return $this
* @throws IOException
*/
final public function enable(): self
{
}
/**
* @return $this
* @throws IOException
*/
final public function disable(): self
{
}
/**
* Get a raw byte stream from the handle's file descriptor
*
* @note closing this resource will cause subsequent calls to read to fail
* @return resource
*/
final public function rawStream()
{
}
/**
* @note If perfidious.overflow_mode is set to Perfidious\OVERFLOW_WARN, this method can return null, despite its
* typehint. If perfidious.overflow_mode is set to any value other than Perfidious\OVERFLOW_THROW, this
* method will *not* throw an OverflowException.
*
* @return ReadResult
* @throws OverflowException|IOException
*
* @phpstan-return ReadResult<T>
*/
final public function read(): ReadResult
{
}
/**
* @note If perfidious.overflow_mode is set to Perfidious\OVERFLOW_WARN, this method can return null, despite its
* typehint. If perfidious.overflow_mode is set to any value other than Perfidious\OVERFLOW_THROW, this
* method will *not* throw an OverflowException.
*
* @return array
* @throws OverflowException|IOException
*
* @phpstan-return array<value-of<T>, int>
*/
final public function readArray(): array
{
}
/**
* @return $this
* @throws IOException
*/
final public function reset(): self
{
}
}
/**
* @phpstan-template T of list<string>
*/
final class ReadResult
{
public readonly int $timeEnabled;
public readonly int $timeRunning;
/**
* @var array<string, int>
* @phpstan-var array<value-of<T>, int>
*/
public readonly array $values;
}
/**
* @see https://perfmon2.sourceforge.net/manv4/pfm_get_pmu_info.html
*/
final class PmuInfo
{
/**
* This is the symbolic name of the PMU. This name can be used as a prefix in an event string.
*/
public string $name;
public string $desc;
/**
* This is the unique PMU identification code. It is identical to the value passed in pmu and it provided only for
* completeness.
*/
public int $pmu;
public int $type;
/**
* This is the number of available events for this PMU model based on the host processor. It is only valid is the
* is_present field is set to true.
*/
public int $nevents;
/**
* This field is set to true if the PMU model has been detected on the host system.
*/
public bool $is_present;
}
/**
* @see https://perfmon2.sourceforge.net/manv4/pfm_get_event_info.html
*/
final class PmuEventInfo
{
public string $name;
public string $desc;
/**
* Certain events may be just variations of actual events. They may be provided as handy shortcuts to avoid
* supplying a long list of attributes. For those events, this field is not NULL and contains the complete
* equivalent event string.
*/
public ?string $equiv;
/**
* This is the ID of the PMU model this event belongs to.
*/
public int $pmu;
/**
* This field is set to true if the PMU model has been detected on the host system.
*/
public bool $is_present;
}