FreeBSD

FreeBSD (13)

Install the required toolchain and libraries by running the package installation script provided with the xNVMe repository, as shown below. Ensure that you have sufficient system privileges when doing so (e.g., run as root or with sudo):

sudo ./xnvme/toolbox/pkgs/freebsd-13.sh

Or, run the commands contained within the script manually:

# Install packages via the system package-manager (pkg)
pkg install -qy \
 autoconf \
 automake \
 bash \
 cunit \
 devel/py-pipx \
 devel/py-pyelftools \
 e2fsprogs-libuuid \
 findutils \
 git \
 gmake \
 isa-l \
 libtool \
 meson \
 nasm \
 ncurses \
 openssl \
 patch \
 pkgconf \
 python3 \
 wget

Note

A Docker-image is provided via ghcr.io, specifically ghcr.io/xnvme/xnvme-deps-freebsd-13:next. This Docker-image contains all the software described above.

Then go ahead and configure, build and install using meson:

# configure xNVMe and build meson subprojects(SPDK)
meson setup builddir

# build xNVMe
meson compile -C builddir

# install xNVMe
meson install -C builddir

# uninstall xNVMe
# cd builddir && meson --internal uninstall

Note

Interfaces; libaio, liburing, and libvfn are not supported on FreeBSD.

FreeBSD (14)

Install the required toolchain and libraries by running the package installation script provided with the xNVMe repository, as shown below. Ensure that you have sufficient system privileges when doing so (e.g., run as root or with sudo):

sudo ./xnvme/toolbox/pkgs/freebsd-14.sh

Or, run the commands contained within the script manually:

# Install packages via the system package-manager (pkg)
pkg install -qy \
 autoconf \
 automake \
 bash \
 cunit \
 devel/py-pipx \
 devel/py-pyelftools \
 e2fsprogs-libuuid \
 findutils \
 git \
 gmake \
 isa-l \
 libtool \
 meson \
 nasm \
 ncurses \
 openssl \
 patch \
 pkgconf \
 python3 \
 wget

Note

A Docker-image is provided via ghcr.io, specifically ghcr.io/xnvme/xnvme-deps-freebsd-14:next. This Docker-image contains all the software described above.

Then go ahead and configure, build and install using meson:

# configure xNVMe and build meson subprojects(SPDK)
meson setup builddir

# build xNVMe
meson compile -C builddir

# install xNVMe
meson install -C builddir

# uninstall xNVMe
# cd builddir && meson --internal uninstall

Note

Interfaces; libaio, liburing, and libvfn are not supported on FreeBSD.