multipath-tools for Linux

https://github.com/opensvc/multipath-tools

This package provides the following binaries to drive the Device Mapper multipathing driver:

• multipath - Device mapper target autoconfig.
• multipathd - Multipath daemon.
• mpathpersist - Manages SCSI persistent reservations on dm multipath devices.
• kpartx - Create device maps from partition tables.

Releases

To get a specific X.Y.Z release, use one of the following method:

Git

git clone https://github.com/opensvc/multipath-tools.git
cd multipath-tools
git tag
git archive --format=tar.gz --prefix=multipath-tools-X.Y.Z/ X.Y.Z > ../multipath-tools-X.Y.Z.tar.gz

Direct download

wget "https://github.com/opensvc/multipath-tools/archive/X.Y.Z.tar.gz" -O multipath-tools-X.Y.Z.tar.gz

Browser

Go to: https://github.com/opensvc/multipath-tools/tags Select a release-tag and then click on "zip" or "tar.gz".

Devel code

To get latest devel code:

git clone -b queue https://github.com/openSUSE/multipath-tools

Building multipath-tools

Prerequisites: development packages of for libdevmapper, libaio, libudev, libjson-c, liburcu, and libsystemd. If commandline editing is enabled (see below), the development package for either libedit or libreadline is required as well.

Then, build and install multipath-tools with:

make
make DESTDIR="/my/target/dir" install

To uninstall, type:

make uninstall

By default, the build will run quietly, just printing one-line messages about the files being built. To enable more verbose output, run make V=1.

Customizing the build

Note: With very few exceptions, the build process does not read configuration from the environment. So using syntax like

SOME_VAR=some_value make

will not have the intended effect. Use the following instead:

make SOME_VAR=some_value

See "Passing standard compiler flags" below for an exception. The following variables can be passed to the make command line:

• V=1: enable verbose build.

• plugindir="/some/path": directory where libmultipath plugins (path checkers, prioritizers, and foreign multipath support) will be looked up. This used to be the run-time option multipath_dir in earlier versions.

• configdir="/some/path" : directory to search for configuration files. This used to be the run-time option config_dir in earlier versions. The default is /etc/multipath/conf.d.

• READLINE=libedit or READLINE=libreadline: enable command line history and TAB completion in the interactive mode (which is entered with multipathd -k or multipathc). The respective development package will be required for building. By default, command line editing is disabled. Note that using libreadline may make binary indistributable due to license incompatibility.

• ENABLE_LIBDMMP=0: disable building libdmmp

• ENABLE_DMEVENTS_POLL=0: disable support for the device-mapper event polling API. For use with pre-5.0 kernels that don't support dmevent polling (but even if you don't use this option, multipath-tools will work with these kernels).

• SCSI_DH_MODULES_PRELOAD="(list)": specify a space-separated list of SCSI device handler kernel modules to load early during boot. Some multipath-tools functionality depends on these modules being loaded early. This option causes a modules-load.d(5) configuration file to be created, thus it depends on functionality provided by systemd. This variable only matters for make install.

  Note: The usefulness of the preload list depends on the kernel configuration. It's especially useful if scsi_mod is builtin but scsi_dh_alua and other device handler modules are built as modules. If scsi_mod itself is compiled as a module, it might make more sense to use a module softdep for the same purpose.

Installation Paths

• prefix: The directory prefix for (almost) all files to be installed. Distributions may want to set this to /usr. Note: for multipath-tools, unlike many other packages, prefix defaults to the empty string, which resolves to the root directory (/).
• usr_prefix: where to install those parts of the code that aren't necessary for booting. You may want to set this to /usr if prefix is empty.
• systemd_prefix: Prefix for systemd-related files. It defaults to /usr. Some systemd installations use separate prefix and rootprefix. On such a distribution, set prefix, and override unitdir to use systemd's rootprefix.
• LIB: the subdirectory under prefix where shared libraries will be installed. By default, the makefile uses /lib64 if this directory is found on the build system, and /lib otherwise.

See also configdir and plugindir above. See Makefile.inc for more fine-grained control.

Compiler Options

Use OPTFLAGS to change optimization-related compiler options; e.g. OPTFLAGS="-g -O0" to disable all optimizations.

Passing standard compiler flags

Contrary to most other variables, the standard variables CFLAGS, CPPFLAGS, and LDFLAGS must be passed to make via the environment if they need to be customized:

CPPFLAGS="-D_SECRET_=secret" make

Special Makefile targets

The following targets are intended for developers only.

• make test to build and run the unit tests
• make valgrind-test to run the unit tests under valgrind
• make abi to create an XML representation of the ABI of the libraries in the abi/ subdirectory
• make abi-test to compare the ABI of a different multipath-tools version, which must be stored in the reference-abi/ subdirectory. If this test fails, the ABI has changed wrt the reference.
• make compile-commands.json to create input for clangd.

Add storage devices

Follow the instructions in the libmultipath/hwtable.c header.

Mailing list

(subscribers-only) To subscribe and archives: https://listman.redhat.com/mailman/listinfo/dm-devel Searchable: https://marc.info/?l=dm-devel

Changelog

pre-0.4.5: https://web.archive.org/web/20070309224034/http://christophe.varoqui.free.fr/wiki/wakka.php?wiki=ChangeLog post-0.4.5: https://github.com/opensvc/multipath-tools/commits/master

Maintainer

Christophe Varoqui [email protected] Device-mapper development mailing list [email protected]

Licence

The multipath-tools source code is covered by several different licences. Refer to the individual source files for details. Source files which do not specify a licence are shipped under LGPL-2.0 (see LICENSES/LGPL-2.0).

ALUA

This is a rough guide, consult your storage device manufacturer documentation.

ALUA is supported in some devices, but usually it's disabled by default. To enable ALUA, the following options should be changed:

• EMC CLARiiON/VNX: "Failover Mode" should be changed to "4" or "Active-Active mode(ALUA)-failover mode 4"

• HPE 3PAR, Primera, and Alletra 9000: "Host:" should be changed to "Generic-ALUA Persona 2 (UARepLun, SESLun, ALUA)".

• Promise VTrak/Vess: "LUN Affinity" and "ALUA" should be changed to "Enable", "Redundancy Type" must be "Active-Active".

• LSI/Engenio/NetApp RDAC class, as NetApp SANtricity E/EF Series and rebranded arrays: "Select operating system:" should be changed to "Linux DM-MP (Kernel 3.10 or later)".

• NetApp ONTAP FAS/AFF Series: To check ALUA state: "igroup show -v <igroup_name>", and to enable ALUA: "igroup set <igroup_name> alua yes".

• Huawei OceanStor: "Host Access Mode" should be changed to "Asymmetric".

NVMe

To use Device Mapper/multipath-tools with NVMe devices, if the Native NVMe Multipath subsystem is enabled ( "Y" in /sys/module/nvme_core/parameters/multipath ), it has to be disabled:

echo "options nvme_core multipath=N" > /etc/modprobe.d/01-nvme_core-mp.conf, regenerate the initramfs (dracut -f or update-initramfs) and reboot.

Check that it is disabled(N) with: cat /sys/module/nvme_core/parameters/multipath or systool -m nvme_core -A multipath