This is a port of libvfn for macOS and implemented into xNVMe. It utilizes DriverKit to hook an external PCI NVMe device (through PCIDriverKit), and allows user-space applications to take control of the device.
This is not suitable for production, as it requires disabling SIP, and everything has to be self-signed. The code might also be buggy or have improper memory management, as this is just a proof-of-concept at this point.
Consider this a beta release. It works fine for prototyping, testing, and development.
Although it's a port of libvfn, there is no way of running any of the example code from the libvfn project, as they heavily depend on Linux-only APIs. Instead, MacVFN has been implemented in xNVMe as a reference solution. All the examples from xNVMe should work.
- Interrupts
- Timeouts
- Register with BlockStorageDeviceDriverKit
These are the basic steps to build and install the driver:
- Disable SIP
- Git clone this repo with submodules:
git clone --recurse-submodules https://github.com/openmpdk/MacVFN.git - Run
make build install kill log, approve system extension and type sudo-password as needed - Clone xNVMe with the
driverkitbranch:git clone -b driverkit https://github.com/baekalfen/xnvme - Run
make config build install - Check your NVMe device enumerates
./builddir/tools/xnvme enum - Then take the 'uri' and run a command:
./builddir/tools/xnvme idfy 1 --cns 0 --be=driverkit - Or two
./builddir/examples/xnvme_single_sync 1 - Or three
./builddir/examples/xnvme_single_async 1
Optionally, you can clone and build fio with xNVMe support:
- Git clone fio:
git clone https://github.com/axboe/fio - Install GNU-make:
brew install make - Use
gmaketo build it:gmake -j - Run a test:
./fio --name=test1 --iodepth=64 --rw=write --bs=512 --size=1GB --loops=1 --numjobs=1 --direct=1 --ioengine=xnvme --filename=1 --thread=1 --xnvme_dev_nsid=1 --xnvme_be=driverkit --xnvme_sync=driverkit --xnvme_async=driverkit --verify=crc32