ndctl: release v64

This release incorporates functionality up to the 5.0 kernel, and adds a
number of bug fixes and improvements.

Highlights include a migration path for the new dax-bus ABI, several
cleanups to ndctl-monitor, support for firmware status translation,
displaying the supported_alignments attribute, and using it in the
namespace creation process, and support for security operations as
defined in the Intel DSM specification.

Commands:
    inject-smart: check the firmware status for errors
    zero-labels: correctly handle firmware errors
    create-namespace: use supported_alignments when available
    Add new security commands

Tests:
    security.sh: new test for security commands
    device-dax: fix intermittent poison handling failures
    dsm-fail: cleanup leftover debug

APIs:
    ndctl_cmd_submit_xlat
    ndctl_cmd_xlat_firmware_status
    ndctl_dax_get_num_alignments
    ndctl_dax_get_supported_alignment
    ndctl_dimm_disable_passphrase
    ndctl_dimm_freeze_security
    ndctl_dimm_get_security
    ndctl_dimm_master_secure_erase
    ndctl_dimm_overwrite
    ndctl_dimm_secure_erase
    ndctl_dimm_update_master_passphrase
    ndctl_dimm_update_passphrase
    ndctl_dimm_wait_overwrite
    ndctl_pfn_get_num_alignments
    ndctl_pfn_get_supported_alignment
2 files changed
tree: 3857fc4bddb1513eac93ccdbefb637df0fef6152
  1. .gitignore
  2. CONTRIBUTING.md
  3. COPYING
  4. Documentation/
  5. Makefile.am
  6. Makefile.am.in
  7. README.md
  8. autogen.sh
  9. ccan/
  10. configure.ac
  11. contrib/
  12. daxctl/
  13. git-version
  14. git-version-gen
  15. licenses/
  16. m4/
  17. make-git-snapshot.sh
  18. ndctl.spec.in
  19. ndctl/
  20. nfit.h
  21. rpmbuild.sh
  22. sles/
  23. test.h
  24. test/
  25. util/
README.md

ndctl

Utility library for managing the libnvdimm (non-volatile memory device) sub-system in the Linux kernel

Build

./autogen.sh
./configure CFLAGS='-g -O2' --prefix=/usr --sysconfdir=/etc --libdir=/usr/lib64
make
make check
sudo make install

There are a number of packages required for the build steps that may not be installed by default. For information about the required packages, see the “BuildRequires:” lines in ndctl.spec.in.

https://github.com/pmem/ndctl/blob/master/ndctl.spec.in

Documentation

See the latest documentation for the NVDIMM kernel sub-system here:

https://git.kernel.org/cgit/linux/kernel/git/nvdimm/nvdimm.git/tree/Documentation/nvdimm/nvdimm.txt?h=libnvdimm-for-next

A getting started guide is also available on the kernel.org nvdimm wiki:

https://nvdimm.wiki.kernel.org/start

Unit Tests

The unit tests run by make check require the nfit_test.ko module to be loaded. To build and install nfit_test.ko:

  1. Obtain the kernel source. For example,
    git clone -b libnvdimm-for-next git://git.kernel.org/pub/scm/linux/kernel/git/nvdimm/nvdimm.git

  2. Skip to step 3 if the kernel version is >= v4.8. Otherwise, for kernel versions < v4.8, configure the kernel to make some memory available to CMA (contiguous memory allocator). This will be used to emulate DAX.

    CONFIG_DMA_CMA=y
    CONFIG_CMA_SIZE_MBYTES=200
    

    or
    cma=200M on the kernel command line.

  3. Compile the libnvdimm sub-system as a module, make sure “zone device” memory is enabled, and enable the btt, pfn, and dax features of the sub-system:

    CONFIG_X86_PMEM_LEGACY=m
    CONFIG_ZONE_DEVICE=y
    CONFIG_LIBNVDIMM=m
    CONFIG_BLK_DEV_PMEM=m
    CONFIG_ND_BLK=m
    CONFIG_BTT=y
    CONFIG_NVDIMM_PFN=y
    CONFIG_NVDIMM_DAX=y
    CONFIG_DEV_DAX_PMEM=m
    
  4. Build and install the unit test enabled libnvdimm modules in the following order. The unit test modules need to be in place prior to the depmod that runs during the final modules_install

    make M=tools/testing/nvdimm
    sudo make M=tools/testing/nvdimm modules_install
    sudo make modules_install
    
  5. Now run make check in the ndctl source directory, or ndctl test, if ndctl was built with --enable-test.

Troubleshooting

The unit tests will validate that the environment is set up correctly before they try to run. If the platform is misconfigured, i.e. the unit test modules are not available, or the test versions of the modules are superseded by the “in-tree/production” version of the modules make check will skip tests and report a message like the following in test/test-suite.log:

SKIP: libndctl
==============
test/init: nfit_test_init: nfit.ko: appears to be production version: /lib/modules/4.8.8-200.fc24.x86_64/kernel/drivers/acpi/nfit/nfit.ko.xz
__ndctl_test_skip: explicit skip test_libndctl:2684
nfit_test unavailable skipping tests

If the unit test modules are indeed available in the modules ‘extra’ directory the default depmod policy can be overridden by adding a file to /etc/depmod.d with the following contents:

override nfit * extra
override device_dax * extra
override dax_pmem * extra
override libnvdimm * extra
override nd_blk * extra
override nd_btt * extra
override nd_e820 * extra
override nd_pmem * extra

The nfit_test module emulates pmem with memory allocated via vmalloc(). One of the side effects is that this breaks ‘physically contiguous’ assumptions in the driver. Use the '--align=4K option to ‘ndctl create-namespace’ to avoid these corner case scenarios.