Skip to content

pmem/ndctl

main
Switch branches/tags
Code

Latest commit

This release incorporates functionality up to the 6.0 kernel.

Highlights include CXL region management, enhancements to cxl-list,
cxl_test based unit tests for topology enumeration, and region and
label operations, misc build fixes, iniparser include resolution,
fixes in config parsing for ndctl-monitor, and misc documentation
and unit test updates.

Commands:
  cxl-create-region: new command (also {enable,disable,destroy}-region)
  cxl-list: add -v / -vv etc. options for verbosity control
  cxl-list: new filtering options, endpoint decoder DPA listings
  cxl-list: add decoder interleave settings, and mode
  cxl-list: add port depth
  cxl-list: Auto-enable 'single' mode for port listings
  cxl-set-partition: Accept 'ram' as an alias for 'volatile'
  cxl-disable-bus: new command
  cxl-{reserve,free}-dpa: new commands
  ndctl-xable-namespace: zero namespace fixes
  ndctl-monitor: fix config parsing
  daxctl-reconfigure-device: fix systemd escaping for policy config

Tests:
  cxl-topology.sh: new test for CXL topology enumeration
  cxl-region-sysfs.sh: new test for the low-level CXL region ABI
  cxl-create-region.sh: new test for region management
  cxl-labels.sh: new test for label management commands

APIs:
  cxl_bus_disable_invalidate
  cxl_decoder_create_pmem_region
  cxl_decoder_get_by_name
  cxl_decoder_get_dpa_resource
  cxl_decoder_get_dpa_size
  cxl_decoder_get_interleave_granularity
  cxl_decoder_get_interleave_ways
  cxl_decoder_get_last
  cxl_decoder_get_max_available_extent
  cxl_decoder_get_memdev
  cxl_decoder_get_mode
  cxl_decoder_get_prev
  cxl_decoder_get_region
  cxl_decoder_set_dpa_size
  cxl_decoder_set_mode
  cxl_mapping_get_decoder
  cxl_mapping_get_first
  cxl_mapping_get_next
  cxl_mapping_get_position
  cxl_mapping_get_region
  cxl_port_get_depth
  cxl_region_clear_all_targets
  cxl_region_clear_target
  cxl_region_decode_commit
  cxl_region_decode_is_committed
  cxl_region_decode_reset
  cxl_region_delete
  cxl_region_disable
  cxl_region_enable
  cxl_region_get_ctx
  cxl_region_get_decoder
  cxl_region_get_devname
  cxl_region_get_first
  cxl_region_get_id
  cxl_region_get_interleave_granularity
  cxl_region_get_interleave_ways
  cxl_region_get_next
  cxl_region_get_resource
  cxl_region_get_size
  cxl_region_get_target_decoder
  cxl_region_get_uuid
  cxl_region_is_enabled
  cxl_region_set_interleave_granularity
  cxl_region_set_interleave_ways
  cxl_region_set_size
  cxl_region_set_target
  cxl_region_set_uuid
c9c9db3

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
cxl
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

ndctl

Build Status

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

Packaging status

Build

meson setup build;
meson compile -C build;

Optionally, to install:

meson install -C build

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 meson test 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
    CONFIG_ENCRYPTED_KEYS=y
    
  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 meson test -C build in the ndctl source directory, or ndctl test, if ndctl was built with -Dtest=enabled as a configuration option to meson.

  6. To run the 'destructive' set of tests that may clobber existing pmem configurations and data, configure meson with the destructive option after the meson setup step:

    meson configure -Dtest=enabled -Ddestructive=enabled build;
    

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 meson test will skip tests and report a message like the following in build/meson-logs/testlog.txt

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_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.

About

A "device memory" enabling project encompassing tools and libraries for CXL, NVDIMMs, DAX, memory tiering and other platform memory device topics.

Topics

Resources

License

Stars

Watchers

Forks