5cc166d4a413e79fab2845343c7ee6a88bd4bb8a
[mirror/scst/.git] / scst / README
1 Generic SCSI target mid-level for Linux (SCST)
2 ==============================================
3
4 Version 1.0.1, X XXXX 2008
5 --------------------------
6
7 SCST is designed to provide unified, consistent interface between SCSI
8 target drivers and Linux kernel and simplify target drivers development
9 as much as possible. Detail description of SCST's features and internals
10 could be found in "Generic SCSI Target Middle Level for Linux" document
11 SCST's Internet page http://scst.sourceforge.net.
12
13 SCST supports the following I/O modes:
14
15  * Pass-through mode with one to many relationship, i.e. when multiple
16    initiators can connect to the exported pass-through devices, for
17    the following SCSI devices types: disks (type 0), tapes (type 1),
18    processors (type 3), CDROMs (type 5), MO disks (type 7), medium
19    changers (type 8) and RAID controllers (type 0xC)
20
21  * FILEIO mode, which allows to use files on file systems or block
22    devices as virtual remotely available SCSI disks or CDROMs with
23    benefits of the Linux page cache
24
25  * BLOCKIO mode, which performs direct block IO with a block device,
26    bypassing page-cache for all operations. This mode works ideally with
27    high-end storage HBAs and for applications that either do not need
28    caching between application and disk or need the large block
29    throughput
30
31  * User space mode using scst_user device handler, which allows to
32    implement in the user space virtual SCSI devices in the SCST
33    environment
34
35  * "Performance" device handlers, which provide in pseudo pass-through
36    mode a way for direct performance measurements without overhead of
37    actual data transferring from/to underlying SCSI device
38
39 In addition, SCST supports advanced per-initiator access and devices
40 visibility management, so different initiators could see different set
41 of devices with different access permissions. See below for details.
42
43
44 Installation
45 ------------
46
47 Only vanilla kernels from kernel.org and RHEL/CentOS 5.2 kernels are
48 supported, but SCST should work on other (vendors') kernels, if you
49 manage to successfully compile on them. The main problem with vendors'
50 kernels is that they often contain patches, which will appear only in
51 the next version of the vanilla kernel, therefore it's quite hard to
52 track such changes. Thus, if during compilation for some vendor kernel
53 your compiler complains about redefinition of some symbol, you should
54 either switch to vanilla kernel, or add or change as necessary the
55 corresponding to that symbol "#if LINUX_VERSION_CODE" statement.
56
57 At first, make sure that the link "/lib/modules/`you_kernel_version`/build" 
58 points to the source code for your currently running kernel.
59
60 Then, since in the mainstream kernels scsi_do_req()/scsi_execute_async()
61 work in LIFO order, instead of expected and required FIFO, SCST needs a
62 new functions scsi_do_req_fifo()/scsi_execute_async_fifo() to be added
63 in the kernel. Patch scst_exec_req_fifo.patch from "kernel" directory
64 does that. If it doesn't apply to your kernel, apply it manually, it
65 only adds one of those functions and nothing more. You may not patch the
66 kernel if you don't need pass-through support or CONFIG_SCST_STRICT_SERIALIZING is
67 defined during the compilation (see description below).
68
69 Then, to get the maximum performance you should apply export_alloc_io_context
70 patch. This patch simply makes alloc_io_context() function be available
71 for modules, not only for built-in in kernel code.
72
73 To compile SCST type 'make scst'. It will build SCST itself and its
74 device handlers. To install them type 'make scst_install'. The driver
75 modules will be installed in '/lib/modules/`you_kernel_version`/extra'.
76 In addition, scst.h, scst_debug.h as well as Module.symvers or
77 Modules.symvers will be copied to '/usr/local/include/scst'. The first
78 file contains all SCST's public data definition, which are used by
79 target drivers. The other ones support debug messages logging and build
80 process.
81
82 Then you can load any module by typing 'modprobe module_name'. The names
83 are:
84
85  - scst - SCST itself
86  - scst_disk - device handler for disks (type 0)
87  - scst_tape - device handler for tapes (type 1)
88  - scst_processor - device handler for processors (type 3)
89  - scst_cdrom - device handler for CDROMs (type 5)
90  - scst_modisk - device handler for MO disks (type 7)
91  - scst_changer - device handler for medium changers (type 8)
92  - scst_raid - device handler for storage array controller (e.g. raid) (type C)
93  - scst_vdisk - device handler for virtual disks (file, device or ISO CD image).
94  - scst_user - user space device handler
95
96 Then, to see your devices remotely, you need to add them to at least
97 "Default" security group (see below how). By default, no local devices
98 are seen remotely. There must be LUN 0 in each security group, i.e. LUs
99 numeration must not start from, e.g., 1.
100
101 It is highly recommended to use scstadmin utility for configuring
102 devices and security groups.
103
104 If you experience problems during modules load or running, check your
105 kernel logs (or run dmesg command for the few most recent messages).
106
107 IMPORTANT: Without loading appropriate device handler, corresponding devices
108 =========  will be invisible for remote initiators, which could lead to holes
109            in the LUN addressing, so automatic device scanning by remote SCSI
110            mid-level could not notice the devices. Therefore you will have
111            to add them manually via
112            'echo "- - -" >/sys/class/scsi_host/hostX/scan',
113            where X - is the host number.
114
115 IMPORTANT: Working of target and initiator on the same host is
116 =========  supported, except the following 2 cases: swap over target exported
117            device and using a writable mmap over a file from target
118            exported device. The latter means you can't mount a file
119            system over target exported device. In other words, you can
120            freely use any sg, sd, st, etc. devices imported from target
121            on the same host, but you can't mount file systems or put
122            swap on them. This is a limitation of Linux memory/cache
123            manager, because in this case an OOM deadlock like: system
124            needs some memory -> it decides to clear some cache -> cache
125            needs to write on target exported device -> initiator sends
126            request to the target -> target needs memory -> system needs
127            even more memory -> deadlock.
128
129 IMPORTANT: In the current version simultaneous access to local SCSI devices
130 =========  via standard high-level SCSI drivers (sd, st, sg, etc.) and
131            SCST's target drivers is unsupported. Especially it is
132            important for execution via sg and st commands that change
133            the state of devices and their parameters, because that could
134            lead to data corruption. If any such command is done, at
135            least related device handler(s) must be restarted. For block
136            devices READ/WRITE commands using direct disk handler look to
137            be safe.
138
139 To uninstall, type 'make scst_uninstall'.
140
141
142 Device handlers
143 ---------------
144
145 Device specific drivers (device handlers) are plugins for SCST, which
146 help SCST to analyze incoming requests and determine parameters,
147 specific to various types of devices. If an appropriate device handler
148 for a SCSI device type isn't loaded, SCST doesn't know how to handle
149 devices of this type, so they will be invisible for remote initiators
150 (more precisely, "LUN not supported" sense code will be returned).
151
152 In addition to device handlers for real devices, there are VDISK, user
153 space and "performance" device handlers.
154
155 VDISK device handler works over files on file systems and makes from
156 them virtual remotely available SCSI disks or CDROM's. In addition, it
157 allows to work directly over a block device, e.g. local IDE or SCSI disk
158 or ever disk partition, where there is no file systems overhead. Using
159 block devices comparing to sending SCSI commands directly to SCSI
160 mid-level via scsi_do_req()/scsi_execute_async() has advantage that data
161 are transferred via system cache, so it is possible to fully benefit from
162 caching and read ahead performed by Linux's VM subsystem. The only
163 disadvantage here that in the FILEIO mode there is superfluous data
164 copying between the cache and SCST's buffers. This issue is going to be
165 addressed in the next release. Virtual CDROM's are useful for remote
166 installation. See below for details how to setup and use VDISK device
167 handler.
168
169 SCST user space device handler provides an interface between SCST and
170 the user space, which allows to create pure user space devices. The
171 simplest example, where one would want it is if he/she wants to write a
172 VTL. With scst_user he/she can write it purely in the user space. Or one
173 would want it if he/she needs some sophisticated for kernel space
174 processing of the passed data, like encrypting them or making snapshots.
175
176 "Performance" device handlers for disks, MO disks and tapes in their
177 exec() method skip (pretend to execute) all READ and WRITE operations
178 and thus provide a way for direct link performance measurements without
179 overhead of actual data transferring from/to underlying SCSI device.
180
181 NOTE: Since "perf" device handlers on READ operations don't touch the
182 ====  commands' data buffer, it is returned to remote initiators as it
183       was allocated, without even being zeroed. Thus, "perf" device
184       handlers impose some security risk, so use them with caution.
185
186
187 Compilation options
188 -------------------
189
190 There are the following compilation options, that could be commented
191 in/out in Makefile:
192
193  - CONFIG_SCST_DEBUG - if defined, turns on some debugging code,
194    including some logging. Makes the driver considerably bigger and slower,
195    producing large amount of log data.
196
197  - CONFIG_SCST_TRACING - if defined, turns on ability to log events. Makes the
198    driver considerably bigger and leads to some performance loss.
199
200  - CONFIG_SCST_EXTRACHECKS - if defined, adds extra validity checks in
201    the various places.
202
203  - CONFIG_SCST_USE_EXPECTED_VALUES - if not defined (default), initiator
204    supplied expected data transfer length and direction will be used only for
205    verification purposes to return error or warn in case if one of them
206    is invalid. Instead, locally decoded from SCSI command values will be
207    used. This is necessary for security reasons, because otherwise a
208    faulty initiator can crash target by supplying invalid value in one
209    of those parameters. This is especially important in case of
210    pass-through mode. If CONFIG_SCST_USE_EXPECTED_VALUES is defined, initiator
211    supplied expected data transfer length and direction will override
212    the locally decoded values. This might be necessary if internal SCST
213    commands translation table doesn't contain SCSI command, which is
214    used in your environment. You can know that if you have messages like
215    "Unknown opcode XX for YY. Should you update scst_scsi_op_table?" in
216    your kernel log and your initiator returns an error. Also report
217    those messages in the SCST mailing list
218    scst-devel@lists.sourceforge.net. Note, that not all SCSI transports
219    support supplying expected values.
220
221  - CONFIG_SCST_DEBUG_TM - if defined, turns on task management functions
222    debugging, when on LUN 0 in the default access control group some of the
223    commands will be delayed for about 60 sec., so making the remote
224    initiator send TM functions, eg ABORT TASK and TARGET RESET. Also
225    define CONFIG_SCST_TM_DBG_GO_OFFLINE symbol in the Makefile if you
226    want that the device eventually become completely unresponsive, or
227    otherwise to circle around ABORTs and RESETs code. Needs CONFIG_SCST_DEBUG
228    turned on.
229
230  - CONFIG_SCST_STRICT_SERIALIZING - if defined, makes SCST send all commands to
231    underlying SCSI device synchronously, one after one. This makes task
232    management more reliable, with cost of some performance penalty. This
233    is mostly actual for stateful SCSI devices like tapes, where the
234    result of command's execution depends from device's settings defined
235    by previous commands. Disk and RAID devices are stateless in the most
236    cases. The current SCSI core in Linux doesn't allow to abort all
237    commands reliably if they sent asynchronously to a stateful device.
238    Turned off by default, turn it on if you use stateful device(s) and
239    need as much error recovery reliability as possible. As a side
240    effect, no kernel patching is necessary.
241
242  - CONFIG_SCST_ALLOW_PASSTHROUGH_IO_SUBMIT_IN_SIRQ - if defined, it will be
243    allowed to submit pass-through commands to real SCSI devices via the SCSI
244    middle layer using scsi_execute_async() function from soft IRQ
245    context (tasklets). This used to be the default, but currently it
246    seems the SCSI middle layer starts expecting only thread context on
247    the IO submit path, so it is disabled now by default. Enabling it
248    will decrease amount of context switches and improve performance. It
249    is more or less safe, in the worst case, if in your configuration the
250    SCSI middle layer really doesn't expect SIRQ context in
251    scsi_execute_async() function, you will get a warning message in the
252    kernel log.
253
254  - CONFIG_SCST_STRICT_SECURITY - if defined, makes SCST zero allocated data
255    buffers. Undefining it (default) considerably improves performance
256    and eases CPU load, but could create a security hole (information
257    leakage), so enable it, if you have strict security requirements.
258
259  - CONFIG_SCST_ABORT_CONSIDER_FINISHED_TASKS_AS_NOT_EXISTING - if defined,
260    in case when TASK MANAGEMENT function ABORT TASK is trying to abort a
261    command, which has already finished, remote initiator, which sent the
262    ABORT TASK request, will receive TASK NOT EXIST (or ABORT FAILED)
263    response for the ABORT TASK request. This is more logical response,
264    since, because the command finished, attempt to abort it failed, but
265    some initiators, particularly VMware iSCSI initiator, consider TASK
266    NOT EXIST response as if the target got crazy and try to RESET it.
267    Then sometimes get crazy itself. So, this option is disabled by
268    default.
269
270  - CONFIG_SCST_MEASURE_LATENCY - if defined, provides in /proc/scsi_tgt/latency
271    file average commands processing latency. You can clear already
272    measured results by writing 0 in this file. Note, you need a
273    non-preemptible kernel to have correct results.
274
275 HIGHMEM kernel configurations are fully supported, but not recommended
276 for performance reasons, except for scst_user, where they are not
277 supported, because this module deals with user supplied memory on a
278 zero-copy manner. If you need to use it, consider change VMSPLIT option
279 or use 64-bit system configuration instead.
280
281 For changing VMSPLIT option (CONFIG_VMSPLIT to be precise) you should in
282 "make menuconfig" command set the following variables:
283
284  - General setup->Configure standard kernel features (for small systems): ON
285
286  - General setup->Prompt for development and/or incomplete code/drivers: ON
287
288  - Processor type and features->High Memory Support: OFF
289
290  - Processor type and features->Memory split: according to amount of
291    memory you have. If it is less than 800MB, you may not touch this
292    option at all.
293
294
295 Module parameters
296 -----------------
297
298 Module scst supports the following parameters:
299
300  - scst_threads - allows to set count of SCST's threads. By default it
301    is CPU count.
302
303  - scst_max_cmd_mem - sets maximum amount of memory in Mb allowed to be
304    consumed by the SCST commands for data buffers at any given time. By
305    default it is approximately TotalMem/4.
306
307
308 SCST "/proc" commands
309 ---------------------
310
311 For communications with user space programs SCST provides proc-based
312 interface in "/proc/scsi_tgt" directory. It contains the following
313 entries:
314
315   - "help" file, which provides online help for SCST commands
316
317   - "scsi_tgt" file, which on read provides information of serving by SCST
318     devices and their dev handlers. On write it supports the following
319     command:
320
321       * "assign H:C:I:L HANDLER_NAME" assigns dev handler "HANDLER_NAME"
322         on device with host:channel:id:lun
323
324   - "sessions" file, which lists currently connected initiators (open sessions)
325
326   - "sgv" file provides some statistic about with which block sizes
327     commands from remote initiators come and how effective sgv_pool in
328     serving those allocations from the cache, i.e. without memory
329     allocations requests to the kernel. "Size" - is the commands data
330     size upper rounded to power of 2, "Hit" - how many there are
331     allocations from the cache, "Total" - total number of allocations.
332
333   - "threads" file, which allows to read and set number of SCST's threads
334
335   - "version" file, which shows version of SCST
336
337   - "trace_level" file, which allows to read and set trace (logging) level
338     for SCST. See "help" file for list of trace levels. If you want to
339     enable logging options, which produce a lot of events, like "debug",
340     to not loose logged events you should also:
341
342      * Increase in .config of your kernel CONFIG_LOG_BUF_SHIFT variable
343        to much bigger value, then recompile it. For example, I use 25,
344        but to use it I needed to modify the maximum allowed value for
345        CONFIG_LOG_BUF_SHIFT in the corresponding Kconfig.
346
347      * Change in your /etc/syslog.conf or other config file of your favorite
348        logging program to store kernel logs in async manner. For example,
349        I added in my rsyslog.conf line "kern.info -/var/log/kernel"
350        and added "kern.none" in line for /var/log/messages, so I had:
351        "*.info;kern.none;mail.none;authpriv.none;cron.none /var/log/messages"
352
353 Each dev handler has own subdirectory. Most dev handler have only two
354 files in this subdirectory: "trace_level" and "type". The first one is
355 similar to main SCST "trace_level" file, the latter one shows SCSI type
356 number of this handler as well as some text description.
357
358 For example, "echo "assign 1:0:1:0 dev_disk" >/proc/scsi_tgt/scsi_tgt"
359 will assign device handler "dev_disk" to real device sitting on host 1,
360 channel 0, ID 1, LUN 0.
361
362
363 Access and devices visibility management (LUN masking)
364 ------------------------------------------------------
365
366 Access and devices visibility management allows for an initiator or
367 group of initiators to see different devices with different LUNs
368 with necessary access permissions.
369
370 SCST supports two modes of access control:
371
372 1. Target-oriented. In this mode you define for each target devices and
373 their LUNs, which are accessible to all initiators, connected to that
374 target. This is a regular access control mode, which people usually mean
375 thinking about access control in general. For instance, in IET this is
376 the only supported mode. In this mode you should create a security group
377 with name "Default_TARGET_NAME", where "TARGET_NAME" is name of the
378 target, like "Default_iqn.2007-05.com.example:storage.disk1.sys1.xyz"
379 for target "iqn.2007-05.com.example:storage.disk1.sys1.xyz". Then you
380 should add to it all LUNs, available from that target.
381
382 2. Initiator-oriented. In this mode you define which devices and their
383 LUNs are accessible for each initiator. In this mode you should create
384 for each set of one or more initiators, which should access to the same
385 set of devices with the same LUNs, a separate security group, then add
386 to it available devices and names of allowed initiator(s).
387
388 Both modes can be used simultaneously. In this case initiator-oriented
389 mode has higher priority, than target-oriented.
390
391 When a target driver registers itself in SCST core, it tells SCST core
392 its name. Then, when there is a new connection from a remote initiator,
393 the target driver registers this connection in SCST core and tells it
394 the name of the remote initiator. Then SCST core finds the corresponding
395 devices for it using the following algorithm:
396
397 1. It searches through all defined groups trying to find group
398 containing the initiator name. If it succeeds, the found group is used.
399
400 2. Otherwise, it searches through all groups trying to find group with
401 name "Default_TARGET_NAME". If it succeeds, the found group is used.
402
403 3. Otherwise, the group with name "Default" is used. This group is
404 always defined, but empty by default.
405
406 Names of both target and initiator you can clarify in the kernel log. In
407 it SCST reports to which group each session is assigned.
408
409 In /proc/scsi_tgt each group represented as "groups/GROUP_NAME/"
410 subdirectory. In it there are files "devices" and "names". File
411 "devices" lists devices and their LUNs in the group, file "names" lists
412 names of initiators, which allowed to access devices in this group.
413
414 To configure access and devices visibility management SCST provides the
415 following files and directories under /proc/scsi_tgt:
416
417   - "add_group GROUP" to /proc/scsi_tgt/scsi_tgt adds group "GROUP"
418
419   - "del_group GROUP" to /proc/scsi_tgt/scsi_tgt deletes group "GROUP"
420
421   - "add H:C:I:L lun [READ_ONLY]" to /proc/scsi_tgt/groups/GROUP/devices adds
422     device with host:channel:id:lun with LUN "lun" in group "GROUP". Optionally,
423     the device could be marked as read only.
424
425   - "del H:C:I:L" to /proc/scsi_tgt/groups/GROUP/devices deletes device with
426     host:channel:id:lun from group "GROUP"
427
428   - "add V_NAME lun [READ_ONLY]" to /proc/scsi_tgt/groups/GROUP/devices adds
429     device with virtual name "V_NAME" with LUN "lun" in group "GROUP".
430     Optionally, the device could be marked as read only.
431
432   - "del V_NAME" to /proc/scsi_tgt/groups/GROUP/devices deletes device with
433     virtual name "V_NAME" from group "GROUP"
434
435   - "clear" to /proc/scsi_tgt/groups/GROUP/devices clears the list of devices
436     for group "GROUP"
437
438   - "add NAME" to /proc/scsi_tgt/groups/GROUP/names adds name "NAME" to group
439     "GROUP". For NAME you can use simple DOS-type patterns, containing
440     '*' and '?' symbols. '*' means match all any symbols, '?' means
441     match only any single symbol. For instance, "blah.xxx" will match
442     "bl?h.*".
443
444   - "del NAME" to /proc/scsi_tgt/groups/GROUP/names deletes name "NAME" from group
445     "GROUP"
446
447   - "clear" to /proc/scsi_tgt/groups/GROUP/names clears the list of names
448     for group "GROUP"
449
450 Examples:
451
452  - "echo "add 1:0:1:0 0" >/proc/scsi_tgt/groups/Default/devices" will
453  add real device sitting on host 1, channel 0, ID 1, LUN 0 to "Default"
454  group with LUN 0.
455
456  - "echo "add disk1 1" >/proc/scsi_tgt/groups/Default/devices" will
457  add virtual VDISK device with name "disk1" to "Default" group
458  with LUN 1.
459
460 - "echo "21:*:e0:?b:83:*'" >/proc/scsi_tgt/groups/LAB1/names" will
461  add a pattern, which matches WWNs of Fibre Channel ports from LAB1.
462
463 Consider you need to have an iSCSI target with name
464 "iqn.2007-05.com.example:storage.disk1.sys1.xyz" (you defined it in
465 iscsi-scst.conf), which should export virtual device "dev1" with LUN 0
466 and virtual device "dev2" with LUN 1, but initiator with name
467 "iqn.2007-05.com.example:storage.disk1.spec_ini.xyz" should see only
468 virtual device "dev2" with LUN 0. To achieve that you should do the
469 following commands:
470
471 # echo "add_group Default_iqn.2007-05.com.example:storage.disk1.sys1.xyz" >/proc/scsi_tgt/scsi_tgt
472 # echo "add dev1 0" >/proc/scsi_tgt/groups/Default_iqn.2007-05.com.example:storage.disk1.sys1.xyz/devices
473 # echo "add dev2 1" >/proc/scsi_tgt/groups/Default_iqn.2007-05.com.example:storage.disk1.sys1.xyz/devices
474
475 # echo "add_group spec_ini" >/proc/scsi_tgt/scsi_tgt
476 # echo "add iqn.2007-05.com.example:storage.disk1.spec_ini.xyz" >/proc/scsi_tgt/groups/spec_ini/names
477 # echo "add dev2 0" >/proc/scsi_tgt/groups/spec_ini/devices
478
479 It is highly recommended to use scstadmin utility instead of described
480 in this section low level interface.
481
482 IMPORTANT
483 =========
484
485 There must be LUN 0 in each security group, i.e. LUs numeration must not
486 start from, e.g., 1.
487
488 IMPORTANT
489 =========
490
491 All the access control must be fully configured BEFORE load of the
492 corresponding target driver! When you load a target driver or enable
493 target mode in it, as for qla2x00t driver, it will immediately start
494 accepting new connections, hence creating new sessions, and those new
495 sessions will be assigned to security groups according to the
496 *currently* configured access control settings. For instance, to
497 "Default" group, instead of "HOST004" as you may need, because "HOST004"
498 doesn't exist yet. So, one must configure all the security groups before
499 new connections from the initiators are created, i.e. before target
500 drivers loaded.
501
502 Access controls can be altered after the target driver loaded as long as
503 the target session doesn't yet exist. And even in the case of the
504 session already existing, changes are still possible, but won't be
505 reflected on the initiator side.
506
507 So, the safest choice is to configure all the access control before any
508 target driver load and then only add new devices to new groups for new
509 initiators or add new devices to old groups, but not altering existing
510 LUNs in them.
511
512
513 VDISK device handler
514 --------------------
515
516 After loading VDISK device handler creates in "/proc/scsi_tgt/"
517 subdirectories "vdisk" and "vcdrom". They have similar layout:
518
519   - "trace_level" and "type" files as described for other dev handlers
520
521   - "help" file, which provides online help for VDISK commands
522
523   - "vdisk"/"vcdrom" files, which on read provides information of
524     currently open device files. On write it supports the following
525     command:
526
527     * "open NAME [PATH] [BLOCK_SIZE] [FLAGS]" - opens file "PATH" as
528       device "NAME" with block size "BLOCK_SIZE" bytes with flags
529       "FLAGS". "PATH" could be empty only for VDISK CDROM. "BLOCK_SIZE"
530       and "FLAGS" are valid only for disk VDISK. The block size must be
531       power of 2 and >= 512 bytes. Default is 512. Possible flags:
532
533       - WRITE_THROUGH - write back caching disabled. Note, this option
534         has sense only if you also *manually* disable write-back cache
535         in *all* your backstorage devices and make sure it's actually
536         disabled, since many devices are known to lie about this mode to
537         get better benchmark results.
538
539       - READ_ONLY - read only
540
541       - O_DIRECT - both read and write caching disabled. This mode
542         isn't currently fully implemented, you should use user space
543         fileio_tgt program in O_DIRECT mode instead (see below).
544
545       - NULLIO - in this mode no real IO will be done, but success will be
546         returned. Intended to be used for performance measurements at the same
547         way as "*_perf" handlers.
548
549       - NV_CACHE - enables "non-volatile cache" mode. In this mode it is
550         assumed that the target has a GOOD UPS with ability to cleanly
551         shutdown target in case of power failure and it is
552         software/hardware bugs free, i.e. all data from the target's
553         cache are guaranteed sooner or later to go to the media. Hence
554         all data synchronization with media operations, like
555         SYNCHRONIZE_CACHE, are ignored in order to bring more
556         performance. Also in this mode target reports to initiators that
557         the corresponding device has write-through cache to disable all
558         write-back cache workarounds used by initiators. Use with
559         extreme caution, since in this mode after a crash of the target
560         journaled file systems don't guarantee the consistency after
561         journal recovery, therefore manual fsck MUST be ran. Note, that
562         since usually the journal barrier protection (see "IMPORTANT"
563         note below) turned off, enabling NV_CACHE could change nothing
564         from data protection point of view, since no data
565         synchronization with media operations will go from the
566         initiator. This option overrides WRITE_THROUGH.
567
568       - BLOCKIO - enables block mode, which will perform direct block
569         IO with a block device, bypassing page-cache for all operations.
570         This mode works ideally with high-end storage HBAs and for
571         applications that either do not need caching between application
572         and disk or need the large block throughput. See also below.
573
574       - REMOVABLE - with this flag set the device is reported to remote
575         initiators as removable.
576
577     * "close NAME" - closes device "NAME".
578
579     * "resync_size NAME" - refreshes size of device "NAME". Intended to be
580       used after device resize.
581
582     * "change NAME [PATH]" - changes a virtual CD in the VDISK CDROM.
583
584 By default, if neither BLOCKIO, nor NULLIO option is supplied, FILEIO
585 mode is used.
586
587 For example, "echo "open disk1 /vdisks/disk1" >/proc/scsi_tgt/vdisk/vdisk"
588 will open file /vdisks/disk1 as virtual FILEIO disk with name "disk1".
589
590 CAUTION: If you partitioned/formatted your device with block size X, *NEVER*
591 ======== ever try to export and then mount it (even accidentally) with another
592          block size. Otherwise you can *instantly* damage it pretty
593          badly as well as all your data on it. Messages on initiator
594          like: "attempt to access beyond end of device" is the sign of
595          such damage.
596
597          Moreover, if you want to compare how well different block sizes
598          work for you, you **MUST** EVERY TIME AFTER CHANGING BLOCK SIZE
599          **COMPLETELY** **WIPE OFF** ALL THE DATA FROM THE DEVICE. In
600          other words, THE **WHOLE** DEVICE **MUST** HAVE ONLY **ZEROS**
601          AS THE DATA AFTER YOU SWITCH TO NEW BLOCK SIZE. Switching block
602          sizes isn't like switching between FILEIO and BLOCKIO, after
603          changing block size all previously written with another block
604          size data MUST BE ERASED. Otherwise you will have a full set of
605          very weird behaviors, because blocks addressing will be
606          changed, but initiators in most cases will not have a
607          possibility to detect that old addresses written on the device
608          in, e.g., partition table, don't refer anymore to what they are
609          intended to refer.
610
611 IMPORTANT: By default for performance reasons VDISK FILEIO devices use write
612 =========  back caching policy. This is generally safe from the consistence of
613            journaled file systems, laying over them, point of view, but
614            your unsaved cached data will be lost in case of
615            power/hardware/software failure, so you must supply your
616            target server with some kind of UPS or disable write back
617            caching using WRITE_THROUGH flag. You also should note, that
618            the file systems journaling over write back caching enabled
619            devices works reliably *ONLY* if the order of journal writes
620            is guaranteed or it uses some kind of data protection
621            barriers (i.e. after writing journal data some kind of
622            synchronization with media operations is used), otherwise,
623            because of possible reordering in the cache, even after
624            successful journal rollback, you very much risk to loose your
625            data on the FS. Currently, Linux IO subsystem guarantees
626            order of write operations only using data protection
627            barriers. Some info about it from the XFS point of view could
628            be found at http://oss.sgi.com/projects/xfs/faq.html#wcache.
629            On Linux initiators for EXT3 and ReiserFS file systems the
630            barrier protection could be turned on using "barrier=1" and
631            "barrier=flush" mount options correspondingly. Note, that
632            usually it's turned off by default (see http://lwn.net/Articles/283161).
633            You can check if it's turn on or off by looking in /proc/mounts.
634            Windows and, AFAIK, other UNIX'es don't need any special
635            explicit options and do necessary barrier actions on
636            write-back caching devices by default. Also note
637            that on some real-life workloads write through caching might
638            perform better, than write back one with the barrier
639            protection turned on.
640            Also you should realize that Linux doesn't provide a
641            guarantee that after sync()/fsync() all written data really
642            hit permanent storage, they can be then in the cache of your
643            backstorage device and lost on power failure event. Thus,
644            ever with write-through cache mode, you still need a good UPS
645            to protect yourself from your data loss (note, data loss, not
646            the file system integrity corruption).
647
648 IMPORTANT: Some disk and partition table management utilities don't support
649 =========  block sizes >512 bytes, therefore make sure that your favorite one
650            supports it. Currently only cfdisk is known to work only with
651            512 bytes blocks, other utilities like fdisk on Linux or
652            standard disk manager on Windows are proved to work well with
653            non-512 bytes blocks. Note, if you export a disk file or
654            device with some block size, different from one, with which
655            it was already partitioned, you could get various weird
656            things like utilities hang up or other unexpected behavior.
657            Hence, to be sure, zero the exported file or device before
658            the first access to it from the remote initiator with another
659            block size. On Window initiator make sure you "Set Signature"
660            in the disk manager on the imported from the target drive
661            before doing any other partitioning on it. After you
662            successfully mounted a file system over non-512 bytes block
663            size device, the block size stops matter, any program will
664            work with files on such file system.
665
666
667 BLOCKIO VDISK mode
668 ------------------
669
670 This module works best for these types of scenarios:
671
672 1) Data that are not aligned to 4K sector boundaries and <4K block sizes
673 are used, which is normally found in virtualization environments where
674 operating systems start partitions on odd sectors (Windows and it's
675 sector 63).
676
677 2) Large block data transfers normally found in database loads/dumps and
678 streaming media.
679
680 3) Advanced relational database systems that perform their own caching
681 which prefer or demand direct IO access and, because of the nature of
682 their data access, can actually see worse performance with
683 non-discriminate caching.
684
685 4) Multiple layers of targets were the secondary and above layers need
686 to have a consistent view of the primary targets in order to preserve
687 data integrity which a page cache backed IO type might not provide
688 reliably.
689
690 Also it has an advantage over FILEIO that it doesn't copy data between
691 the system cache and the commands data buffers, so it saves a
692 considerable amount of CPU power and memory bandwidth.
693
694 IMPORTANT: Since data in BLOCKIO and FILEIO modes are not consistent between
695 =========  them, if you try to use a device in both those modes simultaneously,
696            you will almost instantly corrupt your data on that device.
697
698
699 Pass-through mode
700 -----------------
701
702 In the pass-through mode (i.e. using the pass-through device handlers
703 scst_disk, scst_tape, etc) SCSI commands, coming from remote initiators,
704 are passed to local SCSI hardware on target as is, without any
705 modifications. As any other hardware, the local SCSI hardware can not
706 handle commands with amount of data and/or segments count in
707 scatter-gather array bigger some values. Therefore, when using the
708 pass-through mode you should note that values for maximum number of
709 segments and maximum amount of transferred data for each SCSI command on
710 devices on initiators can not be bigger, than corresponding values of
711 the corresponding SCSI devices on the target. Otherwise you will see
712 symptoms like small transfers work well, but large ones stall and
713 messages like: "Unable to complete command due to SG IO count
714 limitation" are printed in the kernel logs.
715
716 You can't control from the user space limit of the scatter-gather
717 segments, but for block devices usually it is sufficient if you set on
718 the initiators /sys/block/DEVICE_NAME/queue/max_sectors_kb in the same
719 or lower value as in /sys/block/DEVICE_NAME/queue/max_hw_sectors_kb for
720 the corresponding devices on the target.
721
722 For not-block devices SCSI commands are usually generated directly by
723 applications, so, if you experience large transfers stalls, you should
724 check documentation for your application how to limit the transfer
725 sizes.
726
727 Another way to solve this issue is to build SG entries with more than 1
728 page each. See the following patch as an example:
729 http://scst.sf.net/sgv_big_order_alloc.diff
730
731
732 User space mode using scst_user dev handler
733 -------------------------------------------
734
735 User space program fileio_tgt uses interface of scst_user dev handler
736 and allows to see how it works in various modes. Fileio_tgt provides
737 mostly the same functionality as scst_vdisk handler with the most
738 noticeable difference that it supports O_DIRECT mode. O_DIRECT mode is
739 basically the same as BLOCKIO, but also supports files, so for some
740 loads it could be significantly faster, than the regular FILEIO access.
741 All the words about BLOCKIO from above apply to O_DIRECT as well. See
742 fileio_tgt's README file for more details.
743
744
745 Performance
746 -----------
747
748 Before doing any performance measurements note that:
749
750 I. Performance results are very much dependent from your type of load,
751 so it is crucial that you choose access mode (FILEIO, BLOCKIO,
752 O_DIRECT, pass-through), which suits your needs the best.
753
754 II. In order to get the maximum performance you should:
755
756 1. For SCST:
757
758  - Disable in Makefile CONFIG_SCST_STRICT_SERIALIZING, CONFIG_SCST_EXTRACHECKS,
759    CONFIG_SCST_TRACING, CONFIG_SCST_DEBUG*, CONFIG_SCST_STRICT_SECURITY
760
761  - For pass-through devices enable
762    CONFIG_SCST_ALLOW_PASSTHROUGH_IO_SUBMIT_IN_SIRQ.
763
764 2. For target drivers:
765
766  - Disable in Makefiles CONFIG_SCST_EXTRACHECKS, CONFIG_SCST_TRACING,
767    CONFIG_SCST_DEBUG*
768
769 3. For device handlers, including VDISK:
770
771  - Disable in Makefile CONFIG_SCST_TRACING and CONFIG_SCST_DEBUG.
772
773
774 IMPORTANT: Some of the above compilation options in the SCST SVN enabled by default,
775 =========  i.e. development version of SCST is optimized currently rather for
776            development and bug hunting, than for performance.
777
778 If you use SCST version taken directly from the SVN repository, you can
779 set the above options, except CONFIG_SCST_ALLOW_PASSTHROUGH_IO_SUBMIT_IN_SIRQ,
780 in the needed values using debug2perf root Makefile target.
781
782 4. For other target and initiator software parts:
783
784  - Don't enable debug/hacking features in the kernel, i.e. use them as
785    they are by default.
786
787  - The default kernel read-ahead and queuing settings are optimized
788    for locally attached disks, therefore they are not optimal if they
789    attached remotely (SCSI target case), which sometimes could lead to
790    unexpectedly low throughput. You should increase read-ahead size to at
791    least 512KB or even more on all initiators and the target.
792
793    You should also limit on all initiators maximum amount of sectors per
794    SCSI command. To do it on Linux initiators, run:
795
796    echo “64” > /sys/block/sdX/queue/max_sectors_kb
797
798    where specify instead of X your imported from target device letter,
799    like 'b', i.e. sdb.
800
801    To increase read-ahead size on Linux, run:
802
803    blockdev --setra N /dev/sdX
804
805    where N is a read-ahead number in 512-byte sectors and X is a device
806    letter like above.
807
808    Note: you need to set read-ahead setting for device sdX again after
809    you changed the maximum amount of sectors per SCSI command for that
810    device.
811
812  - You may need to increase amount of requests that OS on initiator
813    sends to the target device. To do it on Linux initiators, run
814
815    echo “64” > /sys/block/sdX/queue/nr_requests
816
817    where X is a device letter like above.
818
819    You may also experiment with other parameters in /sys/block/sdX
820    directory, they also affect performance. If you find the best values,
821    please share them with us.
822
823  - On the target CFQ IO scheduler. In most cases it has performance
824    advantage over other IO schedulers, sometimes huge (2+ times
825    aggregate throughput increase).
826
827  - It is recommended to turn the kernel preemption off, i.e. set
828    the kernel preemption model to "No Forced Preemption (Server)".
829
830  - Looks like XFS is the best filesystem on the target to store device
831    files, because it allows considerably better linear write throughput,
832    than ext3.
833
834 5. For hardware on target.
835
836  - Make sure that your target hardware (e.g. target FC or network card)
837    and underlaying IO hardware (e.g. IO card, like SATA, SCSI or RAID to
838    which your disks connected) don't share the same PCI bus. You can
839    check it using lspci utility. They have to work in parallel, so it
840    will be better if they don't compete for the bus. The problem is not
841    only in the bandwidth, which they have to share, but also in the
842    interaction between cards during that competition. This is very
843    important, because in some cases if target and backend storage
844    controllers share the same PCI bus, it could lead up to 5-10 times
845    less performance, than expected. Moreover, some motherboard (by
846    Supermicro, particularly) have serious stability issues if there are
847    several high speed devices on the same bus working in parallel. If
848    you have no choice, but PCI bus sharing, set in the BIOS PCI latency
849    as low as possible.
850
851 6. If you use VDISK IO module in FILEIO mode, NV_CACHE option will
852 provide you the best performance. But using it make sure you use a good
853 UPS with ability to shutdown the target on the power failure.
854
855 Baseline performance numbers you can find in those measurements:
856 http://lkml.org/lkml/2009/3/30/283.
857
858 IMPORTANT: If you use on initiator some versions of Windows (at least W2K)
859 =========  you can't get good write performance for VDISK FILEIO devices with
860            default 512 bytes block sizes. You could get about 10% of the
861            expected one. This is because of the partition alignment, which
862            is (simplifying) incompatible with how Linux page cache
863            works, so for each write the corresponding block must be read
864            first. Use 4096 bytes block sizes for VDISK devices and you
865            will have the expected write performance. Actually, any OS on
866            initiators, not only Windows, will benefit from block size
867            max(PAGE_SIZE, BLOCK_SIZE_ON_UNDERLYING_FS), where PAGE_SIZE
868            is the page size, BLOCK_SIZE_ON_UNDERLYING_FS is block size
869            on the underlying FS, on which the device file located, or 0,
870            if a device node is used. Both values are from the target.
871            See also important notes about setting block sizes >512 bytes
872            for VDISK FILEIO devices above.
873
874
875 In some cases, for instance working with SSD devices, which consume 100%
876 of a single CPU load for data transfers in their internal threads, to
877 maximize IOPS it can be needed to assign for those threads dedicated
878 CPUs using Linux CPU affinity facilities. No IRQ processing should be
879 done on those CPUs. Check that using /proc/interrupts. See taskset
880 command and Documentation/IRQ-affinity.txt in your kernel's source tree
881 for how to assign IRQ affinity to tasks and IRQs.
882
883 The reason for that is that processing of coming commands in SIRQ
884 context might be done on the same CPUs as SSD devices' threads doing data
885 transfers. As the result, those threads won't receive all the processing
886 power of those CPUs and perform worse.
887
888
889 Work if target's backstorage or link is too slow
890 ------------------------------------------------
891
892 Under high I/O load, when your target's backstorage gets overloaded, or
893 working over a slow link between initiator and target, when the link
894 can't serve all the queued commands on time, you can experience I/O
895 stalls or see in the kernel log abort or reset messages.
896
897 At first, consider the case of too slow target's backstorage. On some
898 seek intensive workloads even fast disks or RAIDs, which able to serve
899 continuous data stream on 500+ MB/s speed, can be as slow as 0.3 MB/s.
900 Another possible cause for that can be MD/LVM/RAID on your target as in
901 http://lkml.org/lkml/2008/2/27/96 (check the whole thread as well).
902
903 Thus, in such situations simply processing of one or more commands takes
904 too long time, hence initiator decides that they are stuck on the target
905 and tries to recover. Particularly, it is known that the default amount
906 of simultaneously queued commands (48) is sometimes too high if you do
907 intensive writes from VMware on a target disk, which uses LVM in the
908 snapshot mode. In this case value like 16 or even 8-10 depending of your
909 backstorage speed could be more appropriate.
910
911 Unfortunately, currently SCST lacks dynamic I/O flow control, when the
912 queue depth on the target is dynamically decreased/increased based on
913 how slow/fast the backstorage speed comparing to the target link. So,
914 there are 6 possible actions, which you can do to workaround or fix this
915 issue in this case:
916
917 1. Ignore incoming task management (TM) commands. It's fine if there are
918 not too many of them, so average performance isn't hurt and the
919 corresponding device isn't getting put offline, i.e. if the backstorage
920 isn't too slow.
921
922 2. Decrease /sys/block/sdX/device/queue_depth on the initiator in case
923 if it's Linux (see below how) or/and SCST_MAX_TGT_DEV_COMMANDS constant
924 in scst_priv.h file until you stop seeing incoming TM commands.
925 ISCSI-SCST driver also has its own iSCSI specific parameter for that,
926 see its README file.
927
928 To decrease device queue depth on Linux initiators you can run command:
929
930 # echo Y >/sys/block/sdX/device/queue_depth
931
932 where Y is the new number of simultaneously queued commands, X - your
933 imported device letter, like 'a' for sda device. There are no special
934 limitations for Y value, it can be any value from 1 to possible maximum
935 (usually, 32), so start from dividing the current value on 2, i.e. set
936 16, if /sys/block/sdX/device/queue_depth contains 32.
937
938 3. Increase the corresponding timeout on the initiator. For Linux it is
939 located in
940 /sys/devices/platform/host*/session*/target*:0:0/*:0:0:1/timeout. It can
941 be done automatically by an udev rule. For instance, the following
942 rule will increase it to 300 seconds:
943
944 SUBSYSTEM=="scsi", KERNEL=="[0-9]*:[0-9]*", ACTION=="add", ATTR{type}=="0|7|14", ATTR{timeout}="300"
945
946 By default, this timeout is 30 or 60 seconds, depending on your distribution.
947
948 4. Try to avoid such seek intensive workloads.
949
950 5. Increase speed of the target's backstorage.
951
952 6. Implement in SCST dynamic I/O flow control. This will be an ultimate
953 solution. See "Dynamic I/O flow control" section on
954 http://scst.sourceforge.net/contributing.html page for possible
955 implementation idea.
956
957 Next, consider the case of too slow link between initiator and target,
958 when the initiator tries to simultaneously push N commands to the target
959 over it. In this case time to serve those commands, i.e. send or receive
960 data for them over the link, can be more, than timeout for any single
961 command, hence one or more commands in the tail of the queue can not be
962 served on time less than the timeout, so the initiator will decide that
963 they are stuck on the target and will try to recover.
964
965 To workaround/fix this issue in this case you can use ways 1, 2, 3, 6
966 above or (7): increase speed of the link between target and initiator.
967 But for some initiators implementations for WRITE commands there might
968 be cases when target has no way to detect the issue, so dynamic I/O flow
969 control will not be able to help. In those cases you could also need on
970 the initiator(s) to either decrease the queue depth (way 2), or increase
971 the corresponding timeout (way 3).
972
973 Note, that logged messages about QUEUE_FULL status are quite different
974 by nature. This is a normal work, just SCSI flow control in action.
975 Simply don't enable "mgmt_minor" logging level, or, alternatively, if
976 you are confident in the worst case performance of your back-end storage
977 or initiator-target link, you can increase SCST_MAX_TGT_DEV_COMMANDS in
978 scst_priv.h to 64. Usually initiators don't try to push more commands on
979 the target.
980
981
982 Credits
983 -------
984
985 Thanks to:
986
987  * Mark Buechler <mark.buechler@gmail.com> for a lot of useful
988    suggestions, bug reports and help in debugging.
989
990  * Ming Zhang <mingz@ele.uri.edu> for fixes and comments.
991
992  * Nathaniel Clark <nate@misrule.us> for fixes and comments.
993
994  * Calvin Morrow <calvin.morrow@comcast.net> for testing and useful
995    suggestions.
996
997  * Hu Gang <hugang@soulinfo.com> for the original version of the
998    LSI target driver.
999
1000  * Erik Habbinga <erikhabbinga@inphase-tech.com> for fixes and support
1001    of the LSI target driver.
1002
1003  * Ross S. W. Walker <rswwalker@hotmail.com> for the original block IO
1004    code and Vu Pham <huongvp@yahoo.com> who updated it for the VDISK dev
1005    handler.
1006
1007  * Michael G. Byrnes <michael.byrnes@hp.com> for fixes.
1008
1009  * Alessandro Premoli <a.premoli@andxor.it> for fixes
1010
1011  * Nathan Bullock <nbullock@yottayotta.com> for fixes.
1012
1013  * Terry Greeniaus <tgreeniaus@yottayotta.com> for fixes.
1014
1015  * Krzysztof Blaszkowski <kb@sysmikro.com.pl> for many fixes and bug reports.
1016
1017  * Jianxi Chen <pacers@users.sourceforge.net> for fixing problem with
1018    devices >2TB in size
1019
1020  * Bart Van Assche <bart.vanassche@gmail.com> for a lot of help
1021
1022 Vladislav Bolkhovitin <vst@vlnb.net>, http://scst.sourceforge.net