qmassa 1.2.0

Terminal-based tool for displaying GPUs usage stats on Linux.
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
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
#![allow(dead_code)]
#![allow(non_camel_case_types)]
#![allow(non_upper_case_globals)]

use std::collections::HashMap;
use std::path::{Path, PathBuf};
use std::fs::{self, File};
use std::os::fd::{RawFd, AsRawFd};
use std::cell::RefCell;
use std::cmp::max;
use std::rc::Rc;
use std::time;
use std::alloc;
use std::mem;
use std::io;

use anyhow::{bail, Result};
use libc::Ioctl;
use log::{debug, info, warn};

use crate::perf_event::{perf_event_attr, PERF_FORMAT_GROUP, PerfEvent};
use crate::hwmon::Hwmon;
use crate::drm_drivers::{
    DrmDriver, helpers::{drm_iowr, drm_ioctl, __IncompleteArrayField},
    intel_power::{GpuPowerIntel, IGpuPowerIntel, DGpuPowerIntel},
};
use crate::drm_devices::{
    DrmDeviceType, DrmDeviceFreqs, DrmDeviceFreqLimits,
    DrmDeviceThrottleReasons, DrmDevicePower, DrmDeviceMemInfo,
    DrmDeviceTemperature, DrmDeviceFan, DrmDeviceInfo
};
use crate::drm_fdinfo::DrmMemRegion;
use crate::drm_clients::DrmClientMemInfo;


// based on rust-bindgen on Linux kernel v6.12+ uapi i915_drm.h
#[repr(C)]
#[derive(Debug, Copy, Clone)]
struct drm_i915_gem_memory_class_instance {
    memory_class: u16,
    memory_instance: u16,
}

const I915_MEMORY_CLASS_SYSTEM: u16 = 0;
const I915_MEMORY_CLASS_DEVICE: u16 = 1;

#[repr(C)]
#[derive(Debug, Copy, Clone)]
struct drm_i915_memory_region_info_cpu_visible_memory {
    probed_cpu_visible_size: u64,
    unallocated_cpu_visible_size: u64,
}

#[repr(C)]
#[derive(Copy, Clone)]
union drm_i915_memory_region_info_extra_info {
    rsvd1: [u64; 8usize],
    cpu: drm_i915_memory_region_info_cpu_visible_memory,
}

#[repr(C)]
#[derive(Copy, Clone)]
struct drm_i915_memory_region_info {
    region: drm_i915_gem_memory_class_instance,
    rsvd0: u32,
    probed_size: u64,
    unallocated_size: u64,
    extra_info: drm_i915_memory_region_info_extra_info,
}

#[repr(C)]
#[derive(Debug)]
struct drm_i915_query_memory_regions {
    num_regions: u32,
    rsvd: [u32; 3usize],
    regions: __IncompleteArrayField<drm_i915_memory_region_info>,
}

const DRM_I915_QUERY_MEMORY_REGIONS: u64 = 4;

#[repr(C)]
#[derive(Debug, Copy, Clone)]
struct drm_i915_query_item {
    query_id: u64,
    length: i32,
    flags: u32,
    data_ptr: u64,
}

#[repr(C)]
#[derive(Debug, Copy, Clone)]
struct drm_i915_query {
    num_items: u32,
    flags: u32,
    items_ptr: u64,
}

const DRM_I915_QUERY: Ioctl = 0x39;
const DRM_IOCTL_I915_QUERY: Ioctl = drm_iowr!(DRM_I915_QUERY,
    mem::size_of::<drm_i915_query>());

const I915_ENGINE_CLASS_RENDER: u16 = 0;
const I915_ENGINE_CLASS_COPY: u16 = 1;
const I915_ENGINE_CLASS_VIDEO: u16 = 2;
const I915_ENGINE_CLASS_VIDEO_ENHANCE: u16 = 3;
const I915_ENGINE_CLASS_COMPUTE: u16 = 4;

const QM_I915_ENGINE_CLASS_TOTAL: usize = 5;
const i915_engine_class_name: [&str; QM_I915_ENGINE_CLASS_TOTAL] = [
    "render",
    "copy",
    "video",
    "video-enhance",
    "compute",
];

#[derive(Debug)]
struct I915Engine
{
    name: String,
    class: u16,
}

#[derive(Debug)]
struct I915EnginePmuData
{
    idx: usize,
    last_active: u64,
}

#[derive(Debug)]
struct I915EnginesPmu
{
    pf_evt: PerfEvent,
    nr_evts: usize,
    nr_engs: usize,
    engs_data: Vec<Vec<I915EnginePmuData>>,
    nr_updates: u64,
    last_update: time::Instant,
}

impl I915EnginesPmu
{
    fn engs_utilization(&mut self) -> Result<HashMap<String, f64>>
    {
        let mut engs_ut = HashMap::new();

        let data = self.pf_evt.read(self.nr_evts + 1)?;
        let elapsed = self.last_update.elapsed().as_nanos() as u64;
        self.last_update = time::Instant::now();
        self.nr_updates += 1;

        for cn in 0..self.nr_engs {
            let mut acum_active = 0;
            let mut acum_total = 0;

            for epd in self.engs_data[cn].iter_mut() {
                let curr_active = data[1 + epd.idx];

                if self.nr_updates >= 2  {
                    acum_active += curr_active - epd.last_active;
                    acum_total += elapsed;
                }
                epd.last_active = curr_active;
            }

            let mut eut = if acum_active == 0 || acum_total == 0 {
                0.0
            } else {
                (acum_active as f64 / acum_total as f64) * 100.0
            };
            if eut > 100.0 {
                warn!("Engine {:?} utilization at {:.1}%, \
                    clamped to 100%.", i915_engine_class_name[cn], eut);
                eut = 100.0;
            }
            engs_ut.insert(i915_engine_class_name[cn].to_string(), eut);
        }

        Ok(engs_ut)
    }
}

#[derive(Debug)]
pub struct DrmDriveri915
{
    _dn_file: File,
    dn_fd: RawFd,
    base_gts_dir: PathBuf,
    dev_type: Option<DrmDeviceType>,
    freq_limits: Option<Vec<DrmDeviceFreqLimits>>,
    power: Option<Box<dyn GpuPowerIntel>>,
    hwmon: Option<Hwmon>,
    engs_pmu: Option<I915EnginesPmu>,
}

impl DrmDriver for DrmDriveri915
{
    fn name(&self) -> &str
    {
        "i915"
    }

    fn dev_type(&mut self) -> Result<DrmDeviceType>
    {
        if let Some(dt) = &self.dev_type {
            return Ok(dt.clone());
        }

        let dmi = self.mem_info()?;
        let qmdt = if dmi.vram_total > 0 {
            DrmDeviceType::Discrete
        } else {
            DrmDeviceType::Integrated
        };

        self.dev_type = Some(qmdt.clone());
        Ok(qmdt)
    }

    fn mem_info(&mut self) -> Result<DrmDeviceMemInfo>
    {
        let mut dqi = drm_i915_query_item {
            query_id: DRM_I915_QUERY_MEMORY_REGIONS,
            length: 0,
            flags: 0,
            data_ptr: 0,
        };
        let dqi_ptr: *mut drm_i915_query_item = &mut dqi;

        let mut dq = drm_i915_query {
            num_items: 1,
            flags: 0,
            items_ptr: dqi_ptr as u64,
        };

        let res = drm_ioctl!(self.dn_fd, DRM_IOCTL_I915_QUERY, &mut dq);
        if res < 0 {
            return Err(io::Error::last_os_error().into());
        }

        if dqi.length as usize <= 0 {
            warn!("i915 memregions query ioctl() with {:?} length, skipping.",
                dqi.length as usize);
            return Ok(DrmDeviceMemInfo::new());
        }

        let layout = alloc::Layout::from_size_align(dqi.length as usize,
            mem::align_of::<u64>()).unwrap();
        let qmrg = unsafe {
            let ptr = alloc::alloc_zeroed(layout) as *mut drm_i915_query_memory_regions;
            if ptr.is_null() {
                panic!("Can't allocate memory for i915 memregions query ioctl()");
            }

            ptr
        };
        dqi.data_ptr = qmrg as u64;

        let res = drm_ioctl!(self.dn_fd, DRM_IOCTL_I915_QUERY, &mut dq);
        if res < 0 {
            unsafe { alloc::dealloc(qmrg as *mut u8, layout); }
            return Err(io::Error::last_os_error().into());
        }
        if dqi.length <= 0 {
            warn!("i915 memregions query ioctl() error: {:?}", dqi.length);
            unsafe { alloc::dealloc(qmrg as *mut u8, layout); }
            return Ok(DrmDeviceMemInfo::new());
        }
        let mrgs = unsafe {
            (*qmrg).regions.as_slice((*qmrg).num_regions as usize) };

        let mut qmdmi = DrmDeviceMemInfo::new();
        for mr in mrgs {
            match mr.region.memory_class {
                I915_MEMORY_CLASS_SYSTEM => {
                    qmdmi.smem_total += mr.probed_size;
                    qmdmi.smem_used += mr.probed_size - mr.unallocated_size;
                },
                I915_MEMORY_CLASS_DEVICE => {
                    qmdmi.vram_total += mr.probed_size;
                    qmdmi.vram_used += mr.probed_size - mr.unallocated_size;
                },
                _ => {
                    warn!("Unknown i915 memory class: {:?}, skipping mem region.",
                        mr.region.memory_class);
                    continue;
                }
            }
        }

        unsafe { alloc::dealloc(qmrg as *mut u8, layout); }

        Ok(qmdmi)
    }

    fn freq_limits(&mut self) -> Result<Vec<DrmDeviceFreqLimits>>
    {
        if let Some(fls) = &self.freq_limits {
            return Ok(fls.clone());
        }

        let mut fls = Vec::new();
        for nr in 0.. {
            let freqs_dir = self.base_gts_dir.join(format!("gt{}", nr));
            if !freqs_dir.is_dir() {
                break;
            }

            let fpath = freqs_dir.join("rps_RPn_freq_mhz");
            let fstr = fs::read_to_string(&fpath)?;
            let rpn_val: u64 = fstr.trim_end().parse()?;

            let fpath = freqs_dir.join("rps_RP1_freq_mhz");
            let fstr = fs::read_to_string(&fpath)?;
            let rp1_val: u64 = fstr.trim_end().parse()?;

            let fpath = freqs_dir.join("rps_RP0_freq_mhz");
            let fstr = fs::read_to_string(&fpath)?;
            let rp0_val: u64 = fstr.trim_end().parse()?;

            fls.push(DrmDeviceFreqLimits {
                name: format!("gt{}", nr),
                minimum: rpn_val,
                efficient: rp1_val,
                maximum: rp0_val,
            });
        }

        self.freq_limits = Some(fls.clone());
        Ok(fls)
    }

    fn freqs(&mut self) -> Result<Vec<DrmDeviceFreqs>>
    {
        let mut fqs = Vec::new();
        for nr in 0.. {
            let freqs_dir = self.base_gts_dir.join(format!("gt{}", nr));
            if !freqs_dir.is_dir() {
                break;
            }

            let fpath = freqs_dir.join("rps_min_freq_mhz");
            let fstr = fs::read_to_string(&fpath)?;
            let min_val: u64 = fstr.trim_end().parse()?;

            let fpath = freqs_dir.join("rps_cur_freq_mhz");
            let fstr = fs::read_to_string(&fpath)?;
            let cur_val: u64 = fstr.trim_end().parse()?;

            let fpath = freqs_dir.join("rps_act_freq_mhz");
            let fstr = fs::read_to_string(&fpath)?;
            let act_val: u64 = fstr.trim_end().parse()?;

            let fpath = freqs_dir.join("rps_max_freq_mhz");
            let fstr = fs::read_to_string(&fpath)?;
            let max_val: u64 = fstr.trim_end().parse()?;

            let fpath = freqs_dir.join("throttle_reason_pl1");
            let pl1 = fpath.is_file() &&
                fs::read_to_string(&fpath)?.trim() == "1";

            let fpath = freqs_dir.join("throttle_reason_pl2");
            let pl2 = fpath.is_file() &&
                fs::read_to_string(&fpath)?.trim() == "1";

            let fpath = freqs_dir.join("throttle_reason_pl4");
            let pl4 = fpath.is_file() &&
                fs::read_to_string(&fpath)?.trim() == "1";

            let fpath = freqs_dir.join("throttle_reason_prochot");
            let prochot = fpath.is_file() &&
                fs::read_to_string(&fpath)?.trim() == "1";

            let fpath = freqs_dir.join("throttle_reason_ratl");
            let ratl = fpath.is_file() &&
                fs::read_to_string(&fpath)?.trim() == "1";

            let fpath = freqs_dir.join("throttle_reason_thermal");
            let thermal = fpath.is_file() &&
                fs::read_to_string(&fpath)?.trim() == "1";

            let fpath = freqs_dir.join("throttle_reason_vr_tdc");
            let vr_tdc = fpath.is_file() &&
                fs::read_to_string(&fpath)?.trim() == "1";

            let fpath = freqs_dir.join("throttle_reason_vr_thermalert");
            let vr_thermalert = fpath.is_file() &&
                fs::read_to_string(&fpath)?.trim() == "1";

            let fpath = freqs_dir.join("throttle_reason_status");
            let status = fpath.is_file() &&
                fs::read_to_string(&fpath)?.trim() == "1";

            let throttle = DrmDeviceThrottleReasons {
                pl1,
                pl2,
                pl4,
                prochot,
                ratl,
                thermal,
                vr_tdc,
                vr_thermalert,
                status,
            };

            fqs.push(DrmDeviceFreqs {
                min_freq: min_val,
                cur_freq: cur_val,
                act_freq: act_val,
                max_freq: max_val,
                throttle_reasons: throttle,
            });
        }

        Ok(fqs)
    }

    fn power(&mut self) -> Result<DrmDevicePower>
    {
        if self.power.is_none() {
            return Ok(DrmDevicePower::new());
        }

        self.power.as_mut().unwrap().power_usage(&self.hwmon)
    }

    fn client_mem_info(&mut self,
        mem_regs: &HashMap<String, DrmMemRegion>) -> Result<DrmClientMemInfo>
    {
        let mut cmi = DrmClientMemInfo::new();

        for mr in mem_regs.values() {
            if mr.name.starts_with("system") ||
                mr.name.starts_with("stolen-system") {
                cmi.smem_used += mr.total;
                cmi.smem_rss += mr.resident;
            } else if mr.name.starts_with("local") ||
                mr.name.starts_with("stolen-local") {
                cmi.vram_used += mr.total;
                cmi.vram_rss += mr.resident;
            } else {
                warn!("Unknown i915 memory region: {:?}, skpping it.", mr.name);
                continue;
            }
        }

        Ok(cmi)
    }

    fn engs_utilization(&mut self) -> Result<HashMap<String, f64>>
    {
        if self.engs_pmu.is_none() {
            return Ok(HashMap::new());
        }

        self.engs_pmu.as_mut().unwrap().engs_utilization()
    }

    fn temps(&mut self) -> Result<Vec<DrmDeviceTemperature>>
    {
        if self.hwmon.is_some() {
            DrmDeviceTemperature::from_hwmon(self.hwmon.as_ref().unwrap())
        } else {
            Ok(Vec::new())
        }
    }

    fn fans(&mut self) -> Result<Vec<DrmDeviceFan>>
    {
        if self.hwmon.is_some() {
            DrmDeviceFan::from_hwmon(self.hwmon.as_ref().unwrap())
        } else {
            Ok(Vec::new())
        }
    }
}

impl DrmDriveri915
{
    fn engines_info(&self, cpath: &str) -> Result<Vec<I915Engine>>
    {
        let engs_dir = Path::new(cpath).join("engine");
        let mut engs = Vec::new();

        for et in fs::read_dir(&engs_dir)? {
            let path = et?.path();
            if !path.is_dir() {
                continue;
            }

            let name = fs::read_to_string(path.join("name"))?
                .trim()
                .to_string();
            let class: u16 = fs::read_to_string(path.join("class"))?
                .trim()
                .parse()?;

            engs.push(
                I915Engine {
                    name,
                    class,
                }
            );
        }

        Ok(engs)
    }

    fn init_engines_pmu(&mut self,
        dtype: &DrmDeviceType, pci_dev: &str, cpath: &str) -> Result<()>
    {
        if !PerfEvent::is_capable() {
            bail!("No PMU support");
        }

        let mut src = String::from("i915");
        if dtype.is_discrete() {
            src.push_str("_");
            src.push_str(pci_dev);
        }
        let src = src.replace(":", "_");

        if !PerfEvent::has_source(&src) {
            bail!("No PMU source {:?}", &src);
        }

        let mut pf_evt = PerfEvent::new(&src);
        let mut pf_attr = perf_event_attr::new();
        pf_attr.type_ = pf_evt.source_type()?;
        pf_attr.size = mem::size_of::<perf_event_attr>() as u32;
        pf_attr.read_format = PERF_FORMAT_GROUP;

        let engs_info = self.engines_info(cpath)?;
        let mut nr_engs = 0;
        for eng in engs_info.iter() {
            nr_engs = max(nr_engs, (eng.class + 1) as usize);
        }
        let mut engs_data = Vec::new();
        for _ in 0..nr_engs {
            let nvec: Vec<I915EnginePmuData> = Vec::new();
            engs_data.push(nvec);
        }
        let mut idx = 0;

        for eng in engs_info.iter() {
            let evt_name = format!("{}-busy", &eng.name);

            let evt_unit = pf_evt.event_unit(&evt_name)?;
            if evt_unit != "ns" {
                bail!("Event {:?} with unexpected unit {:?} vs \"ns\"",
                    &evt_name, &evt_unit);
            }

            pf_attr.config = pf_evt
                .event_keys_config(&evt_name, &vec!["config"])?["config"];
            // TODO: check why i915 PMUs only work with CPU 0
            pf_evt.group_open(&pf_attr, -1, 0, 0)?;

            engs_data[eng.class as usize].push(
                I915EnginePmuData {
                    idx,
                    last_active: 0,
                }
            );
            idx += 1;
        }

        self.engs_pmu = Some(
            I915EnginesPmu {
                pf_evt,
                nr_evts: idx,
                nr_engs,
                engs_data,
                nr_updates: 0,
                last_update: time::Instant::now(),
            }
        );

        Ok(())
    }

    pub fn new(qmd: &DrmDeviceInfo,
        opts: Option<&Vec<&str>>) -> Result<Rc<RefCell<dyn DrmDriver>>>
    {
        let file = File::open(qmd.drm_minors[0].devnode.clone())?;
        let fd = file.as_raw_fd();

        let mut cpath = String::from("/sys/class/drm/");
        let card = Path::new(&qmd.drm_minors[0].devnode)
            .file_name().unwrap().to_str().unwrap();
        cpath.push_str(card);

        // TODO: handle more than one tile
        let mut i915 = DrmDriveri915 {
            _dn_file: file,
            dn_fd: fd,
            base_gts_dir: Path::new(&cpath).join("gt"),
            dev_type: None,
            freq_limits: None,
            power: None,
            hwmon: None,
            engs_pmu: None,
        };

        let dtype = i915.dev_type()?;
        i915.freq_limits()?;

        if dtype.is_integrated() {
            i915.power = IGpuPowerIntel::new()?;
            if let Some(po) = &i915.power {
                info!("{}: rapl power reporting from: {}",
                    &qmd.pci_dev, po.name());
            } else {
                info!("{}: no rapl power reporting", &qmd.pci_dev);
            }
        } else if dtype.is_discrete() {
            let hwmon_res = Hwmon::from(
                Path::new(&cpath).join("device/hwmon"));
            if let Ok(hwmon) = hwmon_res {
                i915.power = DGpuPowerIntel::from(hwmon.as_ref().unwrap())?;
                i915.hwmon = hwmon;
            } else {
                debug!("{}: ERR: no Hwmon support on dGPU: {:?}",
                    &qmd.pci_dev, hwmon_res);
            }
            info!("{}: Hwmon power reporting: {}", &qmd.pci_dev,
                if i915.power.is_some() { "OK" } else { "FAILED" });
        }

        if let Some(opts_vec) = opts {
            let mut use_eng_pmu = false;

            for &opts_str in opts_vec.iter() {
                let sep_opts: Vec<&str> = opts_str.split(',').collect();
                let mut want_eng_pmu = false;
                let mut devslot = "all";

                for opt in sep_opts.iter() {
                    if opt.starts_with("devslot=") {
                        devslot = &opt["devslot=".len()..];
                    } else if opt == &"engines=pmu" {
                        want_eng_pmu = true;
                    }
                }

                if want_eng_pmu &&
                    (devslot == "all" || devslot == qmd.pci_dev) {
                    use_eng_pmu = true;
                }
            }

            if use_eng_pmu {
                let res = i915.init_engines_pmu(&dtype, &qmd.pci_dev, &cpath);
                info!("{}: engines PMU init: {}",
                    &qmd.pci_dev, if res.is_ok() { "OK" } else { "FAILED" });
                if res.is_err() {
                    debug!("{}: ERR: failed to enable engines PMU: {:?}",
                        &qmd.pci_dev, res);
                }
            }
        }

        Ok(Rc::new(RefCell::new(i915)))
    }
}