Utility library for managing the libnvdimm (non-volatile memory device) sub-system in the Linux kernel
C Shell Other
stellarhopper ndctl: release v62
This release incorporates functionality up to the 4.19 kernel, and a
number of bug fixes and improvements.

Highlights include addition of the 'ndctl monitor' command to monitor
for SMART health events, use of the new max_available_extent sysfs
attribute for namespace creation, verbosity levels for ndctl-list, a
udev rule for enabling the LSS latch when supported, a bypass route
for making the unsafe shutdown count available for non-privileged users,
improvements to ndctl-inject-smart that include an 'uninject' option
for all fields, and a new unit test, a number of static analysis fixes,
and unit test improvements and fixes.

Commands:
    monitor: new command for monitoring SMART health events
    list: support -v, -vv, -vvv verbosity levels
    inject-smart: add --uninject-* and --uninject-all options
    create-namespace: use max_available_extent for namespace creation
    list: add new fields to -H for alarm_enabled_*
    list: always output JSON arrays when --human is absent

Tests:
    dax.sh: dax-poisonCheck for availability of MAP_SYNC
    dax.sh: fix return code
    device-dax: relax canned timeouts
    monitor: new test
    inject-smart: new test
    max_available_extent_ns: new test

APIs:
    ndctl_cmd_smart_inject_ctrl_temperature
    ndctl_dimm_get_event_flags
    ndctl_dimm_get_flags
    ndctl_dimm_get_health
    ndctl_dimm_is_flag_supported
    ndctl_dimm_smart_inject_supported
    ndctl_region_get_max_available_extent
Latest commit 11f560f Aug 13, 2018
Permalink
Failed to load latest commit information.
Documentation ndctl: Add 'list' verbose options Aug 10, 2018
ccan ndctl: clamp dimm formats Jun 26, 2017
contrib ndctl, prepare-release.sh: fix revision update checks Aug 11, 2018
daxctl ndctl list: always output array without --human Jul 11, 2018
licenses ndctl: remove unreferenced ccan license file Aug 29, 2016
m4 Import initial infrastructure Aug 27, 2014
ndctl ndctl: Work around kernel memory corruption Aug 13, 2018
sles ndctl: rework release collateral Feb 9, 2016
test ndctl, test: fix a resource leak in check_smart_threshold Aug 10, 2018
util ndctl: Add 'list' verbose options Aug 10, 2018
.gitignore ndctl: Create ndctl udev rules for dirty shutdown Aug 8, 2018
CONTRIBUTING.md ndctl: Add CONTRIBUTING.md Jun 29, 2018
COPYING Import initial infrastructure Aug 27, 2014
Makefile.am ndctl: Create ndctl udev rules for dirty shutdown Aug 8, 2018
Makefile.am.in ndctl: release v62 Aug 14, 2018
README.md ndctl: Update README.md for code blocks Jun 13, 2018
autogen.sh ndctl, monitor: add the unit file of systemd for ndctl-monitor service Jul 18, 2018
builtin.h ndctl, monitor: add a new command - monitor Jul 18, 2018
configure.ac ndctl: Create ndctl udev rules for dirty shutdown Aug 8, 2018
git-version ndctl: release v62 Aug 14, 2018
git-version-gen ndctl: rework release collateral Feb 9, 2016
make-git-snapshot.sh ndctl: switch to ndctl-VERSION tag format May 9, 2016
ndctl.spec.in ndctl: Create ndctl udev rules for dirty shutdown Aug 8, 2018
nfit.h ndctl: release v50 Feb 2, 2016
rpmbuild.sh ndctl, rpmbuild: check for rpmbuild working directories Nov 30, 2017
test.h ndctl, test: Disable poison tests for now Jun 15, 2018

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.