d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
b0529e0a2d
freebsd-nq/sys/cam/ctl/ctl_util.c

876 lines
22 KiB
C
Raw Normal View History

Add the CAM Target Layer (CTL). CTL is a disk and processor device emulation subsystem originally written for Copan Systems under Linux starting in 2003. It has been shipping in Copan (now SGI) products since 2005. It was ported to FreeBSD in 2008, and thanks to an agreement between SGI (who acquired Copan's assets in 2010) and Spectra Logic in 2010, CTL is available under a BSD-style license. The intent behind the agreement was that Spectra would work to get CTL into the FreeBSD tree. Some CTL features: - Disk and processor device emulation. - Tagged queueing - SCSI task attribute support (ordered, head of queue, simple tags) - SCSI implicit command ordering support. (e.g. if a read follows a mode select, the read will be blocked until the mode select completes.) - Full task management support (abort, LUN reset, target reset, etc.) - Support for multiple ports - Support for multiple simultaneous initiators - Support for multiple simultaneous backing stores - Persistent reservation support - Mode sense/select support - Error injection support - High Availability support (1) - All I/O handled in-kernel, no userland context switch overhead. (1) HA Support is just an API stub, and needs much more to be fully functional. ctl.c: The core of CTL. Command handlers and processing, character driver, and HA support are here. ctl.h: Basic function declarations and data structures. ctl_backend.c, ctl_backend.h: The basic CTL backend API. ctl_backend_block.c, ctl_backend_block.h: The block and file backend. This allows for using a disk or a file as the backing store for a LUN. Multiple threads are started to do I/O to the backing device, primarily because the VFS API requires that to get any concurrency. ctl_backend_ramdisk.c: A "fake" ramdisk backend. It only allocates a small amount of memory to act as a source and sink for reads and writes from an initiator. Therefore it cannot be used for any real data, but it can be used to test for throughput. It can also be used to test initiators' support for extremely large LUNs. ctl_cmd_table.c: This is a table with all 256 possible SCSI opcodes, and command handler functions defined for supported opcodes. ctl_debug.h: Debugging support. ctl_error.c, ctl_error.h: CTL-specific wrappers around the CAM sense building functions. ctl_frontend.c, ctl_frontend.h: These files define the basic CTL frontend port API. ctl_frontend_cam_sim.c: This is a CTL frontend port that is also a CAM SIM. This frontend allows for using CTL without any target-capable hardware. So any LUNs you create in CTL are visible in CAM via this port. ctl_frontend_internal.c, ctl_frontend_internal.h: This is a frontend port written for Copan to do some system-specific tasks that required sending commands into CTL from inside the kernel. This isn't entirely relevant to FreeBSD in general, but can perhaps be repurposed. ctl_ha.h: This is a stubbed-out High Availability API. Much more is needed for full HA support. See the comments in the header and the description of what is needed in the README.ctl.txt file for more details. ctl_io.h: This defines most of the core CTL I/O structures. union ctl_io is conceptually very similar to CAM's union ccb. ctl_ioctl.h: This defines all ioctls available through the CTL character device, and the data structures needed for those ioctls. ctl_mem_pool.c, ctl_mem_pool.h: Generic memory pool implementation used by the internal frontend. ctl_private.h: Private data structres (e.g. CTL softc) and function prototypes. This also includes the SCSI vendor and product names used by CTL. ctl_scsi_all.c, ctl_scsi_all.h: CTL wrappers around CAM sense printing functions. ctl_ser_table.c: Command serialization table. This defines what happens when one type of command is followed by another type of command. ctl_util.c, ctl_util.h: CTL utility functions, primarily designed to be used from userland. See ctladm for the primary consumer of these functions. These include CDB building functions. scsi_ctl.c: CAM target peripheral driver and CTL frontend port. This is the path into CTL for commands from target-capable hardware/SIMs. README.ctl.txt: CTL code features, roadmap, to-do list. usr.sbin/Makefile: Add ctladm. ctladm/Makefile, ctladm/ctladm.8, ctladm/ctladm.c, ctladm/ctladm.h, ctladm/util.c: ctladm(8) is the CTL management utility. It fills a role similar to camcontrol(8). It allow configuring LUNs, issuing commands, injecting errors and various other control functions. usr.bin/Makefile: Add ctlstat. ctlstat/Makefile ctlstat/ctlstat.8, ctlstat/ctlstat.c: ctlstat(8) fills a role similar to iostat(8). It reports I/O statistics for CTL. sys/conf/files: Add CTL files. sys/conf/NOTES: Add device ctl. sys/cam/scsi_all.h: To conform to more recent specs, the inquiry CDB length field is now 2 bytes long. Add several mode page definitions for CTL. sys/cam/scsi_all.c: Handle the new 2 byte inquiry length. sys/dev/ciss/ciss.c, sys/dev/ata/atapi-cam.c, sys/cam/scsi/scsi_targ_bh.c, scsi_target/scsi_cmds.c, mlxcontrol/interface.c: Update for 2 byte inquiry length field. scsi_da.h: Add versions of the format and rigid disk pages that are in a more reasonable format for CTL. amd64/conf/GENERIC, i386/conf/GENERIC, ia64/conf/GENERIC, sparc64/conf/GENERIC: Add device ctl. i386/conf/PAE: The CTL frontend SIM at least does not compile cleanly on PAE. Sponsored by: Copan Systems, SGI and Spectra Logic MFC after: 1 month
2012-01-12 00:34:33 +00:00
/*-
* Copyright (c) 2003 Silicon Graphics International Corp.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions, and the following disclaimer,
* without modification.
* 2. Redistributions in binary form must reproduce at minimum a disclaimer
* substantially similar to the "NO WARRANTY" disclaimer below
* ("Disclaimer") and any redistribution must be conditioned upon
* including a substantially similar Disclaimer requirement for further
* binary redistribution.
*
* NO WARRANTY
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGES.
*
* $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_util.c#2 $
*/
/*
* CAM Target Layer SCSI library
*
* Author: Ken Merry <ken@FreeBSD.org>
*/
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
#ifdef _KERNEL
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/types.h>
#include <sys/malloc.h>
#else /* __KERNEL__ */
#include <sys/types.h>
#include <sys/time.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#endif /* __KERNEL__ */
#include <sys/sbuf.h>
#include <sys/queue.h>
#include <sys/callout.h>
#include <cam/scsi/scsi_all.h>
#include <cam/ctl/ctl_io.h>
#include <cam/ctl/ctl_scsi_all.h>
#include <cam/ctl/ctl_util.h>
struct ctl_status_desc {
ctl_io_status status;
const char *description;
};
struct ctl_task_desc {
ctl_task_type task_action;
const char *description;
};
static struct ctl_status_desc ctl_status_table[] = {
{CTL_STATUS_NONE, "No Status"},
{CTL_SUCCESS, "Command Completed Successfully"},
{CTL_CMD_TIMEOUT, "Command Timed Out"},
{CTL_SEL_TIMEOUT, "Selection Timeout"},
{CTL_ERROR, "Command Failed"},
{CTL_SCSI_ERROR, "SCSI Error"},
{CTL_CMD_ABORTED, "Command Aborted"},
};
static struct ctl_task_desc ctl_task_table[] = {
{CTL_TASK_ABORT_TASK, "Abort Task"},
{CTL_TASK_ABORT_TASK_SET, "Abort Task Set"},
{CTL_TASK_CLEAR_ACA, "Clear ACA"},
{CTL_TASK_CLEAR_TASK_SET, "Clear Task Set"},
Implement ABORT TASK SET and I_T NEXUS RESET task management functions. Use the last one to terminate active commands on iSCSI session termination. Previous code was aborting only commands doing some data moves.
2014-07-07 03:10:56 +00:00
{CTL_TASK_I_T_NEXUS_RESET, "I_T Nexus Reset"},
Add the CAM Target Layer (CTL). CTL is a disk and processor device emulation subsystem originally written for Copan Systems under Linux starting in 2003. It has been shipping in Copan (now SGI) products since 2005. It was ported to FreeBSD in 2008, and thanks to an agreement between SGI (who acquired Copan's assets in 2010) and Spectra Logic in 2010, CTL is available under a BSD-style license. The intent behind the agreement was that Spectra would work to get CTL into the FreeBSD tree. Some CTL features: - Disk and processor device emulation. - Tagged queueing - SCSI task attribute support (ordered, head of queue, simple tags) - SCSI implicit command ordering support. (e.g. if a read follows a mode select, the read will be blocked until the mode select completes.) - Full task management support (abort, LUN reset, target reset, etc.) - Support for multiple ports - Support for multiple simultaneous initiators - Support for multiple simultaneous backing stores - Persistent reservation support - Mode sense/select support - Error injection support - High Availability support (1) - All I/O handled in-kernel, no userland context switch overhead. (1) HA Support is just an API stub, and needs much more to be fully functional. ctl.c: The core of CTL. Command handlers and processing, character driver, and HA support are here. ctl.h: Basic function declarations and data structures. ctl_backend.c, ctl_backend.h: The basic CTL backend API. ctl_backend_block.c, ctl_backend_block.h: The block and file backend. This allows for using a disk or a file as the backing store for a LUN. Multiple threads are started to do I/O to the backing device, primarily because the VFS API requires that to get any concurrency. ctl_backend_ramdisk.c: A "fake" ramdisk backend. It only allocates a small amount of memory to act as a source and sink for reads and writes from an initiator. Therefore it cannot be used for any real data, but it can be used to test for throughput. It can also be used to test initiators' support for extremely large LUNs. ctl_cmd_table.c: This is a table with all 256 possible SCSI opcodes, and command handler functions defined for supported opcodes. ctl_debug.h: Debugging support. ctl_error.c, ctl_error.h: CTL-specific wrappers around the CAM sense building functions. ctl_frontend.c, ctl_frontend.h: These files define the basic CTL frontend port API. ctl_frontend_cam_sim.c: This is a CTL frontend port that is also a CAM SIM. This frontend allows for using CTL without any target-capable hardware. So any LUNs you create in CTL are visible in CAM via this port. ctl_frontend_internal.c, ctl_frontend_internal.h: This is a frontend port written for Copan to do some system-specific tasks that required sending commands into CTL from inside the kernel. This isn't entirely relevant to FreeBSD in general, but can perhaps be repurposed. ctl_ha.h: This is a stubbed-out High Availability API. Much more is needed for full HA support. See the comments in the header and the description of what is needed in the README.ctl.txt file for more details. ctl_io.h: This defines most of the core CTL I/O structures. union ctl_io is conceptually very similar to CAM's union ccb. ctl_ioctl.h: This defines all ioctls available through the CTL character device, and the data structures needed for those ioctls. ctl_mem_pool.c, ctl_mem_pool.h: Generic memory pool implementation used by the internal frontend. ctl_private.h: Private data structres (e.g. CTL softc) and function prototypes. This also includes the SCSI vendor and product names used by CTL. ctl_scsi_all.c, ctl_scsi_all.h: CTL wrappers around CAM sense printing functions. ctl_ser_table.c: Command serialization table. This defines what happens when one type of command is followed by another type of command. ctl_util.c, ctl_util.h: CTL utility functions, primarily designed to be used from userland. See ctladm for the primary consumer of these functions. These include CDB building functions. scsi_ctl.c: CAM target peripheral driver and CTL frontend port. This is the path into CTL for commands from target-capable hardware/SIMs. README.ctl.txt: CTL code features, roadmap, to-do list. usr.sbin/Makefile: Add ctladm. ctladm/Makefile, ctladm/ctladm.8, ctladm/ctladm.c, ctladm/ctladm.h, ctladm/util.c: ctladm(8) is the CTL management utility. It fills a role similar to camcontrol(8). It allow configuring LUNs, issuing commands, injecting errors and various other control functions. usr.bin/Makefile: Add ctlstat. ctlstat/Makefile ctlstat/ctlstat.8, ctlstat/ctlstat.c: ctlstat(8) fills a role similar to iostat(8). It reports I/O statistics for CTL. sys/conf/files: Add CTL files. sys/conf/NOTES: Add device ctl. sys/cam/scsi_all.h: To conform to more recent specs, the inquiry CDB length field is now 2 bytes long. Add several mode page definitions for CTL. sys/cam/scsi_all.c: Handle the new 2 byte inquiry length. sys/dev/ciss/ciss.c, sys/dev/ata/atapi-cam.c, sys/cam/scsi/scsi_targ_bh.c, scsi_target/scsi_cmds.c, mlxcontrol/interface.c: Update for 2 byte inquiry length field. scsi_da.h: Add versions of the format and rigid disk pages that are in a more reasonable format for CTL. amd64/conf/GENERIC, i386/conf/GENERIC, ia64/conf/GENERIC, sparc64/conf/GENERIC: Add device ctl. i386/conf/PAE: The CTL frontend SIM at least does not compile cleanly on PAE. Sponsored by: Copan Systems, SGI and Spectra Logic MFC after: 1 month
2012-01-12 00:34:33 +00:00
{CTL_TASK_LUN_RESET, "LUN Reset"},
{CTL_TASK_TARGET_RESET, "Target Reset"},
{CTL_TASK_BUS_RESET, "Bus Reset"},
{CTL_TASK_PORT_LOGIN, "Port Login"},
{CTL_TASK_PORT_LOGOUT, "Port Logout"}
};
void
ctl_scsi_tur(union ctl_io *io, ctl_tag_type tag_type, uint8_t control)
{
struct ctl_scsiio *ctsio;
struct scsi_test_unit_ready *cdb;
ctl_scsi_zero_io(io);
io->io_hdr.io_type = CTL_IO_SCSI;
ctsio = &io->scsiio;
cdb = (struct scsi_test_unit_ready *)ctsio->cdb;
cdb->opcode = TEST_UNIT_READY;
cdb->control = control;
io->io_hdr.flags = CTL_FLAG_DATA_NONE;
ctsio->tag_type = tag_type;
ctsio->cdb_len = sizeof(*cdb);
ctsio->ext_data_len = 0;
ctsio->ext_data_ptr = NULL;
ctsio->ext_sg_entries = 0;
ctsio->ext_data_filled = 0;
ctsio->sense_len = SSD_FULL_SIZE;
}
void
ctl_scsi_inquiry(union ctl_io *io, uint8_t *data_ptr, int32_t data_len,
uint8_t byte2, uint8_t page_code, ctl_tag_type tag_type,
uint8_t control)
{
struct ctl_scsiio *ctsio;
struct scsi_inquiry *cdb;
ctl_scsi_zero_io(io);
io->io_hdr.io_type = CTL_IO_SCSI;
ctsio = &io->scsiio;
cdb = (struct scsi_inquiry *)ctsio->cdb;
cdb->opcode = INQUIRY;
cdb->byte2 = byte2;
cdb->page_code = page_code;
cdb->control = control;
scsi_ulto2b(data_len, cdb->length);
io->io_hdr.io_type = CTL_IO_SCSI;
io->io_hdr.flags = CTL_FLAG_DATA_IN;
ctsio->tag_type = tag_type;
ctsio->cdb_len = sizeof(*cdb);
ctsio->ext_data_len = data_len;
ctsio->ext_data_ptr = data_ptr;
ctsio->ext_sg_entries = 0;
ctsio->ext_data_filled = 0;
ctsio->sense_len = SSD_FULL_SIZE;
}
void
ctl_scsi_request_sense(union ctl_io *io, uint8_t *data_ptr,
int32_t data_len, uint8_t byte2, ctl_tag_type tag_type,
uint8_t control)
{
struct ctl_scsiio *ctsio;
struct scsi_request_sense *cdb;
ctl_scsi_zero_io(io);
io->io_hdr.io_type = CTL_IO_SCSI;
ctsio = &io->scsiio;
cdb = (struct scsi_request_sense *)ctsio->cdb;
cdb->opcode = REQUEST_SENSE;
cdb->byte2 = byte2;
cdb->control = control;
cdb->length = data_len;
io->io_hdr.io_type = CTL_IO_SCSI;
io->io_hdr.flags = CTL_FLAG_DATA_IN;
ctsio->tag_type = tag_type;
ctsio->cdb_len = sizeof(*cdb);
ctsio->ext_data_ptr = data_ptr;
ctsio->ext_data_len = data_len;
ctsio->ext_sg_entries = 0;
ctsio->ext_data_filled = 0;
ctsio->sense_len = SSD_FULL_SIZE;
}
void
ctl_scsi_report_luns(union ctl_io *io, uint8_t *data_ptr, uint32_t data_len,
uint8_t select_report, ctl_tag_type tag_type,
uint8_t control)
{
struct ctl_scsiio *ctsio;
struct scsi_report_luns *cdb;
ctl_scsi_zero_io(io);
io->io_hdr.io_type = CTL_IO_SCSI;
ctsio = &io->scsiio;
cdb = (struct scsi_report_luns *)ctsio->cdb;
cdb->opcode = REPORT_LUNS;
cdb->select_report = select_report;
scsi_ulto4b(data_len, cdb->length);
cdb->control = control;
io->io_hdr.io_type = CTL_IO_SCSI;
io->io_hdr.flags = CTL_FLAG_DATA_IN;
ctsio->tag_type = tag_type;
ctsio->cdb_len = sizeof(*cdb);
ctsio->ext_data_ptr = data_ptr;
ctsio->ext_data_len = data_len;
ctsio->ext_sg_entries = 0;
ctsio->ext_data_filled = 0;
ctsio->sense_len = SSD_FULL_SIZE;
}
void
ctl_scsi_read_write_buffer(union ctl_io *io, uint8_t *data_ptr,
uint32_t data_len, int read_buffer, uint8_t mode,
uint8_t buffer_id, uint32_t buffer_offset,
ctl_tag_type tag_type, uint8_t control)
{
struct ctl_scsiio *ctsio;
struct scsi_write_buffer *cdb;
ctl_scsi_zero_io(io);
io->io_hdr.io_type = CTL_IO_SCSI;
ctsio = &io->scsiio;
cdb = (struct scsi_write_buffer *)ctsio->cdb;
if (read_buffer != 0)
cdb->opcode = READ_BUFFER;
else
cdb->opcode = WRITE_BUFFER;
cdb->byte2 = mode & RWB_MODE;
cdb->buffer_id = buffer_id;
scsi_ulto3b(buffer_offset, cdb->offset);
scsi_ulto3b(data_len, cdb->length);
cdb->control = control;
io->io_hdr.io_type = CTL_IO_SCSI;
if (read_buffer != 0)
io->io_hdr.flags = CTL_FLAG_DATA_IN;
else
io->io_hdr.flags = CTL_FLAG_DATA_OUT;
ctsio->tag_type = tag_type;
ctsio->cdb_len = sizeof(*cdb);
ctsio->ext_data_ptr = data_ptr;
ctsio->ext_data_len = data_len;
ctsio->ext_sg_entries = 0;
ctsio->ext_data_filled = 0;
ctsio->sense_len = SSD_FULL_SIZE;
}
void
ctl_scsi_read_write(union ctl_io *io, uint8_t *data_ptr, uint32_t data_len,
int read_op, uint8_t byte2, int minimum_cdb_size,
uint64_t lba, uint32_t num_blocks, ctl_tag_type tag_type,
uint8_t control)
{
struct ctl_scsiio *ctsio;
ctl_scsi_zero_io(io);
io->io_hdr.io_type = CTL_IO_SCSI;
ctsio = &io->scsiio;
/*
* Pick out the smallest CDB that will hold the user's request.
* minimum_cdb_size allows cranking the CDB size up, even for
* requests that would not normally need a large CDB. This can be
* useful for testing (e.g. to make sure READ_16 support works without
* having an array larger than 2TB) and for compatibility -- e.g.
* if your device doesn't support READ_6. (ATAPI drives don't.)
*/
if ((minimum_cdb_size < 10)
&& ((lba & 0x1fffff) == lba)
&& ((num_blocks & 0xff) == num_blocks)
&& (byte2 == 0)) {
struct scsi_rw_6 *cdb;
/*
* Note that according to SBC-2, the target should return 256
* blocks if the transfer length in a READ(6) or WRITE(6) CDB
* is set to 0. Since it's possible that some targets
* won't do the right thing, we only send a READ(6) or
* WRITE(6) for transfer sizes up to and including 255 blocks.
*/
cdb = (struct scsi_rw_6 *)ctsio->cdb;
cdb->opcode = (read_op) ? READ_6 : WRITE_6;
scsi_ulto3b(lba, cdb->addr);
cdb->length = num_blocks & 0xff;
cdb->control = control;
ctsio->cdb_len = sizeof(*cdb);
} else if ((minimum_cdb_size < 12)
&& ((num_blocks & 0xffff) == num_blocks)
&& ((lba & 0xffffffff) == lba)) {
struct scsi_rw_10 *cdb;
cdb = (struct scsi_rw_10 *)ctsio->cdb;
cdb->opcode = (read_op) ? READ_10 : WRITE_10;
cdb->byte2 = byte2;
scsi_ulto4b(lba, cdb->addr);
cdb->reserved = 0;
scsi_ulto2b(num_blocks, cdb->length);
cdb->control = control;
ctsio->cdb_len = sizeof(*cdb);
} else if ((minimum_cdb_size < 16)
&& ((num_blocks & 0xffffffff) == num_blocks)
&& ((lba & 0xffffffff) == lba)) {
struct scsi_rw_12 *cdb;
cdb = (struct scsi_rw_12 *)ctsio->cdb;
cdb->opcode = (read_op) ? READ_12 : WRITE_12;
cdb->byte2 = byte2;
scsi_ulto4b(lba, cdb->addr);
scsi_ulto4b(num_blocks, cdb->length);
cdb->reserved = 0;
cdb->control = control;
ctsio->cdb_len = sizeof(*cdb);
} else {
struct scsi_rw_16 *cdb;
cdb = (struct scsi_rw_16 *)ctsio->cdb;
cdb->opcode = (read_op) ? READ_16 : WRITE_16;
cdb->byte2 = byte2;
scsi_u64to8b(lba, cdb->addr);
scsi_ulto4b(num_blocks, cdb->length);
cdb->reserved = 0;
cdb->control = control;
ctsio->cdb_len = sizeof(*cdb);
}
io->io_hdr.io_type = CTL_IO_SCSI;
if (read_op != 0)
io->io_hdr.flags = CTL_FLAG_DATA_IN;
else
io->io_hdr.flags = CTL_FLAG_DATA_OUT;
ctsio->tag_type = tag_type;
ctsio->ext_data_ptr = data_ptr;
ctsio->ext_data_len = data_len;
ctsio->ext_sg_entries = 0;
ctsio->ext_data_filled = 0;
ctsio->sense_len = SSD_FULL_SIZE;
}
Reimplement WRITE USING TOKEN with Block Zero token using WRITE SAME. On my ZVOL of SSDs that increases speed of zero writing in that way from 1 to 2.5GB/s by reducing CPU overhead. MFC after: 2 weeks
2014-08-05 15:01:30 +00:00
void
ctl_scsi_write_same(union ctl_io *io, uint8_t *data_ptr, uint32_t data_len,
uint8_t byte2, uint64_t lba, uint32_t num_blocks,
ctl_tag_type tag_type, uint8_t control)
{
struct ctl_scsiio *ctsio;
struct scsi_write_same_16 *cdb;
ctl_scsi_zero_io(io);
io->io_hdr.io_type = CTL_IO_SCSI;
ctsio = &io->scsiio;
ctsio->cdb_len = sizeof(*cdb);
cdb = (struct scsi_write_same_16 *)ctsio->cdb;
cdb->opcode = WRITE_SAME_16;
cdb->byte2 = byte2;
scsi_u64to8b(lba, cdb->addr);
scsi_ulto4b(num_blocks, cdb->length);
cdb->group = 0;
cdb->control = control;
io->io_hdr.io_type = CTL_IO_SCSI;
io->io_hdr.flags = CTL_FLAG_DATA_OUT;
ctsio->tag_type = tag_type;
ctsio->ext_data_ptr = data_ptr;
ctsio->ext_data_len = data_len;
ctsio->ext_sg_entries = 0;
ctsio->ext_data_filled = 0;
ctsio->sense_len = SSD_FULL_SIZE;
}
Add the CAM Target Layer (CTL). CTL is a disk and processor device emulation subsystem originally written for Copan Systems under Linux starting in 2003. It has been shipping in Copan (now SGI) products since 2005. It was ported to FreeBSD in 2008, and thanks to an agreement between SGI (who acquired Copan's assets in 2010) and Spectra Logic in 2010, CTL is available under a BSD-style license. The intent behind the agreement was that Spectra would work to get CTL into the FreeBSD tree. Some CTL features: - Disk and processor device emulation. - Tagged queueing - SCSI task attribute support (ordered, head of queue, simple tags) - SCSI implicit command ordering support. (e.g. if a read follows a mode select, the read will be blocked until the mode select completes.) - Full task management support (abort, LUN reset, target reset, etc.) - Support for multiple ports - Support for multiple simultaneous initiators - Support for multiple simultaneous backing stores - Persistent reservation support - Mode sense/select support - Error injection support - High Availability support (1) - All I/O handled in-kernel, no userland context switch overhead. (1) HA Support is just an API stub, and needs much more to be fully functional. ctl.c: The core of CTL. Command handlers and processing, character driver, and HA support are here. ctl.h: Basic function declarations and data structures. ctl_backend.c, ctl_backend.h: The basic CTL backend API. ctl_backend_block.c, ctl_backend_block.h: The block and file backend. This allows for using a disk or a file as the backing store for a LUN. Multiple threads are started to do I/O to the backing device, primarily because the VFS API requires that to get any concurrency. ctl_backend_ramdisk.c: A "fake" ramdisk backend. It only allocates a small amount of memory to act as a source and sink for reads and writes from an initiator. Therefore it cannot be used for any real data, but it can be used to test for throughput. It can also be used to test initiators' support for extremely large LUNs. ctl_cmd_table.c: This is a table with all 256 possible SCSI opcodes, and command handler functions defined for supported opcodes. ctl_debug.h: Debugging support. ctl_error.c, ctl_error.h: CTL-specific wrappers around the CAM sense building functions. ctl_frontend.c, ctl_frontend.h: These files define the basic CTL frontend port API. ctl_frontend_cam_sim.c: This is a CTL frontend port that is also a CAM SIM. This frontend allows for using CTL without any target-capable hardware. So any LUNs you create in CTL are visible in CAM via this port. ctl_frontend_internal.c, ctl_frontend_internal.h: This is a frontend port written for Copan to do some system-specific tasks that required sending commands into CTL from inside the kernel. This isn't entirely relevant to FreeBSD in general, but can perhaps be repurposed. ctl_ha.h: This is a stubbed-out High Availability API. Much more is needed for full HA support. See the comments in the header and the description of what is needed in the README.ctl.txt file for more details. ctl_io.h: This defines most of the core CTL I/O structures. union ctl_io is conceptually very similar to CAM's union ccb. ctl_ioctl.h: This defines all ioctls available through the CTL character device, and the data structures needed for those ioctls. ctl_mem_pool.c, ctl_mem_pool.h: Generic memory pool implementation used by the internal frontend. ctl_private.h: Private data structres (e.g. CTL softc) and function prototypes. This also includes the SCSI vendor and product names used by CTL. ctl_scsi_all.c, ctl_scsi_all.h: CTL wrappers around CAM sense printing functions. ctl_ser_table.c: Command serialization table. This defines what happens when one type of command is followed by another type of command. ctl_util.c, ctl_util.h: CTL utility functions, primarily designed to be used from userland. See ctladm for the primary consumer of these functions. These include CDB building functions. scsi_ctl.c: CAM target peripheral driver and CTL frontend port. This is the path into CTL for commands from target-capable hardware/SIMs. README.ctl.txt: CTL code features, roadmap, to-do list. usr.sbin/Makefile: Add ctladm. ctladm/Makefile, ctladm/ctladm.8, ctladm/ctladm.c, ctladm/ctladm.h, ctladm/util.c: ctladm(8) is the CTL management utility. It fills a role similar to camcontrol(8). It allow configuring LUNs, issuing commands, injecting errors and various other control functions. usr.bin/Makefile: Add ctlstat. ctlstat/Makefile ctlstat/ctlstat.8, ctlstat/ctlstat.c: ctlstat(8) fills a role similar to iostat(8). It reports I/O statistics for CTL. sys/conf/files: Add CTL files. sys/conf/NOTES: Add device ctl. sys/cam/scsi_all.h: To conform to more recent specs, the inquiry CDB length field is now 2 bytes long. Add several mode page definitions for CTL. sys/cam/scsi_all.c: Handle the new 2 byte inquiry length. sys/dev/ciss/ciss.c, sys/dev/ata/atapi-cam.c, sys/cam/scsi/scsi_targ_bh.c, scsi_target/scsi_cmds.c, mlxcontrol/interface.c: Update for 2 byte inquiry length field. scsi_da.h: Add versions of the format and rigid disk pages that are in a more reasonable format for CTL. amd64/conf/GENERIC, i386/conf/GENERIC, ia64/conf/GENERIC, sparc64/conf/GENERIC: Add device ctl. i386/conf/PAE: The CTL frontend SIM at least does not compile cleanly on PAE. Sponsored by: Copan Systems, SGI and Spectra Logic MFC after: 1 month
2012-01-12 00:34:33 +00:00
void
ctl_scsi_read_capacity(union ctl_io *io, uint8_t *data_ptr, uint32_t data_len,
uint32_t addr, int reladr, int pmi,
ctl_tag_type tag_type, uint8_t control)
{
struct scsi_read_capacity *cdb;
ctl_scsi_zero_io(io);
io->io_hdr.io_type = CTL_IO_SCSI;
cdb = (struct scsi_read_capacity *)io->scsiio.cdb;
cdb->opcode = READ_CAPACITY;
if (reladr)
cdb->byte2 = SRC_RELADR;
if (pmi)
cdb->pmi = SRC_PMI;
scsi_ulto4b(addr, cdb->addr);
cdb->control = control;
io->io_hdr.io_type = CTL_IO_SCSI;
io->io_hdr.flags = CTL_FLAG_DATA_IN;
io->scsiio.tag_type = tag_type;
io->scsiio.ext_data_ptr = data_ptr;
io->scsiio.ext_data_len = data_len;
io->scsiio.ext_sg_entries = 0;
io->scsiio.ext_data_filled = 0;
io->scsiio.sense_len = SSD_FULL_SIZE;
}
void
ctl_scsi_read_capacity_16(union ctl_io *io, uint8_t *data_ptr,
uint32_t data_len, uint64_t addr, int reladr,
int pmi, ctl_tag_type tag_type, uint8_t control)
{
struct scsi_read_capacity_16 *cdb;
ctl_scsi_zero_io(io);
io->io_hdr.io_type = CTL_IO_SCSI;
cdb = (struct scsi_read_capacity_16 *)io->scsiio.cdb;
cdb->opcode = SERVICE_ACTION_IN;
cdb->service_action = SRC16_SERVICE_ACTION;
if (reladr)
cdb->reladr |= SRC16_RELADR;
if (pmi)
cdb->reladr |= SRC16_PMI;
scsi_u64to8b(addr, cdb->addr);
scsi_ulto4b(data_len, cdb->alloc_len);
cdb->control = control;
io->io_hdr.io_type = CTL_IO_SCSI;
io->io_hdr.flags = CTL_FLAG_DATA_IN;
io->scsiio.tag_type = tag_type;
io->scsiio.ext_data_ptr = data_ptr;
io->scsiio.ext_data_len = data_len;
io->scsiio.ext_sg_entries = 0;
io->scsiio.ext_data_filled = 0;
io->scsiio.sense_len = SSD_FULL_SIZE;
}
void
ctl_scsi_mode_sense(union ctl_io *io, uint8_t *data_ptr, uint32_t data_len,
int dbd, int llbaa, uint8_t page_code, uint8_t pc,
uint8_t subpage, int minimum_cdb_size,
ctl_tag_type tag_type, uint8_t control)
{
ctl_scsi_zero_io(io);
if ((minimum_cdb_size < 10)
&& (llbaa == 0)
&& (data_len < 256)) {
struct scsi_mode_sense_6 *cdb;
cdb = (struct scsi_mode_sense_6 *)io->scsiio.cdb;
cdb->opcode = MODE_SENSE_6;
if (dbd)
cdb->byte2 |= SMS_DBD;
cdb->page = page_code | pc;
cdb->subpage = subpage;
cdb->length = data_len;
cdb->control = control;
} else {
struct scsi_mode_sense_10 *cdb;
cdb = (struct scsi_mode_sense_10 *)io->scsiio.cdb;
cdb->opcode = MODE_SENSE_10;
if (dbd)
cdb->byte2 |= SMS_DBD;
if (llbaa)
cdb->byte2 |= SMS10_LLBAA;
cdb->page = page_code | pc;
cdb->subpage = subpage;
scsi_ulto2b(data_len, cdb->length);
cdb->control = control;
}
io->io_hdr.io_type = CTL_IO_SCSI;
io->io_hdr.flags = CTL_FLAG_DATA_IN;
io->scsiio.tag_type = tag_type;
io->scsiio.ext_data_ptr = data_ptr;
io->scsiio.ext_data_len = data_len;
io->scsiio.ext_sg_entries = 0;
io->scsiio.ext_data_filled = 0;
io->scsiio.sense_len = SSD_FULL_SIZE;
}
void
ctl_scsi_start_stop(union ctl_io *io, int start, int load_eject, int immediate,
int power_conditions, int onoffline __unused,
ctl_tag_type tag_type, uint8_t control)
{
struct scsi_start_stop_unit *cdb;
cdb = (struct scsi_start_stop_unit *)io->scsiio.cdb;
ctl_scsi_zero_io(io);
cdb->opcode = START_STOP_UNIT;
if (immediate)
cdb->byte2 |= SSS_IMMED;
#ifdef NEEDTOPORT
if (onoffline)
cdb->byte2 |= SSS_ONOFFLINE;
#endif
cdb->how = power_conditions;
if (load_eject)
cdb->how |= SSS_LOEJ;
if (start)
cdb->how |= SSS_START;
cdb->control = control;
io->io_hdr.io_type = CTL_IO_SCSI;
io->io_hdr.flags = CTL_FLAG_DATA_NONE;
io->scsiio.tag_type = tag_type;
io->scsiio.ext_data_ptr = NULL;
io->scsiio.ext_data_len = 0;
io->scsiio.ext_sg_entries = 0;
io->scsiio.ext_data_filled = 0;
io->scsiio.sense_len = SSD_FULL_SIZE;
}
void
ctl_scsi_sync_cache(union ctl_io *io, int immed, int reladr,
int minimum_cdb_size, uint64_t starting_lba,
uint32_t block_count, ctl_tag_type tag_type,
uint8_t control)
{
ctl_scsi_zero_io(io);
if ((minimum_cdb_size < 16)
&& ((block_count & 0xffff) == block_count)
&& ((starting_lba & 0xffffffff) == starting_lba)) {
struct scsi_sync_cache *cdb;
cdb = (struct scsi_sync_cache *)io->scsiio.cdb;
cdb->opcode = SYNCHRONIZE_CACHE;
if (reladr)
cdb->byte2 |= SSC_RELADR;
if (immed)
cdb->byte2 |= SSC_IMMED;
scsi_ulto4b(starting_lba, cdb->begin_lba);
scsi_ulto2b(block_count, cdb->lb_count);
cdb->control = control;
} else {
struct scsi_sync_cache_16 *cdb;
cdb = (struct scsi_sync_cache_16 *)io->scsiio.cdb;
cdb->opcode = SYNCHRONIZE_CACHE_16;
if (reladr)
cdb->byte2 |= SSC_RELADR;
if (immed)
cdb->byte2 |= SSC_IMMED;
scsi_u64to8b(starting_lba, cdb->begin_lba);
scsi_ulto4b(block_count, cdb->lb_count);
cdb->control = control;
}
io->io_hdr.io_type = CTL_IO_SCSI;
io->io_hdr.flags = CTL_FLAG_DATA_NONE;
io->scsiio.tag_type = tag_type;
io->scsiio.ext_data_ptr = NULL;
io->scsiio.ext_data_len = 0;
io->scsiio.ext_sg_entries = 0;
io->scsiio.ext_data_filled = 0;
io->scsiio.sense_len = SSD_FULL_SIZE;
}
void
ctl_scsi_persistent_res_in(union ctl_io *io, uint8_t *data_ptr,
uint32_t data_len, int action,
ctl_tag_type tag_type, uint8_t control)
{
struct scsi_per_res_in *cdb;
ctl_scsi_zero_io(io);
cdb = (struct scsi_per_res_in *)io->scsiio.cdb;
cdb->opcode = PERSISTENT_RES_IN;
cdb->action = action;
scsi_ulto2b(data_len, cdb->length);
cdb->control = control;
io->io_hdr.io_type = CTL_IO_SCSI;
io->io_hdr.flags = CTL_FLAG_DATA_IN;
io->scsiio.tag_type = tag_type;
io->scsiio.ext_data_ptr = data_ptr;
io->scsiio.ext_data_len = data_len;
io->scsiio.ext_sg_entries = 0;
io->scsiio.ext_data_filled = 0;
io->scsiio.sense_len = SSD_FULL_SIZE;
}
void
ctl_scsi_persistent_res_out(union ctl_io *io, uint8_t *data_ptr,
uint32_t data_len, int action, int type,
uint64_t key, uint64_t sa_key,
ctl_tag_type tag_type, uint8_t control)
{
struct scsi_per_res_out *cdb;
struct scsi_per_res_out_parms *params;
ctl_scsi_zero_io(io);
cdb = (struct scsi_per_res_out *)io->scsiio.cdb;
params = (struct scsi_per_res_out_parms *)data_ptr;
cdb->opcode = PERSISTENT_RES_OUT;
if (action == 5)
cdb->action = 6;
else
cdb->action = action;
switch(type)
{
case 0:
cdb->scope_type = 1;
break;
case 1:
cdb->scope_type = 3;
break;
case 2:
cdb->scope_type = 5;
break;
case 3:
cdb->scope_type = 6;
break;
case 4:
cdb->scope_type = 7;
break;
case 5:
cdb->scope_type = 8;
break;
}
scsi_ulto4b(data_len, cdb->length);
cdb->control = control;
scsi_u64to8b(key, params->res_key.key);
scsi_u64to8b(sa_key, params->serv_act_res_key);
io->io_hdr.io_type = CTL_IO_SCSI;
io->io_hdr.flags = CTL_FLAG_DATA_OUT;
io->scsiio.tag_type = tag_type;
io->scsiio.ext_data_ptr = data_ptr;
io->scsiio.ext_data_len = data_len;
io->scsiio.ext_sg_entries = 0;
io->scsiio.ext_data_filled = 0;
io->scsiio.sense_len = SSD_FULL_SIZE;
}
void
ctl_scsi_maintenance_in(union ctl_io *io, uint8_t *data_ptr, uint32_t data_len,
uint8_t action, ctl_tag_type tag_type, uint8_t control)
{
struct scsi_maintenance_in *cdb;
ctl_scsi_zero_io(io);
cdb = (struct scsi_maintenance_in *)io->scsiio.cdb;
cdb->opcode = MAINTENANCE_IN;
cdb->byte2 = action;
scsi_ulto4b(data_len, cdb->length);
cdb->control = control;
io->io_hdr.io_type = CTL_IO_SCSI;
io->io_hdr.flags = CTL_FLAG_DATA_IN;
io->scsiio.tag_type = tag_type;
io->scsiio.ext_data_ptr = data_ptr;
io->scsiio.ext_data_len = data_len;
io->scsiio.ext_sg_entries = 0;
io->scsiio.ext_data_filled = 0;
io->scsiio.sense_len = SSD_FULL_SIZE;
}
#ifndef _KERNEL
union ctl_io *
ctl_scsi_alloc_io(struct ctl_id initid)
{
union ctl_io *io;
io = (union ctl_io *)malloc(sizeof(*io));
if (io == NULL)
goto bailout;
io->io_hdr.nexus.initid = initid;
bailout:
return (io);
}
void
ctl_scsi_free_io(union ctl_io *io)
{
free(io);
}
#endif /* !_KERNEL */
void
ctl_scsi_zero_io(union ctl_io *io)
{
void *pool_ref;
if (io == NULL)
return;
pool_ref = io->io_hdr.pool;
memset(io, 0, sizeof(*io));
io->io_hdr.pool = pool_ref;
}
const char *
ctl_scsi_task_string(struct ctl_taskio *taskio)
{
unsigned int i;
for (i = 0; i < (sizeof(ctl_task_table)/sizeof(ctl_task_table[0]));
i++) {
if (taskio->task_action == ctl_task_table[i].task_action) {
return (ctl_task_table[i].description);
}
}
return (NULL);
}
void
ctl_io_error_sbuf(union ctl_io *io, struct scsi_inquiry_data *inq_data,
struct sbuf *sb)
{
struct ctl_status_desc *status_desc;
char path_str[64];
unsigned int i;
status_desc = NULL;
for (i = 0; i < (sizeof(ctl_status_table)/sizeof(ctl_status_table[0]));
i++) {
if ((io->io_hdr.status & CTL_STATUS_MASK) ==
ctl_status_table[i].status) {
status_desc = &ctl_status_table[i];
break;
}
}
ctl_scsi_path_string(io, path_str, sizeof(path_str));
switch (io->io_hdr.io_type) {
case CTL_IO_SCSI:
sbuf_cat(sb, path_str);
ctl_scsi_command_string(&io->scsiio, NULL, sb);
sbuf_printf(sb, "\n");
sbuf_printf(sb, "%sTag: 0x%04x, Type: %d\n", path_str,
io->scsiio.tag_num, io->scsiio.tag_type);
break;
case CTL_IO_TASK: {
const char *task_desc;
sbuf_cat(sb, path_str);
task_desc = ctl_scsi_task_string(&io->taskio);
if (task_desc == NULL)
sbuf_printf(sb, "Unknown Task Action %d (%#x)",
io->taskio.task_action,
io->taskio.task_action);
else
sbuf_printf(sb, "Task Action: %s", task_desc);
sbuf_printf(sb, "\n");
switch (io->taskio.task_action) {
case CTL_TASK_ABORT_TASK:
case CTL_TASK_ABORT_TASK_SET:
case CTL_TASK_CLEAR_TASK_SET:
sbuf_printf(sb, "%sTag: 0x%04x, Type: %d\n", path_str,
io->taskio.tag_num,
io->taskio.tag_type);
break;
default:
break;
}
break;
}
default:
break;
}
sbuf_cat(sb, path_str);
if (status_desc == NULL)
sbuf_printf(sb, "CTL Status: Unknown status %#x\n",
io->io_hdr.status);
else
sbuf_printf(sb, "CTL Status: %s\n", status_desc->description);
if ((io->io_hdr.io_type == CTL_IO_SCSI)
&& ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SCSI_ERROR)) {
sbuf_cat(sb, path_str);
sbuf_printf(sb, "SCSI Status: %s\n",
ctl_scsi_status_string(&io->scsiio));
if (io->scsiio.scsi_status == SCSI_STATUS_CHECK_COND)
ctl_scsi_sense_sbuf(&io->scsiio, inq_data,
sb, SSS_FLAG_NONE);
}
}
char *
ctl_io_error_string(union ctl_io *io, struct scsi_inquiry_data *inq_data,
char *str, int str_len)
{
struct sbuf sb;
sbuf_new(&sb, str, str_len, SBUF_FIXEDLEN);
ctl_io_error_sbuf(io, inq_data, &sb);
sbuf_finish(&sb);
return (sbuf_data(&sb));
}
#ifdef _KERNEL
void
ctl_io_error_print(union ctl_io *io, struct scsi_inquiry_data *inq_data)
{
char str[512];
#ifdef NEEDTOPORT
char *message;
char *line;
message = io_error_string(io, inq_data, str, sizeof(str));
for (line = strsep(&message, "\n"); line != NULL;
line = strsep(&message, "\n")) {
csevent_log(CSC_CTL | CSC_SHELF_SW | CTL_ERROR_REPORT,
csevent_LogType_Trace,
csevent_Severity_Information,
csevent_AlertLevel_Green,
csevent_FRU_Firmware,
csevent_FRU_Unknown, "%s", line);
}
#else
printf("%s", ctl_io_error_string(io, inq_data, str, sizeof(str)));
#endif
}
#else /* _KERNEL */
void
ctl_io_error_print(union ctl_io *io, struct scsi_inquiry_data *inq_data,
FILE *ofile)
{
char str[512];
fprintf(ofile, "%s", ctl_io_error_string(io, inq_data, str,
sizeof(str)));
}
#endif /* _KERNEL */
/*
* vim: ts=8
*/
Reference in New Issue Copy Permalink