2 CTL - CAM Target Layer Description
4 Revision 1.4 (December 29th, 2011)
5 Ken Merry <ken@FreeBSD.org>
12 Configuring and Running CTL
21 CTL is a disk, processor and cdrom device emulation subsystem originally
22 written for Copan Systems under Linux starting in 2003. It has been
23 shipping in Copan (now SGI) products since 2005.
25 It was ported to FreeBSD in 2008, and thanks to an agreement between SGI
26 (who acquired Copan's assets in 2010) and Spectra Logic in 2010, CTL is
27 available under a BSD-style license. The intent behind the agreement was
28 that Spectra would work to get CTL into the FreeBSD tree.
33 - Disk, processor and cdrom device emulation.
35 - SCSI task attribute support (ordered, head of queue, simple tags)
36 - SCSI implicit command ordering support. (e.g. if a read follows a mode
37 select, the read will be blocked until the mode select completes.)
38 - Full task management support (abort, LUN reset, target reset, etc.)
39 - Support for multiple ports
40 - Support for multiple simultaneous initiators
41 - Support for multiple simultaneous backing stores
42 - Support for VMWare VAAI: COMPARE AND WRITE, XCOPY, WRITE SAME and
44 - Support for Microsoft ODX: POPULATE TOKEN/WRITE USING TOKEN, WRITE SAME
46 - Persistent reservation support
47 - Mode sense/select support
48 - Error injection support
49 - High Availability clustering support with ALUA
50 - All I/O handled in-kernel, no userland context switch overhead.
52 Configuring and Running CTL:
53 ===========================
55 - Add 'device ctl' to your kernel configuration file or load the module.
57 - If you're running with a 8Gb or 4Gb Qlogic FC board, add
58 'options ISP_TARGET_MODE' to your kernel config file. 'device ispfw' or
59 loading the ispfw module is also recommended.
61 - Rebuild and install a new kernel.
63 - Reboot with the new kernel.
65 - To add a LUN with the RAM disk backend:
67 ctladm create -b ramdisk -s 10485760000000000000
70 - You should now see the CTL disk LUN through camcontrol devlist:
72 scbus6 on ctl2cam0 bus 0:
73 <FREEBSD CTLDISK 0001> at scbus6 target 1 lun 0 (da24,pass32)
74 <> at scbus6 target -1 lun -1 ()
76 This is visible through the CTL CAM SIM. This allows using CTL without
77 any physical hardware. You should be able to issue any normal SCSI
78 commands to the device via the pass(4)/da(4) devices.
80 If any target-capable HBAs are in the system (e.g. isp(4)), and have
81 target mode enabled, you should now also be able to see the CTL LUNs via
82 that target interface.
84 Note that all CTL LUNs are presented to all frontends. There is no
85 LUN masking, or separate, per-port configuration.
87 - Note that the ramdisk backend is a "fake" ramdisk. That is, it is
88 backed by a small amount of RAM that is used for all I/O requests. This
89 is useful for performance testing, but not for any data integrity tests.
91 - To add a LUN with the block/file backend:
93 truncate -s +1T myfile
94 ctladm create -b block -o file=myfile
97 - You can also see a list of LUNs and their backends like this:
100 LUN Backend Size (Blocks) BS Serial Number Device ID
101 0 block 2147483648 512 MYSERIAL 0 MYDEVID 0
102 1 block 2147483648 512 MYSERIAL 1 MYDEVID 1
103 2 block 2147483648 512 MYSERIAL 2 MYDEVID 2
104 3 block 2147483648 512 MYSERIAL 3 MYDEVID 3
105 4 block 2147483648 512 MYSERIAL 4 MYDEVID 4
106 5 block 2147483648 512 MYSERIAL 5 MYDEVID 5
107 6 block 2147483648 512 MYSERIAL 6 MYDEVID 6
108 7 block 2147483648 512 MYSERIAL 7 MYDEVID 7
109 8 block 2147483648 512 MYSERIAL 8 MYDEVID 8
110 9 block 2147483648 512 MYSERIAL 9 MYDEVID 9
111 10 block 2147483648 512 MYSERIAL 10 MYDEVID 10
112 11 block 2147483648 512 MYSERIAL 11 MYDEVID 11
114 - You can see the LUN type and backing store for block/file backend LUNs
118 LUN Backend Size (Blocks) BS Serial Number Device ID
119 0 block 2147483648 512 MYSERIAL 0 MYDEVID 0
123 1 block 2147483648 512 MYSERIAL 1 MYDEVID 1
127 2 block 2147483648 512 MYSERIAL 2 MYDEVID 2
131 3 block 2147483648 512 MYSERIAL 3 MYDEVID 3
135 4 block 2147483648 512 MYSERIAL 4 MYDEVID 4
139 5 block 2147483648 512 MYSERIAL 5 MYDEVID 5
143 6 block 2147483648 512 MYSERIAL 6 MYDEVID 6
147 7 block 2147483648 512 MYSERIAL 7 MYDEVID 7
151 8 block 2147483648 512 MYSERIAL 8 MYDEVID 8
155 9 block 2147483648 512 MYSERIAL 9 MYDEVID 9
159 10 ramdisk 0 0 MYSERIAL 0 MYDEVID 0
161 11 ramdisk 204800000000000 512 MYSERIAL 1 MYDEVID 1
166 - Added in the second HA mode (where CTL does the data transfers instead
167 of having data transfers done below CTL), and abstracted out the Copan
170 - Fixed the phantom device problem in the CTL CAM SIM and improved the
171 CAM SIM to automatically trigger a rescan when the port is enabled and
174 - Made the number of threads in the block backend configurable via sysctl,
175 loader tunable and the ctladm command line. (You can now specify
176 -o num_threads=4 when creating a LUN with ctladm create.)
178 - Fixed some LUN selection issues in ctlstat(8) and allowed for selection
179 of LUN numbers up to 1023.
183 - This version intended for public release.
187 - Added descriptor sense support to CTL. It can be enabled through the
188 control mode page (10), but is disabled by default.
190 - Improved error injection support. The number of errors that can be
191 injected with 'ctladm inject' has been increased, and any arbitrary
192 sense data may now be injected as well.
194 - The port infrastructure has been revamped. Individual ports and types
195 of ports may now be enabled and disabled from the command line. ctladm
196 now has the ability to set the WWNN and WWPN for each port.
198 - The block backend can now send multiple I/Os to backing files. Multiple
199 writes are only allowed for ZFS, but multiple readers are allowed for
202 - The block and ramdisk backends now support setting the LUN blocksize.
203 There are some restrictions when the backing device is a block device,
204 but otherwise the blocksize may be set to anything.
209 - CTL initialization process has been revamped. Instead of using an
210 ad-hoc method, it is now sequenced through SYSINIT() calls.
212 - A block/file backend has been added. This allows using arbitrary files
213 or block devices as a backing store.
215 - The userland LUN configuration interface has been completely rewritten.
216 Configuration is now done out of band.
218 - The ctladm(8) command line interface has been revamped, and is now
219 similar to camcontrol(8).
224 - Use devstat(9) for CTL's statistics collection. CTL uses a home-grown
225 statistics collection system that is similar to devstat(9). ctlstat
226 should be retired in favor of iostat, etc., once aggregation modes are
227 available in iostat to match the behavior of ctlstat -t and dump modes
228 are available to match the behavior of ctlstat -d/ctlstat -J.
230 - ZFS ARC backend for CTL. Since ZFS copies all I/O into the ARC
231 (Adaptive Replacement Cache), running the block/file backend on top of a
232 ZFS-backed zdev or file will involve an extra set of copies. The
233 optimal solution for backing targets served by CTL with ZFS would be to
234 allocate buffers out of the ARC directly, and DMA to/from them directly.
235 That would eliminate an extra data buffer allocation and copy.
237 - Switch CTL over to using CAM CCBs instead of its own union ctl_io. This
238 will likely require a significant amount of work, but will eliminate
239 another data structure in the stack, more memory allocations, etc. This
240 will also require changes to the CAM CCB structure to support CTL.
245 CTL has the concept of pluggable frontend ports and backends. All
246 frontends and backends can be active at the same time. You can have a
247 ramdisk-backed LUN present along side a file backed LUN.
252 This is the core of CTL, where all of the command handlers and a lot of
253 other things live. Yes, it is large. It started off small and grew to its
254 current size over time. Perhaps it can be split into more files at some
257 Here is a roadmap of some of the primary functions in ctl.c. Starting here
258 and following the various leaf functions will show the command flow.
260 ctl_queue() / ctl_run() This is where commands from the frontend ports come
263 ctl_queue_sense() This is only used for non-packetized SCSI. i.e.
264 parallel SCSI prior to U320 and perhaps U160.
266 ctl_work_thread() This is the primary work thread, and everything gets
269 ctl_scsiio_precheck() This where all of the initial checks are done, and I/O
270 is either queued for execution or blocked.
272 ctl_scsiio() This is where the command handler is actually
273 executed. (See ctl_cmd_table.c for the mapping of
274 SCSI opcode to command handler function.)
276 ctl_done() This is the routine called (or ctl_done_lock()) to
277 initiate the command completion process.
279 ctl_process_done() This is where command completion actually happens.
284 Basic function declarations and data structures.
290 These files define the basic CTL backend API. The comments in the header
296 The block and file backend. This allows for using a disk or a file as the
297 backing store for a LUN. Multiple threads are started to do I/O to the
298 backing device, primarily because the VFS API requires that to get any
301 ctl_backend_ramdisk.c:
302 ---------------------
304 A "fake" ramdisk backend. It only allocates a small amount of memory to
305 act as a source and sink for reads and writes from an initiator. Therefore
306 it cannot be used for any real data, but it can be used to test for
307 throughput. It can also be used to test initiators' support for extremely
313 This is a table with all 256 possible SCSI opcodes, and command handler
314 functions defined for supported opcodes. It is included in ctl.c.
319 Simplistic debugging support.
325 CTL-specific wrappers around the CAM sense building functions.
331 These files define the basic CTL frontend port API. The comments in the
332 header explain the API.
334 ctl_frontend_cam_sim.c:
335 ----------------------
337 This is a CTL frontend port that is also a CAM SIM. The idea is that this
338 frontend allows for using CTL without any target-capable hardware. So any
339 LUNs you create in CTL are visible via this port.
345 This is a High Availability API and TCP-based interlink implementation.
350 This defines most of the core CTL I/O structures. union ctl_io is
351 conceptually very similar to CAM's union ccb.
356 This defines all ioctls available through the CTL character device, and
357 the data structures needed for those ioctls.
362 Private data structres (e.g. CTL softc) and function prototypes. This also
363 includes the SCSI vendor and product names used by CTL.
369 CTL wrappers around CAM sense printing functions.
374 Command serialization table. This defines what happens when one type of
375 command is followed by another type of command. e.g., what do you do when
376 you have a mode select followed by a write? You block the write until the
377 mode select is complete. That is defined in this table.
383 CTL utility functions, primarily designed to be used from userland. See
384 ctladm for the primary consumer of these functions. These include CDB
390 CAM target peripheral driver and CTL frontend port. This is the path into
391 CTL for commands from target-capable hardware/SIMs.
396 ctladm(8) fills a role similar to camcontrol(8). It allow configuring LUNs,
397 issuing commands, injecting errors and various other control functions.
399 ctlstat(8) fills a role similar to iostat(8). It reports I/O statistics