ndctl: release v68

This release incorporates functionality up to the 5.6 kernel.

Highlights for this release include new commands to read-infoblock and
write-infoblock, improvements and tests related to alignment
constraints, misc build/compilation related fixes, and misc usability and
documentation fixes.

Commands:
  zero-labels: display an error if regions are active
  destroy-namespace: fix seed namespace accounting
  list: drop named list objects from verbose listing
  *-namespace: emit better errors on failure
  read-infoblock: new command to read an infoblock
  write-infoblock: new command to create and write an infoblock

Tests:
  add bus-id parameter for start-scrub/wait-scrub operation
  udate dax-dev to handle multiple e820 ranges
  exercise sub-section sized namespace creation/deletion
  new test for misaligned namespaces
  labels: test for 'failed to track'

APIs:
  ndctl_namespace_get_target_node
  ndctl_namespace_is_configuration_idle
  ndctl_region_get_align
  ndctl_region_get_target_node
  ndctl_region_set_align
ndctl: release v68

This release incorporates functionality up to the 5.6 kernel.

Highlights for this release include new commands to read-infoblock and
write-infoblock, improvements and tests related to alignment
constraints, misc build/compilation related fixes, and misc usability and
documentation fixes.

Commands:
  zero-labels: display an error if regions are active
  destroy-namespace: fix seed namespace accounting
  list: drop named list objects from verbose listing
  *-namespace: emit better errors on failure
  read-infoblock: new command to read an infoblock
  write-infoblock: new command to create and write an infoblock

Tests:
  add bus-id parameter for start-scrub/wait-scrub operation
  udate dax-dev to handle multiple e820 ranges
  exercise sub-section sized namespace creation/deletion
  new test for misaligned namespaces
  labels: test for 'failed to track'

APIs:
  ndctl_namespace_get_target_node
  ndctl_namespace_is_configuration_idle
  ndctl_region_get_align
  ndctl_region_get_target_node
  ndctl_region_set_align
2 files changed
tree: c52bb6273fde0b0a6d0a4460cb05bc001f21614d
  1. .gitignore
  2. .travis.yml
  3. CONTRIBUTING.md
  4. COPYING
  5. Documentation/
  6. Makefile.am
  7. Makefile.am.in
  8. README.md
  9. autogen.sh
  10. ccan/
  11. configure.ac
  12. contrib/
  13. daxctl/
  14. git-version
  15. git-version-gen
  16. licenses/
  17. m4/
  18. make-git-snapshot.sh
  19. ndctl.spec.in
  20. ndctl/
  21. nfit.h
  22. rpmbuild.sh
  23. sles/
  24. test.h
  25. test/
  26. util/
README.md

ndctl

Build Status

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://www.kernel.org/doc/html/latest/driver-api/nvdimm/index.html

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 dax_pmem_core * extra
override dax_pmem_compat * 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.