-
Notifications
You must be signed in to change notification settings - Fork 5.5k
/
intel_pmu.go
437 lines (375 loc) · 11.3 KB
/
intel_pmu.go
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
//go:generate ../../../tools/readme_config_includer/generator
//go:build linux && amd64
package intel_pmu
import (
_ "embed"
"errors"
"fmt"
"math"
"math/big"
"os"
"strconv"
"strings"
"syscall"
ia "github.com/intel/iaevents"
"github.com/influxdata/telegraf"
"github.com/influxdata/telegraf/plugins/inputs"
)
//go:embed sample.conf
var sampleConfig string
// Linux availability: https://www.kernel.org/doc/Documentation/sysctl/fs.txt
const fileMaxPath = "/proc/sys/fs/file-max"
type fileInfoProvider interface {
readFile(string) ([]byte, error)
lstat(string) (os.FileInfo, error)
fileLimit() (uint64, error)
}
type fileHelper struct{}
func (fileHelper) readFile(path string) ([]byte, error) {
return os.ReadFile(path)
}
func (fileHelper) lstat(path string) (os.FileInfo, error) {
return os.Lstat(path)
}
func (fileHelper) fileLimit() (uint64, error) {
var rLimit syscall.Rlimit
err := syscall.Getrlimit(syscall.RLIMIT_NOFILE, &rLimit)
return rLimit.Cur, err
}
type sysInfoProvider interface {
allCPUs() ([]int, error)
allSockets() ([]int, error)
}
type iaSysInfo struct{}
func (iaSysInfo) allCPUs() ([]int, error) {
return ia.AllCPUs()
}
func (iaSysInfo) allSockets() ([]int, error) {
return ia.AllSockets()
}
// IntelPMU is the plugin type.
type IntelPMU struct {
EventListPaths []string `toml:"event_definitions"`
CoreEntities []*CoreEventEntity `toml:"core_events"`
UncoreEntities []*UncoreEventEntity `toml:"uncore_events"`
Log telegraf.Logger `toml:"-"`
fileInfo fileInfoProvider
entitiesReader entitiesValuesReader
}
// CoreEventEntity represents config section for core events.
type CoreEventEntity struct {
Events []string `toml:"events"`
Cores []string `toml:"cores"`
EventsTag string `toml:"events_tag"`
PerfGroup bool `toml:"perf_group"`
parsedEvents []*eventWithQuals
parsedCores []int
allEvents bool
activeEvents []*ia.ActiveEvent
}
// UncoreEventEntity represents config section for uncore events.
type UncoreEventEntity struct {
Events []string `toml:"events"`
Sockets []string `toml:"sockets"`
Aggregate bool `toml:"aggregate_uncore_units"`
EventsTag string `toml:"events_tag"`
parsedEvents []*eventWithQuals
parsedSockets []int
allEvents bool
activeMultiEvents []multiEvent
}
type multiEvent struct {
activeEvents []*ia.ActiveEvent
perfEvent *ia.PerfEvent
socket int
}
type eventWithQuals struct {
name string
qualifiers []string
custom ia.CustomizableEvent
}
// Start is required for IntelPMU to implement the telegraf.ServiceInput interface.
// Necessary initialization and config checking are done in Init.
func (IntelPMU) Start(_ telegraf.Accumulator) error {
return nil
}
func (*IntelPMU) SampleConfig() string {
return sampleConfig
}
func (i *IntelPMU) Init() error {
err := checkFiles(i.EventListPaths, i.fileInfo)
if err != nil {
return fmt.Errorf("error during event definitions paths validation: %w", err)
}
reader, err := newReader(i.Log, i.EventListPaths)
if err != nil {
return err
}
transformer := ia.NewPerfTransformer()
resolver := &iaEntitiesResolver{reader: reader, transformer: transformer, log: i.Log}
parser := &configParser{log: i.Log, sys: &iaSysInfo{}}
activator := &iaEntitiesActivator{perfActivator: &iaEventsActivator{}, placementMaker: &iaPlacementMaker{}}
i.entitiesReader = &iaEntitiesValuesReader{eventReader: &iaValuesReader{}, timer: &realClock{}}
return i.initialization(parser, resolver, activator)
}
func (i *IntelPMU) initialization(parser entitiesParser, resolver entitiesResolver, activator entitiesActivator) error {
if parser == nil || resolver == nil || activator == nil {
return fmt.Errorf("entities parser and/or resolver and/or activator is nil")
}
err := parser.parseEntities(i.CoreEntities, i.UncoreEntities)
if err != nil {
return fmt.Errorf("error during parsing configuration sections: %w", err)
}
err = resolver.resolveEntities(i.CoreEntities, i.UncoreEntities)
if err != nil {
return fmt.Errorf("error during events resolving: %w", err)
}
err = i.checkFileDescriptors()
if err != nil {
return fmt.Errorf("error during file descriptors checking: %w", err)
}
err = activator.activateEntities(i.CoreEntities, i.UncoreEntities)
if err != nil {
return fmt.Errorf("error during events activation: %w", err)
}
return nil
}
func (i *IntelPMU) checkFileDescriptors() error {
coreFd, err := estimateCoresFd(i.CoreEntities)
if err != nil {
return fmt.Errorf("failed to estimate number of core events file descriptors: %w", err)
}
uncoreFd, err := estimateUncoreFd(i.UncoreEntities)
if err != nil {
return fmt.Errorf("failed to estimate number of uncore events file descriptors: %w", err)
}
if coreFd > math.MaxUint64-uncoreFd {
return fmt.Errorf("requested number of file descriptors exceeds uint64")
}
allFd := coreFd + uncoreFd
// maximum file descriptors enforced on a kernel level
maxFd, err := readMaxFD(i.fileInfo)
if err != nil {
i.Log.Warnf("Cannot obtain number of available file descriptors: %v", err)
} else if allFd > maxFd {
return fmt.Errorf("required file descriptors number `%d` exceeds maximum number of available file descriptors `%d`"+
": consider increasing the maximum number", allFd, maxFd)
}
// soft limit for current process
limit, err := i.fileInfo.fileLimit()
if err != nil {
i.Log.Warnf("Cannot obtain limit value of open files: %v", err)
} else if allFd > limit {
return fmt.Errorf("required file descriptors number `%d` exceeds soft limit of open files `%d`"+
": consider increasing the limit", allFd, limit)
}
return nil
}
func (i *IntelPMU) Gather(acc telegraf.Accumulator) error {
if i.entitiesReader == nil {
return fmt.Errorf("entities reader is nil")
}
coreMetrics, uncoreMetrics, err := i.entitiesReader.readEntities(i.CoreEntities, i.UncoreEntities)
if err != nil {
return fmt.Errorf("failed to read entities events values: %w", err)
}
for id, m := range coreMetrics {
scaled := ia.EventScaledValue(m.values)
if !scaled.IsUint64() {
return fmt.Errorf("cannot process %q scaled value %q: exceeds uint64", m.name, scaled.String())
}
coreMetrics[id].scaled = scaled.Uint64()
}
for id, m := range uncoreMetrics {
scaled := ia.EventScaledValue(m.values)
if !scaled.IsUint64() {
return fmt.Errorf("cannot process %q scaled value %q: exceeds uint64", m.name, scaled.String())
}
uncoreMetrics[id].scaled = scaled.Uint64()
}
publishCoreMeasurements(coreMetrics, acc)
publishUncoreMeasurements(uncoreMetrics, acc)
return nil
}
func (i *IntelPMU) Stop() {
for _, entity := range i.CoreEntities {
if entity == nil {
continue
}
for _, event := range entity.activeEvents {
if event == nil {
continue
}
err := event.Deactivate()
if err != nil {
i.Log.Warnf("Failed to deactivate core event %q: %v", event, err)
}
}
}
for _, entity := range i.UncoreEntities {
if entity == nil {
continue
}
for _, multi := range entity.activeMultiEvents {
for _, event := range multi.activeEvents {
if event == nil {
continue
}
err := event.Deactivate()
if err != nil {
i.Log.Warnf("Failed to deactivate uncore event %q: %v", event, err)
}
}
}
}
}
func newReader(log telegraf.Logger, files []string) (*ia.JSONFilesReader, error) {
reader := ia.NewFilesReader()
for _, file := range files {
err := reader.AddFiles(file)
if err != nil {
var deprecatedFormatError *ia.DeprecatedFormatError
if errors.As(err, &deprecatedFormatError) {
log.Warnf("%v. See the perfmon repo for updated event files", deprecatedFormatError)
continue
}
return nil, fmt.Errorf("failed to add files to reader: %w", err)
}
}
return reader, nil
}
func estimateCoresFd(entities []*CoreEventEntity) (uint64, error) {
var err error
number := uint64(0)
for _, entity := range entities {
if entity == nil {
continue
}
events := uint64(len(entity.parsedEvents))
cores := uint64(len(entity.parsedCores))
number, err = multiplyAndAdd(events, cores, number)
if err != nil {
return 0, err
}
}
return number, nil
}
func estimateUncoreFd(entities []*UncoreEventEntity) (uint64, error) {
var err error
number := uint64(0)
for _, entity := range entities {
if entity == nil {
continue
}
for _, e := range entity.parsedEvents {
if e.custom.Event == nil {
continue
}
pmus := uint64(len(e.custom.Event.PMUTypes))
sockets := uint64(len(entity.parsedSockets))
number, err = multiplyAndAdd(pmus, sockets, number)
if err != nil {
return 0, err
}
}
}
return number, nil
}
func multiplyAndAdd(factorA uint64, factorB uint64, sum uint64) (uint64, error) {
bigA := new(big.Int).SetUint64(factorA)
bigB := new(big.Int).SetUint64(factorB)
activeEvents := new(big.Int).Mul(bigA, bigB)
if !activeEvents.IsUint64() {
return 0, fmt.Errorf("value %q cannot be represented as uint64", activeEvents.String())
}
if sum > math.MaxUint64-activeEvents.Uint64() {
return 0, fmt.Errorf("value %q exceeds uint64", new(big.Int).Add(activeEvents, new(big.Int).SetUint64(sum)))
}
sum += activeEvents.Uint64()
return sum, nil
}
func readMaxFD(reader fileInfoProvider) (uint64, error) {
if reader == nil {
return 0, fmt.Errorf("file reader is nil")
}
buf, err := reader.readFile(fileMaxPath)
if err != nil {
return 0, fmt.Errorf("cannot open file %q: %w", fileMaxPath, err)
}
max, err := strconv.ParseUint(strings.Trim(string(buf), "\n "), 10, 64)
if err != nil {
return 0, fmt.Errorf("cannot parse file content of %q: %w", fileMaxPath, err)
}
return max, nil
}
func checkFiles(paths []string, fileInfo fileInfoProvider) error {
// No event definition JSON locations present
if len(paths) == 0 {
return fmt.Errorf("no paths were given")
}
if fileInfo == nil {
return fmt.Errorf("file info provider is nil")
}
// Wrong files
for _, path := range paths {
lInfo, err := fileInfo.lstat(path)
if err != nil {
if os.IsNotExist(err) {
return fmt.Errorf("file %q doesn't exist", path)
}
return fmt.Errorf("cannot obtain file info of %q: %w", path, err)
}
mode := lInfo.Mode()
if mode&os.ModeSymlink != 0 {
return fmt.Errorf("file %q is a symlink", path)
}
if !mode.IsRegular() {
return fmt.Errorf("file %q doesn't point to a reagular file", path)
}
}
return nil
}
func publishCoreMeasurements(metrics []coreMetric, acc telegraf.Accumulator) {
for _, m := range metrics {
fields := make(map[string]interface{})
tags := make(map[string]string)
fields["raw"] = m.values.Raw
fields["enabled"] = m.values.Enabled
fields["running"] = m.values.Running
fields["scaled"] = m.scaled
tags["event"] = m.name
tags["cpu"] = strconv.Itoa(m.cpu)
if len(m.tag) > 0 {
tags["events_tag"] = m.tag
}
acc.AddFields("pmu_metric", fields, tags, m.time)
}
}
func publishUncoreMeasurements(metrics []uncoreMetric, acc telegraf.Accumulator) {
for _, m := range metrics {
fields := make(map[string]interface{})
tags := make(map[string]string)
fields["raw"] = m.values.Raw
fields["enabled"] = m.values.Enabled
fields["running"] = m.values.Running
fields["scaled"] = m.scaled
tags["event"] = m.name
tags["socket"] = strconv.Itoa(m.socket)
tags["unit_type"] = m.unitType
if !m.agg {
tags["unit"] = m.unit
}
if len(m.tag) > 0 {
tags["events_tag"] = m.tag
}
acc.AddFields("pmu_metric", fields, tags, m.time)
}
}
func init() {
inputs.Add("intel_pmu", func() telegraf.Input {
pmu := IntelPMU{
fileInfo: &fileHelper{},
}
return &pmu
})
}