qmassa is a top-like Rust-based tool for displaying GPU devices usage stats on Linux.
qmassa tries to display as much device and DRM clients (processes using the GPU) information as possible. Command-line options and which user is running the tool control how much can be displayed.
Most of the information is gathered through a GPU vendor and driver agnostic interface such as standard files in /proc and /sys or by using udev. For some of the stats, though, a driver-specific way is needed, and qmassa then leverages what the kernel drivers expose in their uAPI (e.g. specific query ioctls).
Running it as non-root user and wihout any command-line options will display limited device usage information, and will show the DRM clients stats from processes that user has access to in /proc.
qmassaRunning it as the root user and wihout any commnad-line options will display all the device avaiable stats along with all active DRM clients in the system.
sudo qmassaOnly show a specific GPU device and DRM clients using it. The GPU device is specified by its PCI device slot name.
sudo qmassa -d 0000:03:00.0Only show DRM clients from the process tree starting at a specific PID.
sudo qmassa -p 2876Running only for 5 iterations (UI updates).
sudo qmassa -n 5Changing the interval between updates to 1s (1000 ms).
sudo qmassa -m 1000Showing all DRM clients including the inactive ones (no memory allocated or engines being used).
sudo qmassa -aSaving the stats to a JSON file.
sudo qmassa -t data.json| Field | Description |
|---|---|
| DRIVER | Kernel driver being used |
| TYPE | Integrated, Discrete or Unknown |
| DEVICE NODES | Character device nodes in /dev/dri |
| SMEM | System memory used / Total system memory |
| VRAM | Device memory used / Total device memory |
| [Engines] | Overall engine usage in the last iteration |
The overall engines usage depends on the DRM clients that the user has access to. In order to have a system view, please run qmassa as root.
The frequency graph ranges from min to max values and plots the instant driver-requested and actual device frequency for each iteration. It also indicates the overall status and PL1 throttle reasons (for now) for i915 and Xe drivers.
- i915: the kernel driver doesn't track/report overall system memory used and thus qmassa can't display it.
| Field | Description |
|---|---|
| PID | Process ID |
| SMEM | Resident amount of system memory |
| VRAM | Resident amount of device memory |
| MIN | Minor number of /dev/dri device node being used |
| [Engines] | Engine usage in the last iteration |
| CPU | Process' overall CPUs usage in the last iteration |
| COMMAND | [/proc/PID/comm] /proc/PID/cmdline |
The engines reported are driver and vendor specific, and are read directly from DRM fdinfo files in /proc.
The CPU usage is measured by how much CPU time that process used versus the total available CPU time across all online CPUs in the system for that iteration. The total available CPU time is the time between two samples times the number of online CPUs. This allows this value to stay between 0% and 100%.
qmassa uses Ratatui for displaying a nice terminal-based UI and leverages many other Rust crates.
Copyright © 2024 Ulisses Furquim
This project is distributed under the terms of the Apache License (Version 2.0). See LICENSE for details.
