share/man/man4/iser.4

   1 .\" Copyright (c) 2015, Mellanox Technologies, Inc. All rights reserved.
   2 .\"
   3 .\" Redistribution and use in source and binary forms, with or without
   4 .\" modification, are permitted provided that the following conditions
   5 .\" are met:
   6 .\" 1. Redistributions of source code must retain the above copyright
   7 .\"    notice, this list of conditions and the following disclaimer.
   8 .\" 2. Redistributions in binary form must reproduce the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer in the
  10 .\"    documentation and/or other materials provided with the distribution.
  11 .\"
  12 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  13 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  14 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  15 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  16 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  17 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  18 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  19 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  20 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  21 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  22 .\" SUCH DAMAGE.
  23 .\"
  24 .\"
  25 .\" $FreeBSD$
  26 .Dd June 6, 2016
  27 .Dt ISER 4
  28 .Os
  29 .Sh NAME
  30 .Nm iser
  31 .Nd iSCSI Extensions for RDMA (iSER) driver
  32 .Sh SYNOPSIS
  33 To compile this driver into the kernel,
  34 place the following line in the
  35 kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd "device iser"
  38 .Ed
  39 .Pp
  40 Alternatively, to load the driver as a
  41 module at boot time, place the following line in
  42 .Xr loader.conf 5 :
  43 .Bd -literal -offset indent
  44 iser_load="YES"
  45 .Ed
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 (iSCSI Extensions for RDMA) initiator driver extends the iSCSI protocol to RDMA.
  50 It permits data to be transferred directly into and out of SCSI buffers
  51 without intermediate data copies.
  52 iSER uses the RDMA protocol suite to supply higher bandwidth for
  53 block storage transfers (zero copy behavior).
  54 To that fact, it eliminates the
  55 TCP/IP processing overhead while preserving the compatibility with iSCSI protocol.
  56 The initiator is the iSCSI/iSER client, which connects to an iSCSI/iSER target,
  57 providing local access to a remote block device.
  58 The userland component is provided by
  59 .Xr iscsid 8
  60 and both the kernel and userland are configured using
  61 .Xr iscsictl 8 .
  62 .Sh SYSCTL VARIABLES
  63 The following variables are available as both
  64 .Xr sysctl 8
  65 variables and
  66 .Xr loader 8
  67 tunables:
  68 .Bl -tag -width indent
  69 .It Va kern.iser.debug
  70 Verbosity level for log messages from the
  71 .Nm
  72 driver.
  73 Set to 0 to disable logging or 1 to warn about potential problems.
  74 Larger values enable info and debugging output.
  75 Defaults to 0.
  76 .El
  77 .Sh SEE ALSO
  78 .Xr iscsi 4 ,
  79 .Xr iscsi.conf 5 ,
  80 .Xr iscsictl 8 ,
  81 .Xr iscsid 8
  82 .Sh HISTORY
  83 The
  84 .Nm
  85 subsystem first appeared in
  86 .Fx 11.0 .
  87 .Sh AUTHORS
  88 The
  89 .Nm
  90 subsystem was developed by
  91 .An Max Gurtovoy Aq Mt maxg@mellanox.com
  92 and
  93 .An Sagi Grimberg Aq Mt sagig@mellanox.com
  94 under sponsorship from Mellanox Technologies.