terminal-based PCI topology explorer for Linux
- whole topology overview in compact or verbose mode
- visual representation of the device configuration space layout
- detailed information about each register within header/capability
- ability to display only needed register information
- virtual-to-physical address mapping info for
BARs - additional information decoding for
VirtIOdevices - quick navigation with keyboard & mouse
- topology snapshots
- ... more to come :)
- compiler supporting
C++20 cmakehwdata(for device IDs)- fmt library
- Ubuntu 24.04:
libfmt-dev,libfmt9 - Arch Linux:
fmt - Fedora 40:
fmt,fmt-devel
git clone https://github.com/s0nx/pciex.git
cd pciex && mkdir build
cmake -B build -S .
make -C build -j
There are 3 operation modes:
-
Live mode: display PCI device topology information of the current system.
sudo ./build/pciex -l -
Snapshot capture mode: obtain PCI device topology information of the current system
and save it to file.
sudo ./build/pciex -c < path/to/snapshot > -
Snapshot view mode: parse previously captured snapshot and display PCI device topology
./build/pciex -s < path/to/snapshot >
(note: modes 1 and 2 require root privileges in order to read the whole configuration space and parse vmalloced areas)
In order to be able to get meaningful v2p mapping info, kptr_restrict kernel parameter should set to 1:
echo 1 | sudo tee /proc/sys/kernel/kptr_restrict, otherwise the addresses would be hashed.
More information: kptr_restrict
Help window can be accessed at any time by pressing ? key.
The following libraries are used by this tool:
Add -DCMAKE_EXPORT_COMPILE_COMMANDS=1 during cmake invocation to generate compile_commands.json
By default, logs are written to /tmp/pciex/logs/
This project is in early development phase. Some features are still being worked on.
Several PCI capabilities have not been implemented yet.