share/man/man4/ctl.4

   1 .\" Copyright (c) 2013 Edward Tomasz Napierala
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .Dd August 9, 2015
  27 .Dt CTL 4
  28 .Os
  29 .Sh NAME
  30 .Nm ctl
  31 .Nd CAM Target Layer / iSCSI target
  32 .Sh SYNOPSIS
  33 To compile this driver into the kernel,
  34 place the following line in your
  35 kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd "device iscsi"
  38 .Cd "device ctl"
  39 .Ed
  40 .Pp
  41 Alternatively, to load the driver as a
  42 module at boot time, place the following line in
  43 .Xr loader.conf 5 :
  44 .Bd -literal -offset indent
  45 ctl_load="YES"
  46 .Ed
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 subsystem provides SCSI disk and processor emulation.
  51 It supports features such as:
  52 .Pp
  53 .Bl -bullet -compact
  54 .It
  55 Disk and processor device emulation
  56 .It
  57 Tagged queueing
  58 .It
  59 SCSI task attribute support (ordered, head of queue, simple tags)
  60 .It
  61 SCSI implicit command ordering support
  62 .It
  63 Full task management support (abort, LUN reset, target reset, etc.)
  64 .It
  65 Support for multiple ports
  66 .It
  67 Support for multiple simultaneous initiators
  68 .It
  69 Support for multiple simultaneous backing stores
  70 .It
  71 Support for VMWare VAAI: COMPARE AND WRITE, XCOPY, WRITE SAME,
  72 and UNMAP commands
  73 .It
  74 Support for Microsoft ODX: POPULATE TOKEN/WRITE USING TOKEN,
  75 WRITE SAME, and UNMAP commands
  76 .It
  77 Persistent reservation support
  78 .It
  79 Mode sense/select support
  80 .It
  81 Error injection support
  82 .It
  83 All I/O handled in-kernel, no userland context switch overhead
  84 .El
  85 .Pp
  86 It also serves as a kernel component of the native iSCSI target.
  87 .Sh SYSCTL VARIABLES
  88 The following variables are available as both
  89 .Xr sysctl 8
  90 variables and
  91 .Xr loader 8
  92 tunables:
  93 .Bl -tag -width indent
  94 .It Va kern.cam.ctl.debug
  95 Bit mask of enabled CTL log levels:
  96 .Bl -tag -offset indent -compact
  97 .It 1
  98 log commands with errors;
  99 .It 2
 100 log all commands;
 101 .It 4
 102 log received data for commands except READ/WRITE.
 103 .El
 104 Defaults to 0.
 105 .It Va kern.cam.ctl.iscsi.debug
 106 Verbosity level for log messages from the kernel part of iSCSI target.
 107 Set to 0 to disable logging or 1 to warn about potential problems.
 108 Larger values enable debugging output.
 109 Defaults to 1.
 110 .It Va kern.cam.ctl.iscsi.maxcmdsn_delta
 111 The number of outstanding commands to advertise to the iSCSI initiator.
 112 Technically, it is the difference between ExpCmdSN and MaxCmdSN fields
 113 in the iSCSI PDU.
 114 Defaults to 256.
 115 .It Va kern.cam.ctl.iscsi.ping_timeout
 116 The number of seconds to wait for the iSCSI initiator to respond to a NOP-In
 117 PDU.
 118 In the event that there is no response within that time the session gets
 119 forcibly terminated.
 120 Set to 0 to disable sending NOP-In PDUs.
 121 Defaults to 5.
 122 .El
 123 .Sh SEE ALSO
 124 .Xr ctladm 8 ,
 125 .Xr ctld 8 ,
 126 .Xr ctlstat 8
 127 .Sh HISTORY
 128 The
 129 .Nm
 130 subsystem first appeared in
 131 .Fx 9.1 .
 132 .Sh AUTHORS
 133 The
 134 .Nm
 135 subsystem was written by
 136 .An Kenneth Merry Aq Mt ken@FreeBSD.org .