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