Documentation/filesystems/smb/smbdirect.rst

Source file repositories/reference/linux-study-clean/Documentation/filesystems/smb/smbdirect.rst

File Facts

System
Linux kernel
Corpus path
Documentation/filesystems/smb/smbdirect.rst
Extension
.rst
Size
3194 bytes
Lines
104
Domain
Support Tooling And Documentation
Bucket
Documentation
Inferred role
Support Tooling And Documentation: documentation
Status
atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

Detected Declarations

Annotated Snippet

.. SPDX-License-Identifier: GPL-2.0

===========================
SMB Direct - SMB3 over RDMA
===========================

This document describes how to set up the Linux SMB client and server to
use RDMA.

Overview
========
The Linux SMB kernel client supports SMB Direct, which is a transport
scheme for SMB3 that uses RDMA (Remote Direct Memory Access) to provide
high throughput and low latencies by bypassing the traditional TCP/IP
stack.
SMB Direct on the Linux SMB client can be tested against KSMBD - a
kernel-space SMB server.

Installation
=============
- Install an RDMA device. As long as the RDMA device driver is supported
  by the kernel, it should work. This includes both software emulators (soft
  RoCE, soft iWARP) and hardware devices (InfiniBand, RoCE, iWARP).

- Install a kernel with SMB Direct support. The first kernel release to
  support SMB Direct on both the client and server side is 5.15. Therefore,
  a distribution compatible with kernel 5.15 or later is required.

- Install cifs-utils, which provides the `mount.cifs` command to mount SMB
  shares.

- Configure the RDMA stack

  Make sure that your kernel configuration has RDMA support enabled. Under
  Device Drivers -> Infiniband support, update the kernel configuration to
  enable Infiniband support.

  Enable the appropriate IB HCA support or iWARP adapter support,
  depending on your hardware.

  If you are using InfiniBand, enable IP-over-InfiniBand support.

  For soft RDMA, enable either the soft iWARP (`RDMA _SIW`) or soft RoCE
  (`RDMA_RXE`) module. Install the `iproute2` package and use the
  `rdma link add` command to load the module and create an
  RDMA interface.

  e.g. if your local ethernet interface is `eth0`, you can use:

    .. code-block:: bash

        sudo rdma link add siw0 type siw netdev eth0

- Enable SMB Direct support for both the server and the client in the kernel
  configuration.

    Server Setup

    .. code-block:: text

        Network File Systems  --->
            <M> SMB3 server support
                [*] Support for SMB Direct protocol

    Client Setup

    .. code-block:: text

        Network File Systems  --->
            <M> SMB3 and CIFS support (advanced network filesystem)

Annotation

Implementation Notes