The Linux SCSI Target Wiki
|Original author(s)||Nicholas Bellinger|
|Initial release||January 14, 2011|
|Stable release||4.1.0 / June 20, 2012|
|Preview release||4.2.0-rc5 / June 28, 2012|
|License||GNU General Public License, version 2 (GPLv2)|
Linux-IO Target is based on a SCSI engine that implements the semantics of a SCSI target as described in the SCSI Architecture Model (SAM), and supports its comprehensive SPC-3/SPC-4 feature set in a fabric-agnostic way. The SCSI target core does not directly communicate with initiators and it does not directly access data on disk.
targetcli provides a comprehensive, powerful and easy CLI tool to configure and manage LIO. targetcli was developed by Datera.
Fabric modules implement the "frontend" of the SCSI target. They "speak" specific protocols that transport SCSI commands. The Fabric Hardware Abstraction Layer (F-HAL) allows all protocol-specific processing to be encapsulated in fabric modules. The following fabric modules are available:
- Fibre Channel: SCSI access over FC networks with QLogic HBAs (qla2xxx.ko, released).
- Fibre Channel over Ethernet (FCoE): FC access over Ethernet (tcm_fc.ko, released).
- FireWire: SCSI access over FireWire / iEEE 1394 networks (sbp.ko, released).
- IBM vSCSI: IBM virtual SCSI (vSCSI) module for IBM System p (ibmvscsis.ko, RC).
- iSCSI: SCSI access over IP networks (iscsi.ko, released).
- iSER: iSCSI access over InfiniBand networks with Mellanox HCAs (ib_sert.ko, released)
- SRP: SCSI access over InfiniBand networks with Mellanox HCAs (srpt.ko, released).
- tcm_loop: SCSI emulation device to serve any type of raw hardware to local applications and VMs as a fully SCSI SPC-4 compliant block device, including emulation of advanced functionality (loopback.ko, released).
- USB Gadget: SCSI access over USB networks (tcm_usb_gadget.ko, released).
- vHost: QEMU virtio and virtio-scsi PV guests (tcm_vhost.ko, released).
Backstores implement the LIO "backend". They implement the methods of accessing data on disk. A backstore subsystem plugin is a physical storage object that provides the block device underlying a SCSI Endpoint.
Backstore objects can be added via the Storage Hardware Abstraction Layer (S-HAL) that brings storage hardware into LIO engine as raw block devices, on which the Linux stack just works (including complex functionality such as software RAID, LVM, snapshots, virtualization, etc.).
LIO supports the SCSI-3 standard for all backstore devices (block devices and/or VFS):
- FILEIO (Linux VFS devices): any file on a mounted filesystem. It may be backed by a file or an underlying real block device. FILEIO is using struct file to serve block I/O with various methods (synchronous or asynchronous) and (buffered or direct). The Linux kernel code for filesystems resides in linux/fs. By default, FILEIO uses non-buffered mode (
| Do not use buffered FILEIO
Creating a FILEIO backend with buffered=True enables the buffer cache. While this can provide significant performance increases, it also creates a serious data integrity hazard: If the system crashes for any reason, unflushed data in the buffer cache can cause the entire backstore to be irrecoverably corrupted. Use RTS OS with robust flash caching instead.
- IBLOCK (Linux BLOCK devices): any block device that appears in /sys/block. The Linux kernel code for block devices is in linux/block.
| Recommended for performance
IBLOCK backstores usually provide the best performance.
- PSCSI (Linux pass-through SCSI devices): any storage object that supports direct pass-through of SCSI commands without SCSI emulation. This assumes an underlying SCSI device that appears with lsscsi in /proc/scsi/scsi, such as a SAS hard drive, etc. SCSI-3 and higher is supported with this subsystem, but only for control CDBs capable by the device firmware.
| Do not use PSCSI
Do not use PSCSI unless you know exactly how it will be used. Advanced SCSI CDBs such as for Persistent Reservations or ALUAs (used e.g. by VMware ESX and vSphere) are typically not implemented in the device firmware, and can cause malfunctions or crashes. Use IBLOCK for production setups instead.
- Memory Copy RAMDISK (Linux RAMDISK_MCP): Memory Copy ram disks (rd_mcp) provide ram disks with full SCSI emulation and separate memory mappings using memory copy for initiators, thus providing multi-session capability. This is most useful for fast volatile mass storage for production.
SCSI functionality is implemented directly in the LIO engine in a fabric-agnostic way, including a number of high-end features, such as Persistent Reservations (PRs), Asymmetric Logical Unit Assignment (ALUA), vStorage APIs for Array Integration (VAAI) following the SPC-4 standard.
The backstore devices (FILEIO, IBLOCK, pSCSI, RAMDISK, etc.) report the underlying HW limitiations for things like TCQ depth, MaxSectors, TaskAbortedStatus, UA Interlocking, etc. All of these values are available as attributes in the targetcli device context.
The following specifications are available as T10 Working Drafts:
- SCSI Architecture Model - 2 (SAM-2): SAM-2 describes the second generation of the SCSI Architecture Model. Status: Published, 2002-09-11
- SCSI Architecture Model - 3 (SAM-3): SAM-3 describes the third generation of the SCSI Architecture Model. Status: Published, 2004-09-21
- SCSI Architecture Model - 4 (SAM-4): SAM-4 describes the fourth generation of the SCSI Architecture Model. Status: Published, 2008-05-08
- SCSI Primary Commands - 2 (SPC-2): contains the second-generation definition of the basic commands for all SCSI devices. SPC-2 is used in conjuction with a standard for the specific device type. In 2006, the ANSI SPC-2 standard was replaced with ISO/IEC 14776-452:2005, which is available through ANSI. Status: Published, 2001-07-18
- SCSI Primary Commands - 3 (SPC-3): contains the third-generation definition of the basic commands for all SCSI devices. SPC-3 is used in conjuction with a standard for the specific device type. Status: Published, 2005-05-04
- SCSI Primary Commands - 4 (SPC-4): contains the fourth-generation definition of the basic commands for all SCSI devices. SPC-4 is used in conjuction with a standard for the specific device type. Status: Development, 2010-11-16
- Small Computer System Interface - 2 (SCSI-2): SCSI-2 defines the second generation of the Small Computer System Interface. Status: Published, 1993-09-07
- Access Control List (ACL): Used to specify the access rights for Initiators to TPGs.
- Backstore: A physical storage object that provides the actual storage underlying an SCSI Endpoint.
- Command Descriptor Block (CDB): The standard format for SCSI commands. CDBs are commonly 6, 10, or 12 bytes long, though they can be 16 bytes or of variable length.
- Challenge Handshake Authentication Protocol (CHAP): An authentication technique for confirming the identity of one computer to another. Described in RFC 1994.
- Connection Identifier (CID): A 16-bit number, generated by the Initiator, that uniquely identifies a connection between two iSCSI devices. This number is presented during the login phase.
- Endpoint: The combination of an iSCSI TargetName with an iSCSI TPG Tag (IQN + Tag).
- Converged Network Adapter (CNA): An Ethernet PCIe network adapter (NIC) that natively supports RDMA (via RoCE), also called RNIC.
- Demo Mode: Means disabling authentification for an iSCSI Endpoint, i.e. its ACLs are diabled. Demo Mode grants read-only access to all iSCSI Initiators that attempt to connect to that specific Endpoint. See the iSCSI entry on how to enable Demo Mode.
- Extended Unique Identifier (EUI): A 64-bit number that uniquely identifies every device in the world. The format consists of 24 bits that are unique to a given company, and 40 bits assigned by the company to each device it builds.
- I_T Nexus: An I_T Nexus denotes a live session between an Initiator and a target.
- Initiator: The originating end of a SCSI session. Typically a controlling device such as a computer.
- Internet Protocol Storage (IPS): The class of protocols or devices that use the IP protocol to move data in a storage network. FCIP, iFCP, and iSCSI are all examples of IPS protocols.
- iSCSI Qualified Name (IQN): A name format for iSCSI that uniquely identifies every device in the world (e.g. iqn.5886.com.acme.tapedrive.sn-a12345678).
- Initiator Session Identifier (ISID): A 48-bit number, generated by the Initiator, that uniquely identifies a session between the Initiator and the target. This value is created during the login process, and is sent to the target with a Login PDU.
- Multipath I/O (MPIO): A method by which data can take multiple redundant paths between a server and storage.
- Network Portal: The combination of an iSCSI Endpoint with an IP address plus a TCP port. The TCP port number for the iSCSI protocol defined by IANA is 3260.
- Network Interface Card (NIC): An Ethernet PCIe network adapter.
- Non-Transparent Bridging (NTB): Non-transparent bridges in PCI systems support intelligent adapters in enterprise systems and multiple processors in embedded systems. The Intel DrawBridge established the paradigm of the embedded bridge and became a defacto standard in such environments as Compact PCI and intelligent adapters for enterprise systems. In these systems, the non-transparent bridge functions as a gateway between the local subsystem and the backplane.
- Organizationally Unique Identifier (OUI) is a 24-bit number that is purchased from the IEEE Registration Authority. This identifier uniquely identifies a vendor, manufacturer, or other organization (referred to by the IEEE as the “assignee”) globally or worldwide and effectively reserves a block of each possible type of derivative identifier (such as MAC addresses, group addresses, Subnetwork Access Protocol protocol identifiers, etc.) for the exclusive use of the assignee, see OUI Wikipedia entry. The OUI is subsequently used by the assignee to create particular instances of these identifiers for various purposes, such as the identification of a particular piece of equipment.
- RDMA NIC (RNIC): An Ethernet PCIe network adapter (NIC) that natively supports RDMA (via RoCE), also called CNA.
- SCSI Architectural Model (SAM): A document that describes the behavior of SCSI in general terms, allowing for different types of devices communicating over various media.
- SCSI Target: The receiving end of a SCSI session, typically a device such as a disk drive, solid state drive, tape drive, or scanner.
- Target Group: A collection of fabric module SCSI target endpoints containing SCSI target ports that provide access to individual storage objects.
- Target Port: The combination of an iSCSI Endpoint with one or more LUNs.
- TCP/IP Offload Engine (TOE): An enhanced NIC that runs a full TCP/IP stack independent from the main CPU and OS.
- Target Portal Group (TPG): A list of IP addresses and TCP port numbers that determines which interfaces a specific iSCSI target will listen to.
- Target Session Identifier (TSID): A 16-bit number, generated by the target, that uniquely identifies a session between the initiator and the target. This value is created during the login process, and is sent to the initiator with a Login Response PDU.
- World Wide Name (WWN) or World Wide Identifier (WWID) is a unique identifier which identifies a particular Fibre Channel, ATA or SAS target. Each WWN is an 8 byte number derived from an IEEE OUI and vendor-supplied information, see also WWN Wikipedia entry. There are two formats of WWN defined by the IEEE:
- Original format: addresses are assigned to manufacturers by the IEEE standards committee, and are built into the device at build time, similar to an Ethernet MAC address. The first 2 bytes are either hex 10:00 or 2x:xx (where the x's are vendor-specified) followed by the 3-byte vendor identifier and 3 bytes for a vendor-specified serial number
- New addressing schema: the first nibble is either hex 5 or 6 followed by a 3-byte vendor identifier and 36 bits for a vendor-specified serial number
Inclusion in Linux distributions
LIO and targetcli are included in most Linux distributions per default. Here is an overview over the most popular distributions:
|Distribution||Version[Linux 1]||Release||Archive||Install||Source git[Linux 2]||Documentation|
|CentOS||6.2||2011-12-20||CentOS mirror||su -c 'yum install fcoe-target-utils'||targetcli-fb.git||Tech Notes|
|Debian||7.0 ("wheezy")||TBA||Debian pool||su -c 'apt-get install targetcli'||targetcli|
|Fedora||16, 17/18||2011-11-08||Fedora Rawhide||su -c 'yum install targetcli'||targetcli-fb.git||Target Wiki|
|openSUSE||12.1||2011-11-08||Requires manual installation from targetcli.|
|RHEL||6.2||2011-11-16||Fedora Rawhide||su -c 'yum install fcoe-target-utils'||targetcli-fb.git||Tech Notes|
|Scientific Linux||6.2||2012-02-16||SL Mirror||su -c 'yum install fcoe-target-utils'||targetcli-fb.git||Tech Notes|
|SLES||SP2||2012-02-15||Requires manual installation from targetcli.|
|Ubuntu||PrecisePangolin v12||2012-04-26||Ubuntu universe||su -c 'apt-get install targetcli'||targetcli|
- ↑ The distribution release where LIO was included first.
- ↑ Technical support, and qualified backports to other kernels and distributions are available from Datera.
LIO and fabric modules have gone upstream into the Linux kernel as follows:
- Linux 2.6.38 (2011-03-14): LIO engine
- Linux 2.6.39 (2011-05-18): tcm_loop (SCSI support on top of any raw hardware)
- Linux 3.0 (2011-07-21): FCoE (by Cisco)
- Linux 3.1 (2011-10-24): iSCSI
- Linux 3.3 (2012-03-18): InfiniBand/SRP (Mellanox HCAs)
- Linux 3.5 (2012-07-21): Fibre Channel (QLogic HBAs), USB Gadget and IEEE 1394
- Linux 3.6 (2012-10-01): vHost (QEMU virtio and virtio-scsi PV guests)
- Linux 3.9 (2013-04-28): 16 GFC (QLogic HBAs)
- Linux 3.10 (2013-06-30): InfiniBand/iSER (Mellanox HCAs and CNAs)
- Linux 3.12 (2013-11-03): VAAI
- Linux 3.14 (planned): T10 DIF, T10 Referrals, user-space backend
- Linux 3.15 (planned): Mellanox FCoE support
- Fabrics: ATA over Ethernet (AoE), FibreChannel over Ethernet (FCoE), FibreChannel (FC), InfiniBand (IB), iSCSI, iSCSI Extensions for RDMA (iSER), Internet Wide Area RDMA Protocol (iWARP), and SCSI RDMA Protocol (SRP)
- Services: Service Location Protocol (SLP), Internet Storage Name Service (iSNS)
- Other: Storage Area Network (SAN), Serial attached SCSI (SAS), World Wide Name (WWN)
If you need assistance, or if you have an SLA with Datera, please contact the company at:
- Phone (US): +1.650.384.6366 (US)
- Phone (EMEA): +49.151.54354373 (EMEA)
- Email: email@example.com
- Web: daterainc.com
Please see Support for more information.
- RTS OS, targetcli
- Fabric modules: FCoE, Fibre Channel, IBM vSCSI, iSCSI, iSER, SRP, vHost
- Distributions: RHEL 4/5/6, SLES11, CentOS, Debian, Fedora, openSUSE, Ubuntu, etc.
- Platforms: PC architecture (x86/ia64), PlayStation 2 and PlayStation 3 (Cell), etc.
- Low level kernel API: configFS
- Standards: SCSI
- ↑ Thorsten Leemhuis (2011-03-02). "Kernel Log: Coming in 2.6.38 (Part 4) - Storage". Heise Online.
- ↑ Jonathan Corbet (2010-12-22). "Shooting at SCSI targets". lnw.net.
- ↑ Linus Torvalds (2011-03-14). "Linux 2.6.38". lkml.org.
- ↑ Mark J. Sullivan (January 2010). Intel® Xeon® Processor C5500/C3500 Series Non-Transparent Bridge. 323328-001. Santa Clara: Intel.
- ↑ Linus Torvalds (2011-03-14). "Linux 2.6.38". lkml.org.
- ↑ Linus Torvalds (2011-01-14). "Target merge". lkml.org.
- ↑ Linus Torvalds (2011-05-18). "Linux 2.6.39". lkml.org.
- ↑ Linus Torvalds (2011-07-21). "Linux 3.0". lkml.org.
- ↑ Linus Torvalds (2011-10-24). "Linux 3.1". lkml.org.
- ↑ Linus Torvalds (2011-07-27). "iSCSI merge". lkml.org.
- ↑ Linus Torvalds (2012-03-18). "Linux 3.3 release". lkml.org.
- ↑ Linus Torvalds (2012-01-18). "InfiniBand/SRP merge". lkml.org.
- ↑ Linus Torvalds (2012-07-21). "Linux 3.5 released". marc.info.
- ↑ Linus Torvalds (2012-05-31). "scsi-misc". lkml.org.
- ↑ Linus Torvalds (2012-05-22). "usb-target-merge". lkml.org.
- ↑ Linus Torvalds (2012-05-23). "sbp-target-merge". lkml.org.
- ↑ Linus Torvalds (2012-10-01). "Linux 3.6". lkml.org.
- ↑ Linus Torvalds (2012-08-13). "tcm_vhost: Initial merge for vhost level target fabric driver". lkml.org.
- ↑ Linus Torvalds (2013-04-28). "Linux 3.9 released". lkml.org.
- ↑ Linus Torvalds (2013-06-30). "Linux 3.10". marc.org.
- ↑ Linus Torvalds (2013-11-03). "Linux 3.12 released..". lkml.org.
- LIO Wikipedia entries: German English
- RTS OS Admin Manual
- RTSlib Reference Guide [HTML][PDF]
- Adapters by SCSI connector type
- Anatomy of the Linux SCSI subsystem
- Organizationally Unique Identifier (OUI) Wikipedia entry
- SCSI Wikipedia entry
- SCSI Tutorial
- SCSI/iSCSI/RAID/SAS Information Sheet
- T10 Technical Committee (SCSI standards)
- T10 Technical Committee - Protocols and Physical Layers
- T10 Primary Commands (SPC): using SPC-3/4
- T10 Block Commands (SBC) using SBC-3
- wetpaint.com Fun storage stuff (Ming Zhang)
|History of the Linux-IO Target|
|Feature||Target Core||Loop back||FCoE||iSCSI||Perf|| SRP||CM WQ|| FC|