Skip to content

Vlor999/mxtop

Repository files navigation

mxtop is an actively maintained fork of the original asitop. It aims to fix long-standing bugs and ensure compatibility with the latest macOS updates and Apple Silicon chips.

mxtop

PyPI - Version PyPI - Downloads PyPI - Python Version License

macOS GitHub Repo stars GitHub issues

Performance monitoring CLI tool for Apple Silicon

pip install mxtop

What is mxtop

A Python-based nvtop-inspired command line tool for Apple Silicon (aka M1) Macs.

  • Utilization info:
    • CPU (E-cluster and P-cluster), GPU
    • Frequency and utilization
    • ANE utilization (measured by power)
  • Memory info:
    • RAM and swap, size and usage
    • (Apple removed memory bandwidth from powermetrics)
  • Power info:
    • CPU power, GPU power (Apple removed package power from powermetrics)
    • Chart for CPU/GPU power
    • Peak power, rolling average display

mxtop uses the built-in powermetrics utility on macOS, which allows access to a variety of hardware performance counters. Note that it requires sudo to run due to powermetrics needing root access to run. mxtop is lightweight and has minimal performance impact.

mxtop works on Apple Silicon Macs (M1 through M4) on macOS Monterey and later.

Installation and Usage

mxtop is a Python-based command line tool. You need pip to download and install mxtop. macOS already comes with Python, to install pip, you can follow an online guide. After you install mxtop via pip, you can use it via the Terminal.

# recommended — enter password before start
sudo mxtop

# it will prompt for password on start
mxtop

# press q or ESC to quit

# all options
mxtop [-h] [--interval INTERVAL] [--color COLOR] [--avg AVG]
            [--show_cores SHOW_CORES] [--max_count MAX_COUNT]

options:
  -h, --help            show this help message and exit
  --interval INTERVAL   Display interval and sampling interval for powermetrics (seconds)
  --color COLOR         Choose display color (0-8)
  --avg AVG             Interval for averaged values (seconds)
  --show_cores          Show individual core utilization
  --max_count MAX_COUNT Max samples before restarting powermetrics (0 = unlimited)

How it works

powermetrics is used to measure the following:

  • CPU/GPU utilization via active residency
  • CPU/GPU frequency
  • Package/CPU/GPU/ANE energy consumption
  • CPU/GPU/Media Total memory bandwidth via the DCS (DRAM Command Scheduler)

psutil is used to measure the following:

  • memory and swap usage

sysctl is used to measure the following:

  • CPU name
  • CPU core counts

system_profiler is used to measure the following:

  • GPU core count

Some information is guesstimate and hardcoded as there doesn't seem to be a official source for it on the system:

  • CPU/GPU TDP
  • CPU/GPU maximum memory bandwidth
  • ANE max power
  • Media engine max bandwidth

License

MIT — see LICENSE for details.

About

Perf monitoring CLI tool for Apple Silicon

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages