2 .\" Copyright (c) 2003 Silicon Graphics International Corp.
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions, and the following disclaimer,
10 .\" without modification.
11 .\" 2. Redistributions in binary form must reproduce at minimum a disclaimer
12 .\" substantially similar to the "NO WARRANTY" disclaimer below
13 .\" ("Disclaimer") and any redistribution must be conditioned upon
14 .\" including a substantially similar Disclaimer requirement for further
15 .\" binary redistribution.
18 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 .\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
21 .\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 .\" HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
27 .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 .\" POSSIBILITY OF SUCH DAMAGES.
30 .\" ctladm utility man page.
32 .\" Author: Ken Merry <ken@FreeBSD.org>
34 .\" $Id: //depot/users/kenm/FreeBSD-test2/usr.sbin/ctladm/ctladm.8#3 $
42 .Nd CAM Target Layer control utility
72 .Aq Fl b Ar blocksize_bytes
82 .Aq Fl b Ar blocksize_bytes
99 .Aq Fl m Ar page | Fl l
121 .Op Fl b Ar blockcount
140 .Aq Fl l Ar datamove|done
142 .Op Fl T Ar oneshot|cont
144 .Ic realsync Aq on|off|query
157 .Op Fl s Ar len fmt Op Ar args
159 .Op Fl d Ar delete_id
163 .Op Fl B Ar blocksize
164 .Op Fl d Ar device_id
166 .Op Fl o Ar name=value
167 .Op Fl s Ar size_bytes
168 .Op Fl S Ar serial_num
169 .Op Fl t Ar device_type
174 .Op Fl o Ar name=value
179 .Aq Fl s Ar size_bytes
191 .Op Fl p Ar targ_port
204 utility is designed to provide a way to access and control the CAM Target
206 It provides a way to send
208 commands to the CTL layer, and also provides
209 some meta-commands that utilize
214 command is implemented using the
216 REPORT LUNS and INQUIRY commands.)
220 utility has a number of primary functions, many of which require a device
222 The device identifier takes the following form:
225 Specify the target (almost always 0) and LUN number to operate on.
227 Many of the primary functions of the
229 utility take the following optional arguments:
233 Specify the number of times to retry a command in the event of failure.
235 Specify the device to open. This allows opening a device other than the
238 to be opened for sending commands.
240 Specify the initiator number to use.
243 will use 7 as the initiator number.
251 TEST UNIT READY command to the device and report whether or not it is
256 INQUIRY command to the device and display some of the returned inquiry
261 REQUEST SENSE command to the device and display the returned sense
266 REPORT LUNS command to the device and display supported LUNs.
270 READ command to the device, and write the requested data to a file or
274 Specify the starting Logical Block Address for the READ. This can be
275 specified in decimal, octal (starting with 0), hexadecimal (starting with
276 0x) or any other base supported by
279 Specify the length, in 512 byte blocks, of the READ request.
281 Specify the destination for the data read by the READ command. Either a
284 for stdout may be specified.
288 CDB (Command Data Block) size to be used for the READ request. Allowable
289 values are 6, 10, 12 and 16. Depending upon the LBA and amount of data
290 requested, a larger CDB size may be used to satisfy the request. (e.g.,
291 for LBAs above 0xffffffff, READ(16) must be used to satisfy the request.)
292 .It Fl b Ar blocksize
293 Specify the blocksize of the underlying
295 device, so the transfer length
296 can be calculated accurately. The blocksize can be obtained via the
298 READ CAPACITY command.
302 from the kernel when doing a read, just execute the command without copying
304 This is to be used for performance testing.
307 Read data from a file or stdin, and write the data to the device using the
312 Specify the starting Logical Block Address for the WRITE. This can be
313 specified in decimal, octal (starting with 0), hexadecimal (starting with
314 0x) or any other base supported by
317 Specify the length, in 512 byte blocks, of the WRITE request.
319 Specify the source for the data to be written by the WRITE command. Either a
322 for stdin may be specified.
326 CDB (Command Data Block) size to be used for the READ request. Allowable
327 values are 6, 10, 12 and 16. Depending upon the LBA and amount of data
328 requested, a larger CDB size may be used to satisfy the request. (e.g.,
329 for LBAs above 0xffffffff, READ(16) must be used to satisfy the request.)
330 .It Fl b Ar blocksize
331 Specify the blocksize of the underlying
333 device, so the transfer length
334 can be calculated accurately. The blocksize can be obtained via the
336 READ CAPACITY command.
340 to the kernel when doing a write, just execute the command without copying
342 This is to be used for performance testing.
345 Issue a SCSI READ command to the logical device to potentially force a bad
346 block on a disk in the RAID set to be reconstructed from the other disks in
347 the array. This command should only be used on an array that is in the
348 normal state. If used on a critical array, it could cause the array to go
349 offline if the bad block to be remapped is on one of the disks that is
350 still active in the array.
352 The data for this particular command will be discarded, and not returned to
355 In order to determine which LUN to read from, the user should first
356 determine which LUN the disk with a bad block belongs to. Then he should
357 map the bad disk block back to the logical block address for the array in
358 order to determine which LBA to pass in to the
362 This command is primarily intended for testing. In practice, bad block
363 remapping will generally be triggered by the in-kernel Disk Aerobics and
367 Specify the starting Logical Block Address.
369 Specify the amount of data in bytes to read from the LUN. This must be a
370 multiple of the LUN blocksize.
375 READ CAPACITY command to the device and display the device size and device
376 block size. By default, READ CAPACITY(10) is
377 used. If the device returns a maximum LBA of 0xffffffff, however,
379 will automatically issue a READ CAPACITY(16), which is implemented as a
380 service action of the SERVICE ACTION IN(16) opcode. The user can specify
381 the minimum CDB size with the
383 argument. Valid values for the
385 option are 10 and 16. If a 10 byte CDB is specified, the request will be
386 automatically reissued with a 16 byte CDB if the maximum LBA returned is
391 MODE SENSE command to the device, and display the requested mode page(s) or
395 Specify the mode page to display. This option and the
397 option are mutually exclusive. One of the two must be specified, though.
398 Mode page numbers may be specified in decimal or hexadecimal.
400 Request that the list of mode pages supported by the device be returned.
403 option are mutually exclusive. One of the two must be specified, though.
405 Specify the mode page page control value. Possible values are:
406 .Bl -tag -width 2n -compact
410 Changeable value bitmask.
417 Disable block descriptors when sending the mode sense request.
419 Specify the subpage used with the mode sense request.
421 Specify the CDB size used for the mode sense request. Supported values are
427 START STOP UNIT command to the specified LUN with the start
431 Set the immediate bit in the CDB. Note that CTL does not support the
432 immediate bit, so this is primarily useful for making sure that CTL returns
435 Set the Copan proprietary on/offline bit in the CDB. When this flag is
436 used, the LUN will be marked online again (see the description of the
440 commands). When this flag is used with a
441 start command, the LUN will NOT be spun up. You need to use a start
444 flag to spin up the disks in the LUN.
449 START STOP UNIT command to the specified LUN with the start
450 bit cleared. We use an ordered tag to stop the LUN, so we can guarantee
451 that all pending I/O executes before it is stopped. (CTL guarantees this
454 sends an ordered tag for completeness.)
457 Set the immediate bit in the CDB. Note that CTL does not support the
458 immediate bit, so this is primarily useful for making sure that CTL returns
461 Set the Copan proprietary on/offline bit in the CDB. When this flag is
462 used, the LUN will be spun down and taken offline ("Logical unit not ready,
463 manual intervention required"). See the description of the
472 SYNCHRONIZE CACHE command to the device. By default, SYNCHRONIZE
473 CACHE(10) is used. If the specified starting LBA is greater than
474 0xffffffff or the length is greater than 0xffff, though,
475 SYNCHRONIZE CACHE(16) will be used. The 16 byte command will also be used
476 if the user specifies a 16 byte CDB with the
481 Specify the starting LBA of the cache region to synchronize. This option is a
482 no-op for CTL. If you send a SYNCHRONIZE CACHE command, it will sync the
483 cache for the entire LUN.
484 .It Fl b Ar blockcount
485 Specify the length of the cache region to synchronize. This option is a
486 no-op for CTL. If you send a SYNCHRONIZE CACHE command, it will sync the
487 cache for the entire LUN.
489 Specify relative addressing for the starting LBA. CTL does not support
490 relative addressing, since it only works for linked commands, and CTL
491 does not support linked commands.
493 Tell the target to return status immediately after issuing the SYHCHRONIZE CACHE
494 command rather than waiting for the cache to finish syncing. CTL does not
497 Specify the minimum CDB size. Valid values are 10 and 16 bytes.
502 START STOP UNIT command with the start bit cleared and the on/offline bit
503 set to all direct access LUNs. This will spin down all direct access LUNs,
504 and mark them offline ("Logical unit not ready, manual intervention
505 required"). Once marked offline, the state can only be cleared by sending
506 a START STOP UNIT command with the start bit set and the on/offline bit
513 will accomplish this. Note that the
514 on/offline bit is a non-standard Copan extension to the
516 START STOP UNIT command, so merely sending a normal start command from an
517 initiator will not clear the condition. (This is by design.)
521 START STOP UNIT command with the start bit set and the on/offline bit set
522 to all direct access LUNs. This will mark all direct access LUNs "online"
523 again. It will not cause any LUNs to start up. A separate start command
524 without the on/offline bit set is necessary for that.
526 Use the kernel facility for stopping all direct access LUNs and setting the
527 offline bit. Unlike the
529 command above, this command allows shutting down LUNs with I/O active. It
530 will also issue a LUN reset to any reserved LUNs to break the reservation
531 so that the LUN can be stopped.
535 This command is functionally identical to the
537 command described above. The primary difference is that the LUNs are
538 enumerated and commands sent by the in-kernel Front End Target Driver
542 List all LUNs registered with CTL.
543 Because this command uses the ioctl port, it will only work when the FETDs
544 (Front End Target Drivers) are enabled.
545 This command is the equivalent of doing a REPORT LUNS on one LUN and then
546 an INQUIRY on each LUN in the system.
548 Delay commands at the given location. There are two places where commands
549 may be delayed currently: before data is transferred
551 and just prior to sending status to the host
553 One of the two must be supplied as an argument to the
557 option must also be specified.
560 Delay command(s) at the specified location.
561 This can either be at the data movement stage (datamove) or prior to
562 command completion (done).
563 .It Fl t Ar delaytime
564 Delay command(s) for the specified number of seconds. This must be
565 specified. If set to 0, it will clear out any previously set delay for
566 this particular location (datamove or done).
567 .It Fl T Ar delaytype
568 Specify the delay type.
571 option will delay the next command sent to the given LUN.
574 option, every command will be delayed by the specified period of time.
577 the next command sent to the given LUN will be delayed and all subsequent
578 commands will be completed normally.
582 Query and control CTL's SYNCHRONIZE CACHE behavior. The
585 will show whether SYNCHRONIZE CACHE commands are being sent to the backend
587 The default is to send SYNCHRONIZE CACHE commands to the backend.
590 argument will cause all SYNCHRONIZE CACHE commands sent to all LUNs to be
594 argument will cause all SYNCHRONIZE CACHE commands sent to all LUNs to be
595 immediately returned to the initiator with successful status.
597 For a given lun, only actually service every Nth SYNCHRONIZE CACHE command
598 that is sent. This can be used for debugging the optimal time period for
599 sending SYNCHRONIZE cache commands. An interval of 0 means that the cache
600 will be flushed for this LUN every time a SYNCHRONIZE CACHE command is
603 You must specify the target and LUN you want to modify.
605 Get the interval at which we actually service the SYNCHRONIZE CACHE
606 command, as set by the
609 The reported number means that we will actually flush the cache on every
610 Nth SYNCHRONIZE CACHE command. A value of 0 means that we will flush the
613 You must specify the target and LUN you want to query.
615 Inject the specified type of error for the LUN specified, when a command
616 that matches the given pattern is seen.
617 The sense data returned is in either fixed or descriptor format, depending
618 upon the status of the D_SENSE bit in the control mode page (page 0xa) for
621 Errors are only injected for commands that have not already failed for
623 By default, only the first command matching the pattern specified is
624 returned with the supplied error.
628 flag is specified, all commands matching the pattern will be returned with
629 the specified error until the error injection command is deleted with
634 Specify the error to return:
637 Return the next matching command on the specified LUN with the sense key
638 ABORTED COMMAND (0x0b), and the ASC/ASCQ 0x45,0x00 ("Select or reselect
641 Return the next matching command on the specified LUN with the sense key
642 MEDIUM ERROR (0x03) and the ASC/ASCQ 0x11,0x00 ("Unrecovered read error") for
643 reads, or ASC/ASCQ 0x0c,0x02 ("Write error - auto reallocation failed")
646 Return the next matching command on the specified LUN with the sense key
647 UNIT ATTENTION (0x06) and the ASC/ASCQ 0x29,0x00 ("POWER ON, RESET, OR BUS
648 DEVICE RESET OCCURRED").
650 Return the next matching command on the specified LUN with the supplied
654 argument must be specified.
657 Specify which commands should be returned with the given error.
660 The error should apply to READ(6), READ(10), READ(12), READ(16), etc.
662 The error should apply to WRITE(6), WRITE(10), WRITE(12), WRITE(16), WRITE
665 The error should apply to both read and write type commands.
667 The error should apply to READ CAPACITY(10) and READ CAPACITY(16) commands.
669 The error should apply to TEST UNIT READY commands.
671 The error should apply to any command.
674 Specify the starting lba and length of the range of LBAs which should
676 This option is only applies when read and/or write patterns are specified.
677 If used with other command types, the error will never be triggered.
678 .It Fl s Ar len fmt Op Ar args
679 Specify the sense data that is to be returned for custom actions.
682 len bytes of sense data will be read from standard input and written to the
684 If len is longer than 252 bytes (the maximum allowable
686 sense data length), it will be truncated to that length.
687 The sense data format is described in
690 The error injection should be persistent, instead of happening once.
691 Persistent errors must be deleted with the
694 .It Fl d Ar delete_id
695 Delete the specified error injection serial number.
696 The serial number is returned when the error is injected.
699 Perform one of several CTL frontend port operations.
700 Either get a list of frontend ports
702 turn one or more frontends on
705 or set the World Wide Node Name
707 or World Wide Port Name
718 The WWNN and WWPN may both be specified at the same time, but cannot be
719 combined with enabling/disabling or listing ports.
722 List all CTL frontend ports or a specific port type or number.
724 Turn the specified CTL frontend ports off or on.
725 If no port number or port type is specified, all ports are turned on or
727 .It Fl p Ar targ_port
728 Specify the frontend port number.
729 The port numbers can be found in the frontend port list.
731 Omit the header in the port list output.
733 Specify the frontend type.
734 Currently defined port types are
740 (CTL ioctl interface),
745 Set the World Wide Node Name for the given port.
748 argument must be specified, since this is only possible to implement on a
750 As a general rule, the WWNN should be the same across all ports on the
753 Set the World Wide Port Name for the given port.
756 argument must be specified, since this is only possible to implement on a
758 As a general rule, the WWPN must be different for every port in the system.
760 Output the port list in XML format.
763 Dump the OOA (Order Of Arrival) queue for each LUN registered with CTL.
765 Dump the CTL structures to the console.
768 The backend must be specified, and depending upon the backend requested,
769 some of the other options may be required.
770 If the LUN is created successfully, the LUN configuration will be
772 If LUN creation fails, a message will be displayed describing the failure.
778 This specifies the name backend to use when creating the LUN.
783 .It Fl B Ar blocksize
784 Specify the blocksize of the backend in bytes.
785 .It Fl d Ar device_id
786 Specify the LUN-associated string to use in the
788 INQUIRY VPD page 0x83 data.
790 Request that a particular LUN number be assigned.
791 If the requested LUN number is not available, the request will fail.
792 .It Fl o Ar name=value
793 Specify a backend-specific name/value pair.
796 arguments may be specified.
797 Refer to the backend documentation for arguments that may be used.
798 .It Fl s Ar size_bytes
799 Specify the size of the LUN in bytes.
800 Some backends may allow setting the size (e.g. the ramdisk backend) and for
801 others the size may be implicit (e.g. the block backend).
802 .It Fl S Ar serial_num
803 Specify the serial number to be used in the
805 INQUIRY VPD page 0x80 data.
806 .It Fl t Ar device_type
807 Specify the numeric SCSI device type to use when creating the LUN.
808 For example, the Direct Access type is 0.
809 If this flag is not used, the type of LUN created is backend-specific.
810 Not all LUN types are supported.
811 Currently CTL only supports Direct Access (type 0) and Processor (type 3)
813 The backend requested may or may not support all of the LUN types that CTL
818 The backend must be specified, and the LUN number must also be specified.
819 Backend-specific options may also be specified with the
824 Specify the backend that owns the LUN to be removed.
830 Specify the LUN number to remove.
831 .It Fl o Ar name=value
832 Specify a backend-specific name/value pair.
835 arguments may be specified.
836 Refer to the backend documentation for arguments that may be used.
840 The backend, the LUN number, and the size must be specified.
843 Specify the backend that owns the LUN to be removed.
849 Specify the LUN number to remove.
850 .It Fl s Ar size_bytes
851 Specify the size of the LUN in bytes.
856 keyword may be passed instead; this will make CTL use the size of backing
860 Get a list of all configured LUNs.
861 This also includes the LUN size and blocksize, serial number and device ID.
865 This restricts the LUN list to the named backend.
872 This will also display any backend-specific LUN attributes in addition to
873 the standard per-LUN information.
876 The LUN list information from the kernel comes in XML format, and this
877 option allows the display of the raw XML data.
882 options are mutually exclusive.
885 the entire LUN database is displayed in XML format.
897 TEST UNIT READY command to LUN 1.
899 .Dl ctladm modesense 0:1 -l
901 Display the list of mode pages supported by LUN 1.
903 .Dl ctladm modesense 0:0 -m 10 -P 3 -d -c 10
905 Display the saved version of the Control mode page (page 10) on LUN 0.
906 Disable fetching block descriptors, and use a 10 byte MODE SENSE command
907 instead of the default 6 byte command.
910 ctladm read 0:2 -l 0 -d 1 -b 512 -f - > foo
913 Read the first 512 byte block from LUN 2 and dump it to the file
916 ctladm write 0:3 -l 0xff432140 -d 20 -b 512 -f /tmp/bar
919 Read 10240 bytes from the file
921 and write it to target 0, LUN 3.
922 starting at LBA 0xff432140.
924 .Dl ctladm create -b ramdisk -s 10485760000000000
926 Create a LUN with the
928 ramdisk as a backing store.
929 The LUN will claim to have a size of approximately 10 terabytes.
931 .Dl ctladm create -b block -o file=src/usr.sbin/ctladm/ctladm.8
933 Create a LUN using the block backend, and specify the file
934 .Pa src/usr.sbin/ctladm/ctladm.8
935 as the backing store.
936 The size of the LUN will be derived from the size of the file.
938 .Dl ctladm create -b block -o file=src/usr.sbin/ctladm/ctladm.8 -S MYSERIAL321 -d MYDEVID123
940 Create a LUN using the block backend, specify the file
941 .Pa src/usr.sbin/ctladm/ctladm.8
942 as the backing store, and specify the
944 VPD page 0x80 and 0x83 serial number
949 .Dl ctladm remove -b block -l 12
951 Remove LUN 12, which is handled by the block backend, from the system.
955 List configured LUNs in the system, along with their backend and serial
957 This works when the Front End Target Drivers are enabled or disabled.
961 List all LUNs in the system, along with their inquiry data and device type.
962 This only works when the FETDs are enabled, since the commands go through the
965 .Dl ctladm inject 0:6 -i mediumerr -p read -r 0,512 -c
967 Inject a medium error on LUN 6 for every read that covers the first 512
970 .Bd -literal -offset indent
971 ctladm inject 0:6 -i custom -p tur -s 18 "f0 0 02 s12 04 02"
974 Inject a custom error on LUN 6 for the next TEST UNIT READY command only.
975 This will result in a sense key of NOT READY (0x02), and an ASC/ASCQ of
976 0x04,0x02 ("Logical unit not ready, initializing command required").
987 utility was originally written during the Winter/Spring of 2003 as an
990 .An Ken Merry Aq ken@FreeBSD.org