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 October 23, 2014
  27 .Dt CTL 4
  28 .Os
  29 .Sh NAME
  30 .Nm ctl
  31 .Nd CAM Target Layer
  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 ctl"
  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 ctl_load="YES"
  45 .Ed
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 subsystem provides SCSI disk and processor emulation.
  50 It supports features such as:
  51 .Pp
  52 .Bl -bullet -compact
  53 .It
  54 Disk and processor device emulation
  55 .It
  56 Tagged queueing
  57 .It
  58 SCSI task attribute support (ordered, head of queue, simple tags)
  59 .It
  60 SCSI implicit command ordering support
  61 .It
  62 Full task management support (abort, LUN reset, target reset, etc.)
  63 .It
  64 Support for multiple ports
  65 .It
  66 Support for multiple simultaneous initiators
  67 .It
  68 Support for multiple simultaneous backing stores
  69 .It
  70 Support for VMWare VAAI: COMPARE AND WRITE, XCOPY, WRITE SAME,
  71 and UNMAP commands
  72 .It
  73 Support for Microsoft ODX: POPULATE TOKEN/WRITE USING TOKEN,
  74 WRITE SAME, and UNMAP commands
  75 .It
  76 Persistent reservation support
  77 .It
  78 Mode sense/select support
  79 .It
  80 Error injection support
  81 .It
  82 All I/O handled in-kernel, no userland context switch overhead
  83 .El
  84 .Pp
  85 It also serves as a kernel component of the native iSCSI target.
  86 .Sh SEE ALSO
  87 .Xr ctladm 8 ,
  88 .Xr ctld 8 ,
  89 .Xr ctlstat 8
  90 .Sh HISTORY
  91 The
  92 .Nm
  93 subsystem first appeared in
  94 .Fx 9.1 .
  95 .Sh AUTHORS
  96 The
  97 .Nm
  98 subsystem was written by
  99 .An Kenneth Merry Aq ken@FreeBSD.org .