66c2d4bfcdcf3e93249fa250894dcbdb1109e11a
[mirror/scst/.git] / scst / include / scst.h
1 /*
2  *  include/scst.h
3  *
4  *  Copyright (C) 2004 - 2009 Vladislav Bolkhovitin <vst@vlnb.net>
5  *  Copyright (C) 2004 - 2005 Leonid Stoljar
6  *  Copyright (C) 2007 - 2009 ID7 Ltd.
7  *
8  *  Main SCSI target mid-level include file.
9  *
10  *  This program is free software; you can redistribute it and/or
11  *  modify it under the terms of the GNU General Public License
12  *  as published by the Free Software Foundation, version 2
13  *  of the License.
14  *
15  *  This program is distributed in the hope that it will be useful,
16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  *  GNU General Public License for more details.
19  */
20
21 #ifndef __SCST_H
22 #define __SCST_H
23
24 #include <linux/types.h>
25 #include <linux/version.h>
26 #include <linux/blkdev.h>
27 #include <linux/interrupt.h>
28 #include <linux/wait.h>
29
30 #define CONFIG_SCST_PROC
31
32 #ifdef CONFIG_SCST_PROC
33 #include <linux/proc_fs.h>
34 #include <linux/seq_file.h>
35 #endif
36
37 #include <scsi/scsi_cmnd.h>
38 #include <scsi/scsi_device.h>
39 #include <scsi/scsi_eh.h>
40 #include <scsi/scsi.h>
41
42 #include <scst_const.h>
43
44 #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 19)
45 #ifndef RHEL_RELEASE_CODE
46 typedef _Bool bool;
47 #endif
48 #define true  1
49 #define false 0
50 #endif
51
52 #include "scst_sgv.h"
53
54 /*
55  * Version numbers, the same as for the kernel.
56  *
57  * Changing it don't forget to change SCST_FIO_REV in scst_vdisk.c
58  * and FIO_REV in usr/fileio/common.h as well.
59  */
60 #define SCST_VERSION(a, b, c, d)    (((a) << 24) + ((b) << 16) + ((c) << 8) + d)
61 #define SCST_VERSION_CODE           SCST_VERSION(2, 0, 0, 0)
62 #ifdef CONFIG_SCST_PROC
63 #define SCST_VERSION_STRING_SUFFIX  "-procfs"
64 #else
65 #define SCST_VERSION_STRING_SUFFIX
66 #endif
67 #define SCST_VERSION_STRING         "2.0.0-pre1" SCST_VERSION_STRING_SUFFIX
68 #define SCST_INTERFACE_VERSION      \
69                 SCST_VERSION_STRING "$Revision$" SCST_CONST_VERSION
70
71 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 18))
72 #define COMPLETION_INITIALIZER_ONSTACK(work) \
73         ({ init_completion(&work); work; })
74
75 /*
76  * Lockdep needs to run a non-constant initializer for on-stack
77  * completions - so we use the _ONSTACK() variant for those that
78  * are on the kernel stack:
79  */
80 #ifdef CONFIG_LOCKDEP
81 # define DECLARE_COMPLETION_ONSTACK(work) \
82         struct completion work = COMPLETION_INITIALIZER_ONSTACK(work)
83 #else
84 # define DECLARE_COMPLETION_ONSTACK(work) DECLARE_COMPLETION(work)
85 #endif
86
87 /**
88  * list_is_last - tests whether @list is the last entry in list @head
89  * @list: the entry to test
90  * @head: the head of the list
91  */
92 static inline int list_is_last(const struct list_head *list,
93                                 const struct list_head *head)
94 {
95         return list->next == head;
96 }
97
98 #endif
99
100 #define SCST_LOCAL_NAME                 "scst_lcl_drvr"
101
102 /*************************************************************
103  ** States of command processing state machine. At first,
104  ** "active" states, then - "passive" ones. This is to have
105  ** more efficient generated code of the corresponding
106  ** "switch" statements.
107  *************************************************************/
108
109 /* Internal parsing */
110 #define SCST_CMD_STATE_PRE_PARSE     0
111
112 /* Dev handler's parse() is going to be called */
113 #define SCST_CMD_STATE_DEV_PARSE     1
114
115 /* Allocation of the cmd's data buffer */
116 #define SCST_CMD_STATE_PREPARE_SPACE 2
117
118 /* Calling preprocessing_done() */
119 #define SCST_CMD_STATE_PREPROCESSING_DONE 3
120
121 /* Target driver's rdy_to_xfer() is going to be called */
122 #define SCST_CMD_STATE_RDY_TO_XFER   4
123
124 /* Target driver's pre_exec() is going to be called */
125 #define SCST_CMD_STATE_TGT_PRE_EXEC  5
126
127 /* Cmd is going to be sent for execution */
128 #define SCST_CMD_STATE_SEND_FOR_EXEC 6
129
130 /* Cmd is being checked if it should be executed locally */
131 #define SCST_CMD_STATE_LOCAL_EXEC    7
132
133 /* Cmd is ready for execution */
134 #define SCST_CMD_STATE_REAL_EXEC     8
135
136 /* Internal post-exec checks */
137 #define SCST_CMD_STATE_PRE_DEV_DONE  9
138
139 /* Internal MODE SELECT pages related checks */
140 #define SCST_CMD_STATE_MODE_SELECT_CHECKS 10
141
142 /* Dev handler's dev_done() is going to be called */
143 #define SCST_CMD_STATE_DEV_DONE      11
144
145 /* Target driver's xmit_response() is going to be called */
146 #define SCST_CMD_STATE_PRE_XMIT_RESP 12
147
148 /* Target driver's xmit_response() is going to be called */
149 #define SCST_CMD_STATE_XMIT_RESP     13
150
151 /* Cmd finished */
152 #define SCST_CMD_STATE_FINISHED      14
153
154 /* Internal cmd finished */
155 #define SCST_CMD_STATE_FINISHED_INTERNAL 15
156
157 #define SCST_CMD_STATE_LAST_ACTIVE   (SCST_CMD_STATE_FINISHED_INTERNAL+100)
158
159 /* A cmd is created, but scst_cmd_init_done() not called */
160 #define SCST_CMD_STATE_INIT_WAIT     (SCST_CMD_STATE_LAST_ACTIVE+1)
161
162 /* LUN translation (cmd->tgt_dev assignment) */
163 #define SCST_CMD_STATE_INIT          (SCST_CMD_STATE_LAST_ACTIVE+2)
164
165 /* Waiting for scst_restart_cmd() */
166 #define SCST_CMD_STATE_PREPROCESSING_DONE_CALLED (SCST_CMD_STATE_LAST_ACTIVE+3)
167
168 /* Waiting for data from the initiator (until scst_rx_data() called) */
169 #define SCST_CMD_STATE_DATA_WAIT     (SCST_CMD_STATE_LAST_ACTIVE+4)
170
171 /* Waiting for CDB's execution finish */
172 #define SCST_CMD_STATE_REAL_EXECUTING (SCST_CMD_STATE_LAST_ACTIVE+5)
173
174 /* Waiting for response's transmission finish */
175 #define SCST_CMD_STATE_XMIT_WAIT     (SCST_CMD_STATE_LAST_ACTIVE+6)
176
177 /*************************************************************
178  * Can be retuned instead of cmd's state by dev handlers'
179  * functions, if the command's state should be set by default
180  *************************************************************/
181 #define SCST_CMD_STATE_DEFAULT        500
182
183 /*************************************************************
184  * Can be retuned instead of cmd's state by dev handlers'
185  * functions, if it is impossible to complete requested
186  * task in atomic context. The cmd will be restarted in thread
187  * context.
188  *************************************************************/
189 #define SCST_CMD_STATE_NEED_THREAD_CTX 1000
190
191 /*************************************************************
192  * Can be retuned instead of cmd's state by dev handlers'
193  * parse function, if the cmd processing should be stopped
194  * for now. The cmd will be restarted by dev handlers itself.
195  *************************************************************/
196 #define SCST_CMD_STATE_STOP           1001
197
198 /*************************************************************
199  ** States of mgmt command processing state machine
200  *************************************************************/
201
202 /* LUN translation (mcmd->tgt_dev assignment) */
203 #define SCST_MCMD_STATE_INIT     0
204
205 /* Mgmt cmd is ready for processing */
206 #define SCST_MCMD_STATE_READY    1
207
208 /* Mgmt cmd is being executing */
209 #define SCST_MCMD_STATE_EXECUTING 2
210
211 /* Post check when affected commands done */
212 #define SCST_MCMD_STATE_POST_AFFECTED_CMDS_DONE 3
213
214 /* Target driver's task_mgmt_fn_done() is going to be called */
215 #define SCST_MCMD_STATE_DONE     4
216
217 /* The mcmd finished */
218 #define SCST_MCMD_STATE_FINISHED 5
219
220 /*************************************************************
221  ** Constants for "atomic" parameter of SCST's functions
222  *************************************************************/
223 #define SCST_NON_ATOMIC              0
224 #define SCST_ATOMIC                  1
225
226 /*************************************************************
227  ** Values for pref_context parameter of scst_cmd_init_done(),
228  ** scst_rx_data(), scst_restart_cmd(), scst_tgt_cmd_done()
229  ** and scst_cmd_done()
230  *************************************************************/
231
232 enum scst_exec_context {
233         /*
234          * Direct cmd's processing (i.e. regular function calls in the current
235          * context) sleeping is not allowed
236          */
237         SCST_CONTEXT_DIRECT_ATOMIC,
238
239         /*
240          * Direct cmd's processing (i.e. regular function calls in the current
241          * context), sleeping is allowed, no restrictions
242          */
243         SCST_CONTEXT_DIRECT,
244
245         /* Tasklet or thread context required for cmd's processing */
246         SCST_CONTEXT_TASKLET,
247
248         /* Thread context required for cmd's processing */
249         SCST_CONTEXT_THREAD,
250
251         /*
252          * Context is the same as it was in previous call of the corresponding
253          * callback. For example, if dev handler's exec() does sync. data
254          * reading this value should be used for scst_cmd_done(). The same is
255          * true if scst_tgt_cmd_done() called directly from target driver's
256          * xmit_response(). Not allowed in scst_cmd_init_done() and
257          * scst_cmd_init_stage1_done().
258          */
259         SCST_CONTEXT_SAME
260 };
261
262 /*************************************************************
263  ** Values for status parameter of scst_rx_data()
264  *************************************************************/
265
266 /* Success */
267 #define SCST_RX_STATUS_SUCCESS       0
268
269 /*
270  * Data receiving finished with error, so set the sense and
271  * finish the command, including xmit_response() call
272  */
273 #define SCST_RX_STATUS_ERROR         1
274
275 /*
276  * Data receiving finished with error and the sense is set,
277  * so finish the command, including xmit_response() call
278  */
279 #define SCST_RX_STATUS_ERROR_SENSE_SET 2
280
281 /*
282  * Data receiving finished with fatal error, so finish the command,
283  * but don't call xmit_response()
284  */
285 #define SCST_RX_STATUS_ERROR_FATAL   3
286
287 /*************************************************************
288  ** Values for status parameter of scst_restart_cmd()
289  *************************************************************/
290
291 /* Success */
292 #define SCST_PREPROCESS_STATUS_SUCCESS       0
293
294 /*
295  * Command's processing finished with error, so set the sense and
296  * finish the command, including xmit_response() call
297  */
298 #define SCST_PREPROCESS_STATUS_ERROR         1
299
300 /*
301  * Command's processing finished with error and the sense is set,
302  * so finish the command, including xmit_response() call
303  */
304 #define SCST_PREPROCESS_STATUS_ERROR_SENSE_SET 2
305
306 /*
307  * Command's processing finished with fatal error, so finish the command,
308  * but don't call xmit_response()
309  */
310 #define SCST_PREPROCESS_STATUS_ERROR_FATAL   3
311
312 /* Thread context requested */
313 #define SCST_PREPROCESS_STATUS_NEED_THREAD   4
314
315 /*************************************************************
316  ** Values for AEN functions
317  *************************************************************/
318
319 /*
320  * SCSI Asynchronous Event. Parameter contains SCSI sense
321  * (Unit Attention). AENs generated only for 2 the following UAs:
322  * CAPACITY DATA HAS CHANGED and REPORTED LUNS DATA HAS CHANGED.
323  * Other UAs reported regularly as CHECK CONDITION status,
324  * because it doesn't look safe to report them using AENs, since
325  * reporting using AENs opens delivery race windows even in case of
326  * untagged commands.
327  */
328 #define SCST_AEN_SCSI                0
329
330 /*************************************************************
331  ** Allowed return/status codes for report_aen() callback and
332  ** scst_set_aen_delivery_status() function
333  *************************************************************/
334
335 /* Success */
336 #define SCST_AEN_RES_SUCCESS         0
337
338 /* Not supported */
339 #define SCST_AEN_RES_NOT_SUPPORTED  -1
340
341 /* Failure */
342 #define SCST_AEN_RES_FAILED         -2
343
344 /*************************************************************
345  ** Allowed return codes for xmit_response(), rdy_to_xfer()
346  *************************************************************/
347
348 /* Success */
349 #define SCST_TGT_RES_SUCCESS         0
350
351 /* Internal device queue is full, retry again later */
352 #define SCST_TGT_RES_QUEUE_FULL      -1
353
354 /*
355  * It is impossible to complete requested task in atomic context.
356  * The cmd will be restarted in thread  context.
357  */
358 #define SCST_TGT_RES_NEED_THREAD_CTX -2
359
360 /*
361  * Fatal error, if returned by xmit_response() the cmd will
362  * be destroyed, if by any other function, xmit_response()
363  * will be called with HARDWARE ERROR sense data
364  */
365 #define SCST_TGT_RES_FATAL_ERROR     -3
366
367 /*************************************************************
368  ** Allowed return codes for dev handler's exec()
369  *************************************************************/
370
371 /* The cmd is done, go to other ones */
372 #define SCST_EXEC_COMPLETED          0
373
374 /* The cmd should be sent to SCSI mid-level */
375 #define SCST_EXEC_NOT_COMPLETED      1
376
377 /*
378  * Thread context is required to execute the command.
379  * Exec() will be called again in the thread context.
380  */
381 #define SCST_EXEC_NEED_THREAD        2
382
383 /*
384  * Set if cmd is finished and there is status/sense to be sent.
385  * The status should be not sent (i.e. the flag not set) if the
386  * possibility to perform a command in "chunks" (i.e. with multiple
387  * xmit_response()/rdy_to_xfer()) is used (not implemented yet).
388  * Obsolete, use scst_cmd_get_is_send_status() instead.
389  */
390 #define SCST_TSC_FLAG_STATUS         0x2
391
392 /*************************************************************
393  ** Additional return code for dev handler's task_mgmt_fn()
394  *************************************************************/
395
396 /* Regular standard actions for the command should be done */
397 #define SCST_DEV_TM_NOT_COMPLETED     1
398
399 /*************************************************************
400  ** Session initialization phases
401  *************************************************************/
402
403 /* Set if session is being initialized */
404 #define SCST_SESS_IPH_INITING        0
405
406 /* Set if the session is successfully initialized */
407 #define SCST_SESS_IPH_SUCCESS        1
408
409 /* Set if the session initialization failed */
410 #define SCST_SESS_IPH_FAILED         2
411
412 /* Set if session is initialized and ready */
413 #define SCST_SESS_IPH_READY          3
414
415 /*************************************************************
416  ** Session shutdown phases
417  *************************************************************/
418
419 /* Set if session is initialized and ready */
420 #define SCST_SESS_SPH_READY          0
421
422 /* Set if session is shutting down */
423 #define SCST_SESS_SPH_SHUTDOWN       1
424
425 /*************************************************************
426  ** Session's async (atomic) flags
427  *************************************************************/
428
429 /* Set if the sess's hw pending work is scheduled */
430 #define SCST_SESS_HW_PENDING_WORK_SCHEDULED     0
431
432 /*************************************************************
433  ** Cmd's async (atomic) flags
434  *************************************************************/
435
436 /* Set if the cmd is aborted and ABORTED sense will be sent as the result */
437 #define SCST_CMD_ABORTED                0
438
439 /* Set if the cmd is aborted by other initiator */
440 #define SCST_CMD_ABORTED_OTHER          1
441
442 /* Set if no response should be sent to the target about this cmd */
443 #define SCST_CMD_NO_RESP                2
444
445 /* Set if the cmd is dead and can be destroyed at any time */
446 #define SCST_CMD_CAN_BE_DESTROYED       3
447
448 /*************************************************************
449  ** Tgt_dev's async. flags (tgt_dev_flags)
450  *************************************************************/
451
452 /* Set if tgt_dev has Unit Attention sense */
453 #define SCST_TGT_DEV_UA_PENDING         0
454
455 /* Set if tgt_dev is RESERVED by another session */
456 #define SCST_TGT_DEV_RESERVED           1
457
458 /* Set if the corresponding context is atomic */
459 #define SCST_TGT_DEV_AFTER_INIT_WR_ATOMIC       5
460 #define SCST_TGT_DEV_AFTER_INIT_OTH_ATOMIC      6
461 #define SCST_TGT_DEV_AFTER_RESTART_WR_ATOMIC    7
462 #define SCST_TGT_DEV_AFTER_RESTART_OTH_ATOMIC   8
463 #define SCST_TGT_DEV_AFTER_RX_DATA_ATOMIC       9
464 #define SCST_TGT_DEV_AFTER_EXEC_ATOMIC          10
465
466 #define SCST_TGT_DEV_CLUST_POOL                 11
467
468 #ifdef CONFIG_SCST_PROC
469
470 /*************************************************************
471  ** Name of the entry in /proc
472  *************************************************************/
473 #define SCST_PROC_ENTRY_NAME         "scsi_tgt"
474
475 #endif
476
477 /*************************************************************
478  ** Activities suspending timeout
479  *************************************************************/
480 #define SCST_SUSPENDING_TIMEOUT                 (90 * HZ)
481
482 /*************************************************************
483  ** Kernel cache creation helper
484  *************************************************************/
485 #ifndef KMEM_CACHE
486 #define KMEM_CACHE(__struct, __flags) kmem_cache_create(#__struct,\
487         sizeof(struct __struct), __alignof__(struct __struct),\
488         (__flags), NULL, NULL)
489 #endif
490
491 /*************************************************************
492  ** Vlaid_mask constants for scst_analyze_sense()
493  *************************************************************/
494
495 #define SCST_SENSE_KEY_VALID            1
496 #define SCST_SENSE_ASC_VALID            2
497 #define SCST_SENSE_ASCQ_VALID           4
498
499 #define SCST_SENSE_ASCx_VALID           (SCST_SENSE_ASC_VALID | \
500                                          SCST_SENSE_ASCQ_VALID)
501
502 #define SCST_SENSE_ALL_VALID            (SCST_SENSE_KEY_VALID | \
503                                          SCST_SENSE_ASC_VALID | \
504                                          SCST_SENSE_ASCQ_VALID)
505
506 /*************************************************************
507  *                     TYPES
508  *************************************************************/
509
510 struct scst_tgt;
511 struct scst_session;
512 struct scst_cmd;
513 struct scst_mgmt_cmd;
514 struct scst_device;
515 struct scst_tgt_dev;
516 struct scst_dev_type;
517 struct scst_acg;
518 struct scst_acg_dev;
519 struct scst_acn;
520 struct scst_aen;
521
522 /*
523  * SCST uses 64-bit numbers to represent LUN's internally. The value
524  * NO_SUCH_LUN is guaranteed to be different of every valid LUN.
525  */
526 #define NO_SUCH_LUN ((uint64_t)-1)
527
528 typedef enum dma_data_direction scst_data_direction;
529
530 enum scst_cdb_flags {
531         /* SCST_TRANSFER_LEN_TYPE_FIXED must be equiv 1 (FIXED_BIT in cdb) */
532         SCST_TRANSFER_LEN_TYPE_FIXED =          0x001,
533         SCST_SMALL_TIMEOUT =                    0x002,
534         SCST_LONG_TIMEOUT =                     0x004,
535         SCST_UNKNOWN_LENGTH =                   0x008,
536         SCST_INFO_NOT_FOUND =                   0x010, /* must be single bit */
537         SCST_VERIFY_BYTCHK_MISMATCH_ALLOWED =   0x020,
538         SCST_IMPLICIT_HQ =                      0x040,
539         SCST_SKIP_UA =                          0x080,
540         SCST_WRITE_MEDIUM =                     0x100,
541         SCST_LOCAL_CMD =                        0x200,
542         SCST_FULLY_LOCAL_CMD =                  0x400,
543 };
544
545 /*
546  * Scsi_Target_Template: defines what functions a target driver will
547  * have to provide in order to work with the target mid-level.
548  * MUST HAVEs define functions that are expected to be in order to work.
549  * OPTIONAL says that there is a choice.
550  *
551  * Also, pay attention to the fact that a command is BLOCKING or NON-BLOCKING.
552  * NON-BLOCKING means that a function returns immediately and will not wait
553  * for actual data transfer to finish. Blocking in such command could have
554  * negative impact on overall system performance. If blocking is necessary,
555  * it is worth to consider creating dedicated thread(s) in target driver, to
556  * which the commands would be passed and which would perform blocking
557  * operations instead of SCST.
558  *
559  * If the function allowed to sleep or not is determined by its last
560  * argument, which is true, if sleeping is not allowed. In this case,
561  * if the function requires sleeping, it  can return
562  * SCST_TGT_RES_NEED_THREAD_CTX, and it will be recalled in the thread context,
563  * where sleeping is allowed.
564  */
565 struct scst_tgt_template {
566         /* public: */
567
568         /*
569          * SG tablesize allows to check whether scatter/gather can be used
570          * or not.
571          */
572         int sg_tablesize;
573
574         /*
575          * True, if this target adapter uses unchecked DMA onto an ISA bus.
576          */
577         unsigned unchecked_isa_dma:1;
578
579         /*
580          * True, if this target adapter can benefit from using SG-vector
581          * clustering (i.e. smaller number of segments).
582          */
583         unsigned use_clustering:1;
584
585         /*
586          * True, if this target adapter doesn't support SG-vector clustering
587          */
588         unsigned no_clustering:1;
589
590         /*
591          * True, if corresponding function supports execution in
592          * the atomic (non-sleeping) context
593          */
594         unsigned xmit_response_atomic:1;
595         unsigned rdy_to_xfer_atomic:1;
596
597 #ifdef CONFIG_SCST_PROC
598         /* True, if the template doesn't need the entry in /proc */
599         unsigned no_proc_entry:1;
600 #endif
601
602         /*
603          * The maximum time in seconds cmd can stay inside the target
604          * hardware, i.e. after rdy_to_xfer() and xmit_response(), before
605          * on_hw_pending_cmd_timeout() will be called, if defined.
606          *
607          * In the current implementation a cmd will be aborted in time t
608          * max_hw_pending_time <= t < 2*max_hw_pending_time.
609          */
610         int max_hw_pending_time;
611
612         /*
613          * This function is equivalent to the SCSI
614          * queuecommand. The target should transmit the response
615          * buffer and the status in the scst_cmd struct.
616          * The expectation is that this executing this command is NON-BLOCKING.
617          *
618          * After the response is actually transmitted, the target
619          * should call the scst_tgt_cmd_done() function of the
620          * mid-level, which will allow it to free up the command.
621          * Returns one of the SCST_TGT_RES_* constants.
622          *
623          * Pay attention to "atomic" attribute of the cmd, which can be get
624          * by scst_cmd_atomic(): it is true if the function called in the
625          * atomic (non-sleeping) context.
626          *
627          * MUST HAVE
628          */
629         int (*xmit_response) (struct scst_cmd *cmd);
630
631         /*
632          * This function informs the driver that data
633          * buffer corresponding to the said command have now been
634          * allocated and it is OK to receive data for this command.
635          * This function is necessary because a SCSI target does not
636          * have any control over the commands it receives. Most lower
637          * level protocols have a corresponding function which informs
638          * the initiator that buffers have been allocated e.g., XFER_
639          * RDY in Fibre Channel. After the data is actually received
640          * the low-level driver needs to call scst_rx_data() in order to
641          * continue processing this command.
642          * Returns one of the SCST_TGT_RES_* constants.
643          * This command is expected to be NON-BLOCKING.
644          *
645          * Pay attention to "atomic" attribute of the cmd, which can be get
646          * by scst_cmd_atomic(): it is true if the function called in the
647          * atomic (non-sleeping) context.
648          *
649          * OPTIONAL
650          */
651         int (*rdy_to_xfer) (struct scst_cmd *cmd);
652
653         /*
654          * Called if cmd stays inside the target hardware, i.e. after
655          * rdy_to_xfer() and xmit_response(), more than max_hw_pending_time
656          * time. The target driver supposed to cleanup this command and
657          * resume cmd's processing.
658          *
659          * OPTIONAL
660          */
661         void (*on_hw_pending_cmd_timeout) (struct scst_cmd *cmd);
662
663         /*
664          * Called to notify the driver that the command is about to be freed.
665          * Necessary, because for aborted commands xmit_response() could not
666          * be called. Could be called on IRQ context.
667          *
668          * OPTIONAL
669          */
670         void (*on_free_cmd) (struct scst_cmd *cmd);
671
672         /*
673          * This function allows target driver to handle data buffer
674          * allocations on its own.
675          *
676          * Target driver doesn't have to always allocate buffer in this
677          * function, but if it decide to do it, it must check that
678          * scst_cmd_get_data_buff_alloced() returns 0, otherwise to avoid
679          * double buffer allocation and memory leaks alloc_data_buf() shall
680          * fail.
681          *
682          * Shall return 0 in case of success or < 0 (preferrably -ENOMEM)
683          * in case of error, or > 0 if the regular SCST allocation should be
684          * done. In case of returning successfully,
685          * scst_cmd->tgt_data_buf_alloced will be set by SCST.
686          *
687          * It is possible that both target driver and dev handler request own
688          * memory allocation. In this case, data will be memcpy() between
689          * buffers, where necessary.
690          *
691          * If allocation in atomic context - cf. scst_cmd_atomic() - is not
692          * desired or fails and consequently < 0 is returned, this function
693          * will be re-called in thread context.
694          *
695          * Please note that the driver will have to handle itself all relevant
696          * details such as scatterlist setup, highmem, freeing the allocated
697          * memory, etc.
698          *
699          * OPTIONAL.
700          */
701         int (*alloc_data_buf) (struct scst_cmd *cmd);
702
703         /*
704          * This function informs the driver that data
705          * buffer corresponding to the said command have now been
706          * allocated and other preprocessing tasks have been done.
707          * A target driver could need to do some actions at this stage.
708          * After the target driver done the needed actions, it shall call
709          * scst_restart_cmd() in order to continue processing this command.
710          * In case of preliminary the command completion, this function will
711          * also be called before xmit_response().
712          *
713          * Called only if the cmd is queued using scst_cmd_init_stage1_done()
714          * instead of scst_cmd_init_done().
715          *
716          * Returns void, the result is expected to be returned using
717          * scst_restart_cmd().
718          *
719          * This command is expected to be NON-BLOCKING.
720          *
721          * Pay attention to "atomic" attribute of the cmd, which can be get
722          * by scst_cmd_atomic(): it is true if the function called in the
723          * atomic (non-sleeping) context.
724          *
725          * OPTIONAL.
726          */
727         void (*preprocessing_done) (struct scst_cmd *cmd);
728
729         /*
730          * This function informs the driver that the said command is about
731          * to be executed.
732          *
733          * Returns one of the SCST_PREPROCESS_* constants.
734          *
735          * This command is expected to be NON-BLOCKING.
736          *
737          * Pay attention to "atomic" attribute of the cmd, which can be get
738          * by scst_cmd_atomic(): it is true if the function called in the
739          * atomic (non-sleeping) context.
740          *
741          * OPTIONAL
742          */
743         int (*pre_exec) (struct scst_cmd *cmd);
744
745         /*
746          * This function informs the driver that all affected by the
747          * corresponding task management function commands have beed completed.
748          * No return value expected.
749          *
750          * This function is expected to be NON-BLOCKING.
751          *
752          * Called without any locks held from a thread context.
753          *
754          * OPTIONAL
755          */
756         void (*task_mgmt_affected_cmds_done) (struct scst_mgmt_cmd *mgmt_cmd);
757
758         /*
759          * This function informs the driver that the corresponding task
760          * management function has been completed, i.e. all the corresponding
761          * commands completed and freed. No return value expected.
762          *
763          * This function is expected to be NON-BLOCKING.
764          *
765          * Called without any locks held from a thread context.
766          *
767          * MUST HAVE if the target supports task management.
768          */
769         void (*task_mgmt_fn_done) (struct scst_mgmt_cmd *mgmt_cmd);
770
771         /*
772          * This function should detect the target adapters that
773          * are present in the system. The function should return a value
774          * >= 0 to signify the number of detected target adapters.
775          * A negative value should be returned whenever there is
776          * an error.
777          *
778          * MUST HAVE
779          */
780         int (*detect) (struct scst_tgt_template *tgt_template);
781
782         /*
783          * This function should free up the resources allocated to the device.
784          * The function should return 0 to indicate successful release
785          * or a negative value if there are some issues with the release.
786          * In the current version the return value is ignored.
787          *
788          * MUST HAVE
789          */
790         int (*release) (struct scst_tgt *tgt);
791
792         /*
793          * This function is used for Asynchronous Event Notifications.
794          *
795          * Returns one of the SCST_AEN_RES_* constants.
796          * After AEN is sent, target driver must call scst_aen_done() and,
797          * optionally, scst_set_aen_delivery_status().
798          *
799          * This command is expected to be NON-BLOCKING, but can sleep.
800          *
801          * MUST HAVE, if low-level protocol supports AENs.
802          */
803         int (*report_aen) (struct scst_aen *aen);
804
805 #ifdef CONFIG_SCST_PROC
806         /*
807          * Those functions can be used to export the driver's statistics and
808          * other infos to the world outside the kernel as well as to get some
809          * management commands from it.
810          *
811          * OPTIONAL
812          */
813         int (*read_proc) (struct seq_file *seq, struct scst_tgt *tgt);
814         int (*write_proc) (char *buffer, char **start, off_t offset,
815                 int length, int *eof, struct scst_tgt *tgt);
816 #endif
817
818         /*
819          * This function allows to enable or disable particular target.
820          * A disabled target doesn't receive and process any SCSI commands.
821          *
822          * SHOULD HAVE to avoid race when there are connected initiators,
823          * while target not yet completed the initial configuration. In this
824          * case the too early connected initiators would see not those devices,
825          * which they intended to see.
826          */
827         ssize_t (*enable_tgt) (struct scst_tgt *tgt, const char *buffer,
828                            size_t size);
829
830         /*
831          * This function shows if particular target is enabled or not.
832          *
833          * SHOULD HAVE, see above why.
834          */
835         bool (*is_tgt_enabled) (struct scst_tgt *tgt);
836
837         /*
838          * Name of the template. Must be unique to identify
839          * the template. MUST HAVE
840          */
841         const char name[SCST_MAX_NAME];
842
843         /*
844          * Number of additional threads to the pool of dedicated threads.
845          * Used if xmit_response() or rdy_to_xfer() is blocking.
846          * It is the target driver's duty to ensure that not more, than that
847          * number of threads, are blocked in those functions at any time.
848          */
849         int threads_num;
850
851         /* Optional default log flags */
852         const unsigned long default_trace_flags;
853
854         /* Optional pointer to trace flags */
855         unsigned long *trace_flags;
856
857         /* Optional local trace table */
858         struct scst_trace_log *trace_tbl;
859
860         /* Optional local trace table help string */
861         const char *trace_tbl_help;
862
863 #ifndef CONFIG_SCST_PROC
864         /* Optional sysfs attributes */
865         const struct attribute **tgtt_attrs;
866
867         /* Optional sysfs target attributes */
868         const struct attribute **tgt_attrs;
869
870         /* Optional sysfs session attributes */
871         const struct attribute **sess_attrs;
872 #endif
873
874         /** Private, must be inited to 0 by memset() **/
875
876         /* List of targets per template, protected by scst_mutex */
877         struct list_head tgt_list;
878
879         /* List entry of global templates list */
880         struct list_head scst_template_list_entry;
881
882 #ifdef CONFIG_SCST_PROC
883         /* The pointer to the /proc directory entry */
884         struct proc_dir_entry *proc_tgt_root;
885 #endif
886
887         /* Set if tgtt_kobj was initialized */
888         unsigned int tgtt_kobj_initialized:1;
889
890         struct kobject tgtt_kobj; /* kobject for this struct */
891
892         struct completion tgtt_kobj_release_cmpl;
893
894 #ifdef CONFIG_SCST_PROC
895         /* Device number in /proc */
896         int proc_dev_num;
897 #endif
898 };
899
900 struct scst_dev_type {
901         /* SCSI type of the supported device. MUST HAVE */
902         int type;
903
904         /*
905          * True, if corresponding function supports execution in
906          * the atomic (non-sleeping) context
907          */
908         unsigned parse_atomic:1;
909         unsigned exec_atomic:1;
910         unsigned dev_done_atomic:1;
911
912 #ifdef CONFIG_SCST_PROC
913         /* Set, if no /proc files should be automatically created by SCST */
914         unsigned no_proc:1;
915 #endif
916
917         /*
918          * Should be set, if exec() is synchronous. This is a hint to SCST core
919          * to optimize commands order management.
920          */
921         unsigned exec_sync:1;
922
923         /*
924          * Called to parse CDB from the cmd and initialize
925          * cmd->bufflen and cmd->data_direction (both - REQUIRED).
926          * Returns the command's next state or SCST_CMD_STATE_DEFAULT,
927          * if the next default state should be used, or
928          * SCST_CMD_STATE_NEED_THREAD_CTX if the function called in atomic
929          * context, but requires sleeping, or SCST_CMD_STATE_STOP if the
930          * command should not be further processed for now. In the
931          * SCST_CMD_STATE_NEED_THREAD_CTX case the function
932          * will be recalled in the thread context, where sleeping is allowed.
933          *
934          * Pay attention to "atomic" attribute of the cmd, which can be get
935          * by scst_cmd_atomic(): it is true if the function called in the
936          * atomic (non-sleeping) context.
937          *
938          * MUST HAVE
939          */
940         int (*parse) (struct scst_cmd *cmd);
941
942         /*
943          * Called to execute CDB. Useful, for instance, to implement
944          * data caching. The result of CDB execution is reported via
945          * cmd->scst_cmd_done() callback.
946          * Returns:
947          *  - SCST_EXEC_COMPLETED - the cmd is done, go to other ones
948          *  - SCST_EXEC_NEED_THREAD - thread context is required to execute
949          *      the command. Exec() will be called again in the thread context.
950          *  - SCST_EXEC_NOT_COMPLETED - the cmd should be sent to SCSI
951          *      mid-level.
952          *
953          * Pay attention to "atomic" attribute of the cmd, which can be get
954          * by scst_cmd_atomic(): it is true if the function called in the
955          * atomic (non-sleeping) context.
956          *
957          * If this function provides sync execution, you should set
958          * exec_sync flag and consider to setup dedicated threads by
959          * setting threads_num > 0.
960          *
961          * !! If this function is implemented, scst_check_local_events() !!
962          * !! shall be called inside it just before the actual command's !!
963          * !! execution.                                                 !!
964          *
965          * OPTIONAL, if not set, the commands will be sent directly to SCSI
966          * device.
967          */
968         int (*exec) (struct scst_cmd *cmd);
969
970         /*
971          * Called to notify dev handler about the result of cmd execution
972          * and perform some post processing. Cmd's fields is_send_status and
973          * resp_data_len should be set by this function, but SCST offers good
974          * defaults.
975          * Returns the command's next state or SCST_CMD_STATE_DEFAULT,
976          * if the next default state should be used, or
977          * SCST_CMD_STATE_NEED_THREAD_CTX if the function called in atomic
978          * context, but requires sleeping. In the last case, the function
979          * will be recalled in the thread context, where sleeping is allowed.
980          *
981          * Pay attention to "atomic" attribute of the cmd, which can be get
982          * by scst_cmd_atomic(): it is true if the function called in the
983          * atomic (non-sleeping) context.
984          */
985         int (*dev_done) (struct scst_cmd *cmd);
986
987         /*
988          * Called to notify dev hander that the command is about to be freed.
989          * Could be called on IRQ context.
990          */
991         void (*on_free_cmd) (struct scst_cmd *cmd);
992
993         /*
994          * Called to execute a task management command.
995          * Returns:
996          *  - SCST_MGMT_STATUS_SUCCESS - the command is done with success,
997          *      no firther actions required
998          *  - The SCST_MGMT_STATUS_* error code if the command is failed and
999          *      no further actions required
1000          *  - SCST_DEV_TM_NOT_COMPLETED - regular standard actions for the
1001          *      command should be done
1002          *
1003          * Called without any locks held from a thread context.
1004          */
1005         int (*task_mgmt_fn) (struct scst_mgmt_cmd *mgmt_cmd,
1006                 struct scst_tgt_dev *tgt_dev);
1007
1008         /*
1009          * Called when new device is attaching to the dev handler
1010          * Returns 0 on success, error code otherwise.
1011          */
1012         int (*attach) (struct scst_device *dev);
1013
1014         /* Called when new device is detaching from the dev handler */
1015         void (*detach) (struct scst_device *dev);
1016
1017         /*
1018          * Called when new tgt_dev (session) is attaching to the dev handler.
1019          * Returns 0 on success, error code otherwise.
1020          */
1021         int (*attach_tgt) (struct scst_tgt_dev *tgt_dev);
1022
1023         /* Called when tgt_dev (session) is detaching from the dev handler */
1024         void (*detach_tgt) (struct scst_tgt_dev *tgt_dev);
1025
1026 #ifdef CONFIG_SCST_PROC
1027         /*
1028          * Those functions can be used to export the handler's statistics and
1029          * other infos to the world outside the kernel as well as to get some
1030          * management commands from it.
1031          *
1032          * OPTIONAL
1033          */
1034         int (*read_proc) (struct seq_file *seq, struct scst_dev_type *dev_type);
1035         int (*write_proc) (char *buffer, char **start, off_t offset,
1036                 int length, int *eof, struct scst_dev_type *dev_type);
1037 #endif
1038
1039         /*
1040          * Name of the dev handler. Must be unique. MUST HAVE.
1041          *
1042          * It's SCST_MAX_NAME + few more bytes to match scst_user expectations.
1043          */
1044         char name[SCST_MAX_NAME + 10];
1045
1046         /*
1047          * Number of dedicated threads. If 0 - no dedicated threads will
1048          * be created, if <0 - creation of dedicated threads is prohibited.
1049          */
1050         int threads_num;
1051
1052         /* Optional default log flags */
1053         const unsigned long default_trace_flags;
1054
1055         /* Optional pointer to trace flags */
1056         unsigned long *trace_flags;
1057
1058         /* Optional local trace table */
1059         struct scst_trace_log *trace_tbl;
1060
1061         /* Optional local trace table help string */
1062         const char *trace_tbl_help;
1063
1064 #ifndef CONFIG_SCST_PROC
1065         /* Optional sysfs attributes */
1066         const struct attribute **devt_attrs;
1067
1068         /* Optional sysfs device attributes */
1069         const struct attribute **dev_attrs;
1070 #endif
1071
1072         /* Pointer to dev handler's private data */
1073         void *devt_priv;
1074
1075         /* Pointer to parent dev type in the sysfs hierarchy */
1076         struct scst_dev_type *parent;
1077
1078         struct module *module;
1079
1080         /** Private, must be inited to 0 by memset() **/
1081
1082         /* list entry in scst_dev_type_list */
1083         struct list_head dev_type_list_entry;
1084
1085 #ifdef CONFIG_SCST_PROC
1086         /* The pointer to the /proc directory entry */
1087         struct proc_dir_entry *proc_dev_type_root;
1088 #endif
1089
1090         unsigned int devt_kobj_initialized:1;
1091
1092         struct kobject devt_kobj; /* main handlers/driver */
1093
1094         /* To wait until devt_kobj released */
1095         struct completion devt_kobj_release_compl;
1096 };
1097
1098 struct scst_tgt {
1099         /* List of remote sessions per target, protected by scst_mutex */
1100         struct list_head sess_list;
1101
1102         /* List entry of targets per template (tgts_list) */
1103         struct list_head tgt_list_entry;
1104
1105         struct scst_tgt_template *tgtt; /* corresponding target template */
1106
1107         struct scst_acg *default_acg; /* The default acg for this target. */
1108
1109         /*
1110          * Maximum SG table size. Needed here, since different cards on the
1111          * same target template can have different SG table limitations.
1112          */
1113         int sg_tablesize;
1114
1115         /* Used for storage of target driver private stuff */
1116         void *tgt_priv;
1117
1118         /*
1119          * The following fields used to store and retry cmds if target's
1120          * internal queue is full, so the target is unable to accept
1121          * the cmd returning QUEUE FULL.
1122          * They protected by tgt_lock, where necessary.
1123          */
1124         bool retry_timer_active;
1125         struct timer_list retry_timer;
1126         atomic_t finished_cmds;
1127         int retry_cmds;
1128         spinlock_t tgt_lock;
1129         struct list_head retry_cmd_list;
1130
1131         /* Used to wait until session finished to unregister */
1132         wait_queue_head_t unreg_waitQ;
1133
1134 #ifdef CONFIG_SCST_PROC
1135         /* Device number in /proc */
1136         int proc_num;
1137 #endif
1138
1139         /* Name of the target */
1140         char *tgt_name;
1141
1142 #ifdef CONFIG_SCST_PROC
1143         /* Name on the default security group ("Default_target_name") */
1144         char *default_group_name;
1145 #endif
1146
1147         /* Set if tgt_kobj was initialized */
1148         unsigned int tgt_kobj_initialized:1;
1149
1150         /* Set if scst_tgt_sysfs_prepare_put() was called for tgt_kobj */
1151         unsigned int tgt_kobj_put_prepared:1;
1152
1153         /*
1154          * Used to protect sysfs attributes to be called after this
1155          * object was unregistered.
1156          */
1157         struct rw_semaphore tgt_attr_rwsem;
1158
1159         struct kobject tgt_kobj; /* main targets/target kobject */
1160         struct kobject *tgt_sess_kobj; /* target/sessions/ */
1161         struct kobject *tgt_luns_kobj; /* target/luns/ */
1162         struct kobject *tgt_ini_grp_kobj; /* target/ini_groups/ */
1163 };
1164
1165 /* Hash size and hash fn for hash based lun translation */
1166 #define TGT_DEV_HASH_SHIFT      5
1167 #define TGT_DEV_HASH_SIZE       (1 << TGT_DEV_HASH_SHIFT)
1168 #define HASH_VAL(_val)          (_val & (TGT_DEV_HASH_SIZE - 1))
1169
1170 #ifdef CONFIG_SCST_MEASURE_LATENCY
1171
1172 /* Defines extended latency statistics */
1173 struct scst_ext_latency_stat {
1174         uint64_t scst_time_rd, tgt_time_rd, dev_time_rd;
1175         unsigned int processed_cmds_rd;
1176         uint64_t min_scst_time_rd, min_tgt_time_rd, min_dev_time_rd;
1177         uint64_t max_scst_time_rd, max_tgt_time_rd, max_dev_time_rd;
1178
1179         uint64_t scst_time_wr, tgt_time_wr, dev_time_wr;
1180         unsigned int processed_cmds_wr;
1181         uint64_t min_scst_time_wr, min_tgt_time_wr, min_dev_time_wr;
1182         uint64_t max_scst_time_wr, max_tgt_time_wr, max_dev_time_wr;
1183 };
1184
1185 #define SCST_IO_SIZE_THRESHOLD_SMALL            (8*1024)
1186 #define SCST_IO_SIZE_THRESHOLD_MEDIUM           (32*1024)
1187 #define SCST_IO_SIZE_THRESHOLD_LARGE            (128*1024)
1188 #define SCST_IO_SIZE_THRESHOLD_VERY_LARGE       (512*1024)
1189
1190 #define SCST_LATENCY_STAT_INDEX_SMALL           0
1191 #define SCST_LATENCY_STAT_INDEX_MEDIUM          1
1192 #define SCST_LATENCY_STAT_INDEX_LARGE           2
1193 #define SCST_LATENCY_STAT_INDEX_VERY_LARGE      3
1194 #define SCST_LATENCY_STAT_INDEX_OTHER           4
1195 #define SCST_LATENCY_STATS_NUM          (SCST_LATENCY_STAT_INDEX_OTHER + 1)
1196
1197 #endif /* CONFIG_SCST_MEASURE_LATENCY */
1198
1199 struct scst_session {
1200         /*
1201          * Initialization phase, one of SCST_SESS_IPH_* constants, protected by
1202          * sess_list_lock
1203          */
1204         int init_phase;
1205
1206         struct scst_tgt *tgt;   /* corresponding target */
1207
1208         /* Used for storage of target driver private stuff */
1209         void *tgt_priv;
1210
1211         unsigned long sess_aflags; /* session's async flags */
1212
1213         /*
1214          * Hash list of tgt_dev's for this session, protected by scst_mutex
1215          * and suspended activity
1216          */
1217         struct list_head sess_tgt_dev_list_hash[TGT_DEV_HASH_SIZE];
1218
1219         /*
1220          * List of cmds in this session. Protected by sess_list_lock.
1221          *
1222          * We must always keep commands in the sess list from the
1223          * very beginning, because otherwise they can be missed during
1224          * TM processing.
1225          */
1226         struct list_head sess_cmd_list;
1227
1228         spinlock_t sess_list_lock; /* protects sess_cmd_list, etc */
1229
1230         atomic_t refcnt;                /* get/put counter */
1231
1232         /*
1233          * Alive commands for this session. ToDo: make it part of the common
1234          * IO flow control.
1235          */
1236         atomic_t sess_cmd_count;
1237
1238         /* Access control for this session and list entry there */
1239         struct scst_acg *acg;
1240
1241         /* List entry for the sessions list inside ACG */
1242         struct list_head acg_sess_list_entry;
1243
1244 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 20))
1245         struct delayed_work hw_pending_work;
1246 #else
1247         struct work_struct hw_pending_work;
1248 #endif
1249
1250         /* Name of attached initiator */
1251         const char *initiator_name;
1252
1253         /* List entry of sessions per target */
1254         struct list_head sess_list_entry;
1255
1256         /* List entry for the list that keeps session, waiting for the init */
1257         struct list_head sess_init_list_entry;
1258
1259         /*
1260          * List entry for the list that keeps session, waiting for the shutdown
1261          */
1262         struct list_head sess_shut_list_entry;
1263
1264         /*
1265          * Lists of deferred during session initialization commands.
1266          * Protected by sess_list_lock.
1267          */
1268         struct list_head init_deferred_cmd_list;
1269         struct list_head init_deferred_mcmd_list;
1270
1271         /*
1272          * Shutdown phase, one of SCST_SESS_SPH_* constants, unprotected.
1273          * Async. relating to init_phase, must be a separate variable, because
1274          * session could be unregistered before async. registration is finished.
1275          */
1276         unsigned long shut_phase;
1277
1278         /* Used if scst_unregister_session() called in wait mode */
1279         struct completion *shutdown_compl;
1280
1281         /* Set if sess_kobj was initialized */
1282         unsigned int sess_kobj_initialized:1;
1283
1284         /*
1285          * Used to protect sysfs attributes to be called after this
1286          * object was unregistered.
1287          */
1288         struct rw_semaphore sess_attr_rwsem;
1289
1290         struct kobject sess_kobj; /* kobject for this struct */
1291
1292         /*
1293          * Functions and data for user callbacks from scst_register_session()
1294          * and scst_unregister_session()
1295          */
1296         void *reg_sess_data;
1297         void (*init_result_fn) (struct scst_session *sess, void *data,
1298                                 int result);
1299         void (*unreg_done_fn) (struct scst_session *sess);
1300
1301 #ifdef CONFIG_SCST_MEASURE_LATENCY
1302         /*
1303          * Must be the last to allow to work with drivers who don't know
1304          * about this config time option.
1305          */
1306         spinlock_t lat_lock;
1307         uint64_t scst_time, tgt_time, dev_time;
1308         unsigned int processed_cmds;
1309         uint64_t min_scst_time, min_tgt_time, min_dev_time;
1310         uint64_t max_scst_time, max_tgt_time, max_dev_time;
1311         struct scst_ext_latency_stat sess_latency_stat[SCST_LATENCY_STATS_NUM];
1312 #endif
1313 };
1314
1315 struct scst_cmd_lists {
1316         spinlock_t cmd_list_lock;
1317         struct list_head active_cmd_list;
1318         wait_queue_head_t cmd_list_waitQ;
1319         struct list_head lists_list_entry;
1320 };
1321
1322 struct scst_cmd {
1323         /* List entry for below *_cmd_lists */
1324         struct list_head cmd_list_entry;
1325
1326         /* Pointer to lists of commands with the lock */
1327         struct scst_cmd_lists *cmd_lists;
1328
1329         atomic_t cmd_ref;
1330
1331         struct scst_session *sess;      /* corresponding session */
1332
1333         /* Cmd state, one of SCST_CMD_STATE_* constants */
1334         int state;
1335
1336         /*************************************************************
1337          ** Cmd's flags
1338          *************************************************************/
1339
1340         /*
1341          * Set if expected_sn should be incremented, i.e. cmd was sent
1342          * for execution
1343          */
1344         unsigned int sent_for_exec:1;
1345
1346         /* Set if the cmd's action is completed */
1347         unsigned int completed:1;
1348
1349         /* Set if we should ignore Unit Attention in scst_check_sense() */
1350         unsigned int ua_ignore:1;
1351
1352         /* Set if cmd is being processed in atomic context */
1353         unsigned int atomic:1;
1354
1355         /* Set if this command was sent in double UA possible state */
1356         unsigned int double_ua_possible:1;
1357
1358         /* Set if this command contains status */
1359         unsigned int is_send_status:1;
1360
1361         /* Set if cmd is being retried */
1362         unsigned int retry:1;
1363
1364         /* Set if cmd is internally generated */
1365         unsigned int internal:1;
1366
1367         /* Set if the device was blocked by scst_inc_on_dev_cmd() (for debug) */
1368         unsigned int inc_blocking:1;
1369
1370         /* Set if the device should be unblocked after cmd's finish */
1371         unsigned int needs_unblocking:1;
1372
1373         /* Set if scst_dec_on_dev_cmd() call is needed on the cmd's finish */
1374         unsigned int dec_on_dev_needed:1;
1375
1376         /* Set if cmd is queued as hw pending */
1377         unsigned int cmd_hw_pending:1;
1378
1379         /*
1380          * Set if the target driver wants to alloc data buffers on its own.
1381          * In this case alloc_data_buf() must be provided in the target driver
1382          * template.
1383          */
1384         unsigned int tgt_need_alloc_data_buf:1;
1385
1386         /*
1387          * Set by SCST if the custom data buffer allocation by the target driver
1388          * succeeded.
1389          */
1390         unsigned int tgt_data_buf_alloced:1;
1391
1392         /* Set if custom data buffer allocated by dev handler */
1393         unsigned int dh_data_buf_alloced:1;
1394
1395         /* Set if the target driver called scst_set_expected() */
1396         unsigned int expected_values_set:1;
1397
1398         /*
1399          * Set if the SG buffer was modified by scst_set_resp_data_len()
1400          */
1401         unsigned int sg_buff_modified:1;
1402
1403         /*
1404          * Set if scst_cmd_init_stage1_done() called and the target
1405          * want that preprocessing_done() will be called
1406          */
1407         unsigned int preprocessing_only:1;
1408
1409         /* Set if cmd's SN was set */
1410         unsigned int sn_set:1;
1411
1412         /* Set if hq_cmd_count was incremented */
1413         unsigned int hq_cmd_inced:1;
1414
1415         /*
1416          * Set if scst_cmd_init_stage1_done() called and the target wants
1417          * that the SN for the cmd won't be assigned until scst_restart_cmd()
1418          */
1419         unsigned int set_sn_on_restart_cmd:1;
1420
1421         /* Set if the cmd's must not use sgv cache for data buffer */
1422         unsigned int no_sgv:1;
1423
1424         /*
1425          * Set if target driver may need to call dma_sync_sg() or similar
1426          * function before transferring cmd' data to the target device
1427          * via DMA.
1428          */
1429         unsigned int may_need_dma_sync:1;
1430
1431         /* Set if the cmd was done or aborted out of its SN */
1432         unsigned int out_of_sn:1;
1433
1434         /* Set if increment expected_sn in cmd->scst_cmd_done() */
1435         unsigned int inc_expected_sn_on_done:1;
1436
1437         /* Set if tgt_sn field is valid */
1438         unsigned int tgt_sn_set:1;
1439
1440         /* Set if cmd is done */
1441         unsigned int done:1;
1442
1443         /* Set if cmd is finished */
1444         unsigned int finished:1;
1445
1446         /*
1447          * Set if the cmd was delayed by task management debugging code.
1448          * Used only if CONFIG_SCST_DEBUG_TM is on.
1449          */
1450         unsigned int tm_dbg_delayed:1;
1451
1452         /*
1453          * Set if the cmd must be ignored by task management debugging code.
1454          * Used only if CONFIG_SCST_DEBUG_TM is on.
1455          */
1456         unsigned int tm_dbg_immut:1;
1457
1458         /**************************************************************/
1459
1460         unsigned long cmd_flags; /* cmd's async flags */
1461
1462         /* Keeps status of cmd's status/data delivery to remote initiator */
1463         int delivery_status;
1464
1465         struct scst_tgt_template *tgtt; /* to save extra dereferences */
1466         struct scst_tgt *tgt;           /* to save extra dereferences */
1467         struct scst_device *dev;        /* to save extra dereferences */
1468
1469         struct scst_tgt_dev *tgt_dev;   /* corresponding device for this cmd */
1470
1471         uint64_t lun;                   /* LUN for this cmd */
1472
1473         unsigned long start_time;
1474
1475 #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 18)
1476         struct scsi_request *scsi_req;  /* SCSI request */
1477 #endif
1478
1479         /* List entry for tgt_dev's SN related lists */
1480         struct list_head sn_cmd_list_entry;
1481
1482         /* Cmd's serial number, used to execute cmd's in order of arrival */
1483         unsigned int sn;
1484
1485         /* The corresponding sn_slot in tgt_dev->sn_slots */
1486         atomic_t *sn_slot;
1487
1488         /* List entry for sess's sess_cmd_list */
1489         struct list_head sess_cmd_list_entry;
1490
1491         /*
1492          * Used to found the cmd by scst_find_cmd_by_tag(). Set by the
1493          * target driver on the cmd's initialization time
1494          */
1495         uint64_t tag;
1496
1497         uint32_t tgt_sn; /* SN set by target driver (for TM purposes) */
1498
1499         /* CDB and its len */
1500         uint8_t cdb[SCST_MAX_CDB_SIZE];
1501         short cdb_len; /* it might be -1 */
1502         unsigned short ext_cdb_len;
1503         uint8_t *ext_cdb;
1504
1505         enum scst_cdb_flags op_flags;
1506         const char *op_name;
1507
1508         enum scst_cmd_queue_type queue_type;
1509
1510         int timeout; /* CDB execution timeout in seconds */
1511         int retries; /* Amount of retries that will be done by SCSI mid-level */
1512
1513         /* SCSI data direction, one of SCST_DATA_* constants */
1514         scst_data_direction data_direction;
1515
1516         /* Remote initiator supplied values, if any */
1517         scst_data_direction expected_data_direction;
1518         int expected_transfer_len;
1519         int expected_in_transfer_len; /* for bidi writes */
1520
1521         /*
1522          * Cmd data length. Could be different from bufflen for commands like
1523          * VERIFY, which transfer different amount of data (if any), than
1524          * processed.
1525          */
1526         int data_len;
1527
1528         /* Completition routine */
1529         void (*scst_cmd_done) (struct scst_cmd *cmd, int next_state,
1530                 enum scst_exec_context pref_context);
1531
1532         struct sgv_pool_obj *sgv;       /* sgv object */
1533         int bufflen;                    /* cmd buffer length */
1534         struct scatterlist *sg;         /* cmd data buffer SG vector */
1535         int sg_cnt;                     /* SG segments count */
1536
1537         /*
1538          * Response data length in data buffer. This field must not be set
1539          * directly, use scst_set_resp_data_len() for that
1540          */
1541         int resp_data_len;
1542
1543         /* scst_get_sg_buf_[first,next]() support */
1544         int get_sg_buf_entry_num;
1545
1546         /* Bidirectional transfers support */
1547         int in_bufflen;                 /* WRITE buffer length */
1548         struct sgv_pool_obj *in_sgv;    /* WRITE sgv object */
1549         struct scatterlist *in_sg;      /* WRITE data buffer SG vector */
1550         int in_sg_cnt;                  /* WRITE SG segments count */
1551
1552         /*
1553          * Used if both target driver and dev handler request own memory
1554          * allocation. In other cases, both are equal to sg and sg_cnt
1555          * correspondingly.
1556          *
1557          * If target driver requests own memory allocations, it MUST use
1558          * functions scst_cmd_get_tgt_sg*() to get sg and sg_cnt! Otherwise,
1559          * it may use functions scst_cmd_get_sg*().
1560          */
1561         struct scatterlist *tgt_sg;
1562         int tgt_sg_cnt;
1563         struct scatterlist *tgt_in_sg;  /* bidirectional */
1564         int tgt_in_sg_cnt;              /* bidirectional */
1565
1566         /*
1567          * The status fields in case of errors must be set using
1568          * scst_set_cmd_error_status()!
1569          */
1570         uint8_t status;         /* status byte from target device */
1571         uint8_t msg_status;     /* return status from host adapter itself */
1572         uint8_t host_status;    /* set by low-level driver to indicate status */
1573         uint8_t driver_status;  /* set by mid-level */
1574
1575         uint8_t *sense;         /* pointer to sense buffer */
1576         unsigned short sense_valid_len; /* length of valid sense data */
1577         unsigned short sense_buflen; /* length of the sense buffer, if any */
1578
1579         /* Start time when cmd was sent to rdy_to_xfer() or xmit_response() */
1580         unsigned long hw_pending_start;
1581
1582         /* Used for storage of target driver private stuff */
1583         void *tgt_priv;
1584
1585         /* Used for storage of dev handler private stuff */
1586         void *dh_priv;
1587
1588         /*
1589          * Used to restore the SG vector if it was modified by
1590          * scst_set_resp_data_len()
1591          */
1592         int orig_sg_cnt, orig_sg_entry, orig_entry_len;
1593
1594         /* Used to retry commands in case of double UA */
1595         int dbl_ua_orig_resp_data_len, dbl_ua_orig_data_direction;
1596
1597         /* List corresponding mgmt cmd, if any, protected by sess_list_lock */
1598         struct list_head mgmt_cmd_list;
1599
1600         /* List entry for dev's blocked_cmd_list */
1601         struct list_head blocked_cmd_list_entry;
1602
1603         struct scst_cmd *orig_cmd; /* Used to issue REQUEST SENSE */
1604
1605 #ifdef CONFIG_SCST_MEASURE_LATENCY
1606         /*
1607          * Must be the last to allow to work with drivers who don't know
1608          * about this config time option.
1609          */
1610         uint64_t start, curr_start, parse_time, alloc_buf_time;
1611         uint64_t restart_waiting_time, rdy_to_xfer_time;
1612         uint64_t pre_exec_time, exec_time, dev_done_time;
1613         uint64_t xmit_time, tgt_on_free_time, dev_on_free_time;
1614 #endif
1615 };
1616
1617 struct scst_rx_mgmt_params {
1618         int fn;
1619         uint64_t tag;
1620         const uint8_t *lun;
1621         int lun_len;
1622         uint32_t cmd_sn;
1623         int atomic;
1624         void *tgt_priv;
1625         unsigned char tag_set;
1626         unsigned char lun_set;
1627         unsigned char cmd_sn_set;
1628 };
1629
1630 struct scst_mgmt_cmd_stub {
1631         struct scst_mgmt_cmd *mcmd;
1632
1633         /* List entry in cmd->mgmt_cmd_list */
1634         struct list_head cmd_mgmt_cmd_list_entry;
1635
1636         /* set if the cmd was counted in  mcmd->cmd_done_wait_count */
1637         unsigned int done_counted:1;
1638 };
1639
1640 struct scst_mgmt_cmd {
1641         /* List entry for *_mgmt_cmd_list */
1642         struct list_head mgmt_cmd_list_entry;
1643
1644         struct scst_session *sess;
1645
1646         /* Mgmt cmd state, one of SCST_MCMD_STATE_* constants */
1647         int state;
1648
1649         int fn;
1650
1651         unsigned int completed:1;       /* set, if the mcmd is completed */
1652         /* Set if device(s) should be unblocked after mcmd's finish */
1653         unsigned int needs_unblocking:1;
1654         unsigned int lun_set:1;         /* set, if lun field is valid */
1655         unsigned int cmd_sn_set:1;      /* set, if cmd_sn field is valid */
1656         /* set, if scst_mgmt_affected_cmds_done was called */
1657         unsigned int affected_cmds_done_called:1;
1658
1659         /*
1660          * Number of commands to finish before sending response,
1661          * protected by scst_mcmd_lock
1662          */
1663         int cmd_finish_wait_count;
1664
1665         /*
1666          * Number of commands to complete (done) before resetting reservation,
1667          * protected by scst_mcmd_lock
1668          */
1669         int cmd_done_wait_count;
1670
1671         /* Number of completed commands, protected by scst_mcmd_lock */
1672         int completed_cmd_count;
1673
1674         uint64_t lun;   /* LUN for this mgmt cmd */
1675         /* or (and for iSCSI) */
1676         uint64_t tag;   /* tag of the corresponding cmd */
1677
1678         uint32_t cmd_sn; /* affected command's highest SN */
1679
1680         /* corresponding cmd (to be aborted, found by tag) */
1681         struct scst_cmd *cmd_to_abort;
1682
1683         /* corresponding device for this mgmt cmd (found by lun) */
1684         struct scst_tgt_dev *mcmd_tgt_dev;
1685
1686         /* completition status, one of the SCST_MGMT_STATUS_* constants */
1687         int status;
1688
1689         /* Used for storage of target driver private stuff */
1690         void *tgt_priv;
1691 };
1692
1693 struct scst_device {
1694         struct scst_dev_type *handler;  /* corresponding dev handler */
1695
1696         struct scst_mem_lim dev_mem_lim;
1697
1698         unsigned short type;    /* SCSI type of the device */
1699
1700         /*************************************************************
1701          ** Dev's flags. Updates serialized by dev_lock or suspended
1702          ** activity
1703          *************************************************************/
1704
1705         /* Set if dev is RESERVED */
1706         unsigned short dev_reserved:1;
1707
1708         /* Set if double reset UA is possible */
1709         unsigned short dev_double_ua_possible:1;
1710
1711         /* If set, dev is read only */
1712         unsigned short rd_only:1;
1713
1714         /**************************************************************/
1715
1716         /*************************************************************
1717          ** Dev's control mode page related values. Updates serialized
1718          ** by scst_block_dev(). It's long to not interfere with the
1719          ** above flags.
1720          *************************************************************/
1721
1722         unsigned long queue_alg:4;
1723         unsigned long tst:3;
1724         unsigned long tas:1;
1725         unsigned long swp:1;
1726         unsigned long d_sense:1;
1727
1728         /*
1729          * Set if device implements own ordered commands management. If not set
1730          * and queue_alg is SCST_CONTR_MODE_QUEUE_ALG_RESTRICTED_REORDER,
1731          * expected_sn will be incremented only after commands finished.
1732          */
1733         unsigned long has_own_order_mgmt:1;
1734
1735         /**************************************************************/
1736
1737         /* Used for storage of dev handler private stuff */
1738         void *dh_priv;
1739
1740 #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 18)
1741         /* Used to translate SCSI's cmd to SCST's cmd */
1742         struct gendisk *rq_disk;
1743 #endif
1744
1745         /* Corresponding real SCSI device, could be NULL for virtual devices */
1746         struct scsi_device *scsi_dev;
1747
1748         /* Pointer to lists of commands with the lock */
1749         struct scst_cmd_lists *p_cmd_lists;
1750
1751         /* Lists of commands with lock, if dedicated threads are used */
1752         struct scst_cmd_lists cmd_lists;
1753
1754         /* Per-device dedicated IO context */
1755         struct io_context *dev_io_ctx;
1756
1757         /* How many cmds alive on this dev */
1758         atomic_t dev_cmd_count;
1759
1760         /* How many write cmds alive on this dev. Temporary, ToDo */
1761         atomic_t write_cmd_count;
1762
1763         spinlock_t dev_lock;            /* device lock */
1764
1765         /*
1766          * How many times device was blocked for new cmds execution.
1767          * Protected by dev_lock
1768          */
1769         int block_count;
1770
1771         /*
1772          * How many there are "on_dev" commands, i.e. ones those are being
1773          * executed by the underlying SCSI/virtual device.
1774          */
1775         atomic_t on_dev_count;
1776
1777         struct list_head blocked_cmd_list; /* protected by dev_lock */
1778
1779         /* Used to wait for requested amount of "on_dev" commands */
1780         wait_queue_head_t on_dev_waitQ;
1781
1782         /* A list entry used during TM, protected by scst_mutex */
1783         struct list_head tm_dev_list_entry;
1784
1785         /* Virtual device internal ID */
1786         int virt_id;
1787
1788         /* Pointer to virtual device name, for convenience only */
1789         char *virt_name;
1790
1791         /* List entry in global devices list */
1792         struct list_head dev_list_entry;
1793
1794         /*
1795          * List of tgt_dev's, one per session, protected by scst_mutex or
1796          * dev_lock for reads and both for writes
1797          */
1798         struct list_head dev_tgt_dev_list;
1799
1800         /* List of acg_dev's, one per acg, protected by scst_mutex */
1801         struct list_head dev_acg_dev_list;
1802
1803         /* List of dedicated threads, protected by scst_mutex */
1804         struct list_head threads_list;
1805
1806         /* Device number */
1807         int dev_num;
1808
1809         /* Set if tgt_kobj was initialized */
1810         unsigned int dev_kobj_initialized:1;
1811
1812         /*
1813          * Used to protect sysfs attributes to be called after this
1814          * object was unregistered.
1815          */
1816         struct rw_semaphore dev_attr_rwsem;
1817
1818         struct kobject dev_kobj; /* kobject for this struct */
1819         struct kobject *dev_exp_kobj; /* exported groups */
1820
1821         /* Export number in the dev's sysfs list. Protected by scst_mutex */
1822         int dev_exported_lun_num;
1823 };
1824
1825 /*
1826  * Used to store threads local tgt_dev specific data
1827  */
1828 struct scst_thr_data_hdr {
1829         /* List entry in tgt_dev->thr_data_list */
1830         struct list_head thr_data_list_entry;
1831         struct task_struct *owner_thr; /* the owner thread */
1832         atomic_t ref;
1833         /* Function that will be called on the tgt_dev destruction */
1834         void (*free_fn) (struct scst_thr_data_hdr *data);
1835 };
1836
1837 /*
1838  * Used to store per-session specific device information
1839  */
1840 struct scst_tgt_dev {
1841         /* List entry in sess->sess_tgt_dev_list_hash */
1842         struct list_head sess_tgt_dev_list_entry;
1843
1844         struct scst_device *dev; /* to save extra dereferences */
1845         uint64_t lun;            /* to save extra dereferences */
1846
1847         gfp_t gfp_mask;
1848         struct sgv_pool *pool;
1849         int max_sg_cnt;
1850
1851         unsigned long tgt_dev_flags;    /* tgt_dev's async flags */
1852
1853         /* Used for storage of dev handler private stuff */
1854         void *dh_priv;
1855
1856         /* How many cmds alive on this dev in this session */
1857         atomic_t tgt_dev_cmd_count;
1858
1859         /*
1860          * Used to execute cmd's in order of arrival, honoring SCSI task
1861          * attributes.
1862          *
1863          * Protected by sn_lock, except expected_sn, which is protected by
1864          * itself. Curr_sn must have the same size as expected_sn to
1865          * overflow simultaneously.
1866          */
1867         int def_cmd_count;
1868         spinlock_t sn_lock;
1869         unsigned int expected_sn;
1870         unsigned int curr_sn;
1871         int hq_cmd_count;
1872         struct list_head deferred_cmd_list;
1873         struct list_head skipped_sn_list;
1874
1875         /*
1876          * Set if the prev cmd was ORDERED. Size must allow unprotected
1877          * modifications independant to the neighbour fields.
1878          */
1879         unsigned long prev_cmd_ordered;
1880
1881         int num_free_sn_slots; /* if it's <0, then all slots are busy */
1882         atomic_t *cur_sn_slot;
1883         atomic_t sn_slots[15];
1884
1885         /* List of scst_thr_data_hdr and lock */
1886         spinlock_t thr_data_lock;
1887         struct list_head thr_data_list;
1888
1889         /* Per-(device, session) dedicated IO context */
1890         struct io_context *tgt_dev_io_ctx;
1891
1892         spinlock_t tgt_dev_lock;        /* per-session device lock */
1893
1894         /* List of UA's for this device, protected by tgt_dev_lock */
1895         struct list_head UA_list;
1896
1897         struct scst_session *sess;      /* corresponding session */
1898         struct scst_acg_dev *acg_dev;   /* corresponding acg_dev */
1899
1900         /* List entry in dev->dev_tgt_dev_list */
1901         struct list_head dev_tgt_dev_list_entry;
1902
1903         /* Internal tmp list entry */
1904         struct list_head extra_tgt_dev_list_entry;
1905
1906         /* Set if INQUIRY DATA HAS CHANGED UA is needed */
1907         unsigned int inq_changed_ua_needed:1;
1908
1909         /*
1910          * Stored Unit Attention sense and its length for possible
1911          * subsequent REQUEST SENSE. Both protected by tgt_dev_lock.
1912          */
1913         unsigned short tgt_dev_valid_sense_len;
1914         uint8_t tgt_dev_sense[SCST_SENSE_BUFFERSIZE];
1915
1916 #ifdef CONFIG_SCST_MEASURE_LATENCY
1917         /*
1918          * Must be the last to allow to work with drivers who don't know
1919          * about this config time option.
1920          *
1921          * Protected by sess->lat_lock.
1922          */
1923         uint64_t scst_time, tgt_time, dev_time;
1924         unsigned int processed_cmds;
1925         struct scst_ext_latency_stat dev_latency_stat[SCST_LATENCY_STATS_NUM];
1926 #endif
1927 };
1928
1929 /*
1930  * Used to store ACG-specific device information, like LUN
1931  */
1932 struct scst_acg_dev {
1933         struct scst_device *dev; /* corresponding device */
1934
1935         uint64_t lun; /* device's LUN in this acg */
1936
1937         /* If set, the corresponding LU is read only */
1938         unsigned int rd_only:1;
1939
1940         /* Set if acg_dev_kobj was initialized */
1941         unsigned int acg_dev_kobj_initialized:1;
1942
1943         struct scst_acg *acg; /* parent acg */
1944
1945         /* List entry in dev->dev_acg_dev_list */
1946         struct list_head dev_acg_dev_list_entry;
1947
1948         /* List entry in acg->acg_dev_list */
1949         struct list_head acg_dev_list_entry;
1950
1951         /* kobject for this structure */
1952         struct kobject acg_dev_kobj;
1953 };
1954
1955 /*
1956  * ACG - access control group. Used to store group related
1957  * control information.
1958  */
1959 struct scst_acg {
1960         /* List of acg_dev's in this acg, protected by scst_mutex */
1961         struct list_head acg_dev_list;
1962
1963         /* List of attached sessions, protected by scst_mutex */
1964         struct list_head acg_sess_list;
1965
1966         /* List of attached acn's, protected by scst_mutex */
1967         struct list_head acn_list;
1968
1969         /* List entry in scst_acg_list */
1970         struct list_head scst_acg_list_entry;
1971
1972         /* Name of this acg */
1973         const char *acg_name;
1974
1975 #ifdef CONFIG_SCST_PROC
1976         /* The pointer to the /proc directory entry */
1977         struct proc_dir_entry *acg_proc_root;
1978 #endif
1979 };
1980
1981 /*
1982  * ACN - access control name. Used to store names, by which
1983  * incoming sessions will be assigned to appropriate ACG.
1984  */
1985 struct scst_acn {
1986         /* Initiator's name */
1987         const char *name;
1988         /* List entry in acg->acn_list */
1989         struct list_head acn_list_entry;
1990 };
1991
1992 /*
1993  * Used to store per-session UNIT ATTENTIONs
1994  */
1995 struct scst_tgt_dev_UA {
1996         /* List entry in tgt_dev->UA_list */
1997         struct list_head UA_list_entry;
1998
1999         /* Set if UA is global for session */
2000         unsigned short global_UA:1;
2001
2002         /* Unit Attention valid sense len */
2003         unsigned short UA_valid_sense_len;
2004         /* Unit Attention sense buf */
2005         uint8_t UA_sense_buffer[SCST_SENSE_BUFFERSIZE];
2006 };
2007
2008 /* Used to deliver AENs */
2009 struct scst_aen {
2010         int event_fn; /* AEN fn */
2011
2012         struct scst_session *sess;      /* corresponding session */
2013         uint64_t lun;                   /* corresponding LUN in SCSI form */
2014
2015         union {
2016                 /* SCSI AEN data */
2017                 struct {
2018                         int aen_sense_len;
2019                         uint8_t aen_sense[SCST_STANDARD_SENSE_LEN];
2020                 };
2021         };
2022
2023         /* Keeps status of AEN's delivery to remote initiator */
2024         int delivery_status;
2025 };
2026
2027 #ifndef smp_mb__after_set_bit
2028 /* There is no smp_mb__after_set_bit() in the kernel */
2029 #define smp_mb__after_set_bit()                 smp_mb()
2030 #endif
2031
2032 /*
2033  * Registers target template.
2034  * Returns 0 on success or appropriate error code otherwise.
2035  *
2036  * Note: *vtt must be static!
2037  */
2038 int __scst_register_target_template(struct scst_tgt_template *vtt,
2039         const char *version);
2040 static inline int scst_register_target_template(struct scst_tgt_template *vtt)
2041 {
2042         return __scst_register_target_template(vtt, SCST_INTERFACE_VERSION);
2043 }
2044
2045 /*
2046  * Unregisters target template
2047  */
2048 void scst_unregister_target_template(struct scst_tgt_template *vtt);
2049
2050 /*
2051  * Registers and returns target adapter
2052  * Returns new target structure on success or NULL otherwise.
2053  *
2054  * If parameter "target_name" isn't NULL, then security group with name
2055  * "Default_##target_name", if created, will be used as the default
2056  * instead of "Default" one for all initiators not assigned to any other group.
2057  */
2058 struct scst_tgt *scst_register(struct scst_tgt_template *vtt,
2059         const char *target_name);
2060
2061 /*
2062  * Unregisters target adapter
2063  */
2064 void scst_unregister(struct scst_tgt *tgt);
2065
2066 /*
2067  * Registers and returns a session
2068  *
2069  * Returns new session on success or NULL otherwise
2070  *
2071  * Parameters:
2072  *   tgt    - target
2073  *   atomic - true, if the function called in the atomic context. If false,
2074  *      this function will block until the session registration is completed.
2075  *   initiator_name - remote initiator's name, any NULL-terminated string,
2076  *      e.g. iSCSI name, which used as the key to found appropriate access
2077  *      control group. Could be NULL, then the default target's LUNs are used.
2078  *   data - any target driver supplied data
2079  *   result_fn - pointer to the function that will be
2080  *      asynchronously called when session initialization finishes.
2081  *      Can be NULL. Parameters:
2082  *       - sess - session
2083  *       - data - target driver supplied to scst_register_session() data
2084  *       - result - session initialization result, 0 on success or
2085  *                  appropriate error code otherwise
2086  *
2087  * Note: A session creation and initialization is a complex task,
2088  *       which requires sleeping state, so it can't be fully done
2089  *       in interrupt context. Therefore the "bottom half" of it, if
2090  *       scst_register_session() is called from atomic context, will be
2091  *       done in SCST thread context. In this case scst_register_session()
2092  *       will return not completely initialized session, but the target
2093  *       driver can supply commands to this session via scst_rx_cmd().
2094  *       Those commands processing will be delayed inside SCST until
2095  *       the session initialization is finished, then their processing
2096  *       will be restarted. The target driver will be notified about
2097  *       finish of the session initialization by function result_fn().
2098  *       On success the target driver could do nothing, but if the
2099  *       initialization fails, the target driver must ensure that
2100  *       no more new commands being sent or will be sent to SCST after
2101  *       result_fn() returns. All already sent to SCST commands for
2102  *       failed session will be returned in xmit_response() with BUSY status.
2103  *       In case of failure the driver shall call scst_unregister_session()
2104  *       inside result_fn(), it will NOT be called automatically.
2105  */
2106 struct scst_session *scst_register_session(struct scst_tgt *tgt, int atomic,
2107         const char *initiator_name, void *data,
2108         void (*result_fn) (struct scst_session *sess, void *data, int result));
2109
2110 /*
2111  * Unregisters a session.
2112  * Parameters:
2113  *   sess - session to be unregistered
2114  *   wait - if true, instructs to wait until all commands, which
2115  *      currently is being executed and belonged to the session, finished.
2116  *      Otherwise, target driver should be prepared to receive
2117  *      xmit_response() for the session's command after
2118  *      scst_unregister_session() returns.
2119  *   unreg_done_fn - pointer to the function that will be
2120  *      asynchronously called when the last session's command finishes and
2121  *      the session is about to be completely freed. Can be NULL.
2122  *      Parameter:
2123  *       - sess - session
2124  *
2125  * Notes:
2126  *
2127  * - All outstanding commands will be finished regularly. After
2128  *   scst_unregister_session() returned no new commands must be sent to
2129  *   SCST via scst_rx_cmd().
2130  *
2131  * - The caller must ensure that no scst_rx_cmd() or scst_rx_mgmt_fn_*() is
2132  *   called in paralell with scst_unregister_session().
2133  *
2134  * - Can be called before result_fn() of scst_register_session() called,
2135  *   i.e. during the session registration/initialization.
2136  *
2137  * - It is highly recommended to call scst_unregister_session() as soon as it
2138  *   gets clear that session will be unregistered and not to wait until all
2139  *   related commands finished. This function provides the wait functionality,
2140  *   but it also starts recovering stuck commands, if there are any.
2141  *   Otherwise, your target driver could wait for those commands forever.
2142  */
2143 void scst_unregister_session(struct scst_session *sess, int wait,
2144         void (*unreg_done_fn) (struct scst_session *sess));
2145
2146 /*
2147  * Registers dev handler driver.
2148  * Returns 0 on success or appropriate error code otherwise.
2149  *
2150  * Note: *dev_type must be static!
2151  */
2152 int __scst_register_dev_driver(struct scst_dev_type *dev_type,
2153         const char *version);
2154 static inline int scst_register_dev_driver(struct scst_dev_type *dev_type)
2155 {
2156         return __scst_register_dev_driver(dev_type, SCST_INTERFACE_VERSION);
2157 }
2158
2159 /*
2160  * Unregisters dev handler driver
2161  */
2162 void scst_unregister_dev_driver(struct scst_dev_type *dev_type);
2163
2164 /*
2165  * Registers dev handler driver for virtual devices (eg VDISK).
2166  * Returns 0 on success or appropriate error code otherwise.
2167  *
2168  * Note: *dev_type must be static!
2169  */
2170 int __scst_register_virtual_dev_driver(struct scst_dev_type *dev_type,
2171         const char *version);
2172 static inline int scst_register_virtual_dev_driver(
2173         struct scst_dev_type *dev_type)
2174 {
2175         return __scst_register_virtual_dev_driver(dev_type,
2176                 SCST_INTERFACE_VERSION);
2177 }
2178
2179 /*
2180  * Unregisters dev handler driver for virtual devices
2181  */
2182 void scst_unregister_virtual_dev_driver(struct scst_dev_type *dev_type);
2183
2184 /*
2185  * Creates and sends new command to SCST.
2186  * Must not be called in parallel with scst_unregister_session() for the
2187  * same sess. Returns the command on success or NULL otherwise
2188  */
2189 struct scst_cmd *scst_rx_cmd(struct scst_session *sess,
2190         const uint8_t *lun, int lun_len, const uint8_t *cdb,
2191         int cdb_len, int atomic);
2192
2193 /*
2194  * Notifies SCST that the driver finished its part of the command
2195  * initialization, and the command is ready for execution.
2196  * The second argument sets preferred command execition context.
2197  * See SCST_CONTEXT_* constants for details.
2198  *
2199  * !!IMPORTANT!!
2200  *
2201  * If cmd->set_sn_on_restart_cmd not set, this function, as well as
2202  * scst_cmd_init_stage1_done() and scst_restart_cmd(), must not be
2203  * called simultaneously for the same session (more precisely,
2204  * for the same session/LUN, i.e. tgt_dev), i.e. they must be
2205  * somehow externally serialized. This is needed to have lock free fast path in
2206  * scst_cmd_set_sn(). For majority of targets those functions are naturally
2207  * serialized by the single source of commands. Only iSCSI immediate commands
2208  * with multiple connections per session seems to be an exception. For it, some
2209  * mutex/lock shall be used for the serialization.
2210  */
2211 void scst_cmd_init_done(struct scst_cmd *cmd,
2212         enum scst_exec_context pref_context);
2213
2214 /*
2215  * Notifies SCST that the driver finished the first stage of the command
2216  * initialization, and the command is ready for execution, but after
2217  * SCST done the command's preprocessing preprocessing_done() function
2218  * should be called. The second argument sets preferred command execition
2219  * context. See SCST_CONTEXT_* constants for details.
2220  *
2221  * See also scst_cmd_init_done() comment for the serialization requirements.
2222  */
2223 static inline void scst_cmd_init_stage1_done(struct scst_cmd *cmd,
2224         enum scst_exec_context pref_context, int set_sn)
2225 {
2226         cmd->preprocessing_only = 1;
2227         cmd->set_sn_on_restart_cmd = !set_sn;
2228         scst_cmd_init_done(cmd, pref_context);
2229 }
2230
2231 /*
2232  * Notifies SCST that the driver finished its part of the command's
2233  * preprocessing and it is ready for further processing.
2234  * The second argument sets data receiving completion status
2235  * (see SCST_PREPROCESS_STATUS_* constants for details)
2236  * The third argument sets preferred command execition context
2237  * (see SCST_CONTEXT_* constants for details).
2238  *
2239  * See also scst_cmd_init_done() comment for the serialization requirements.
2240  */
2241 void scst_restart_cmd(struct scst_cmd *cmd, int status,
2242         enum scst_exec_context pref_context);
2243
2244 /*
2245  * Notifies SCST that the driver received all the necessary data
2246  * and the command is ready for further processing.
2247  * The second argument sets data receiving completion status
2248  * (see SCST_RX_STATUS_* constants for details)
2249  * The third argument sets preferred command execition context
2250  * (see SCST_CONTEXT_* constants for details)
2251  */
2252 void scst_rx_data(struct scst_cmd *cmd, int status,
2253         enum scst_exec_context pref_context);
2254
2255 /*
2256  * Notifies SCST that the driver sent the response and the command
2257  * can be freed now. Don't forget to set the delivery status, if it
2258  * isn't success, using scst_set_delivery_status() before calling
2259  * this function. The third argument sets preferred command execition
2260  * context (see SCST_CONTEXT_* constants for details)
2261  */
2262 void scst_tgt_cmd_done(struct scst_cmd *cmd,
2263         enum scst_exec_context pref_context);
2264
2265 /*
2266  * Creates new management command sends it for execution.
2267  * Must not be called in parallel with scst_unregister_session() for the
2268  * same sess. Returns 0 for success, error code otherwise.
2269  */
2270 int scst_rx_mgmt_fn(struct scst_session *sess,
2271         const struct scst_rx_mgmt_params *params);
2272
2273 /*
2274  * Creates new management command using tag and sends it for execution.
2275  * Can be used for SCST_ABORT_TASK only.
2276  * Must not be called in parallel with scst_unregister_session() for the
2277  * same sess. Returns 0 for success, error code otherwise.
2278  *
2279  * Obsolete in favor of scst_rx_mgmt_fn()
2280  */
2281 static inline int scst_rx_mgmt_fn_tag(struct scst_session *sess, int fn,
2282         uint64_t tag, int atomic, void *tgt_priv)
2283 {
2284         struct scst_rx_mgmt_params params;
2285
2286         BUG_ON(fn != SCST_ABORT_TASK);
2287
2288         memset(&params, 0, sizeof(params));
2289         params.fn = fn;
2290         params.tag = tag;
2291         params.tag_set = 1;
2292         params.atomic = atomic;
2293         params.tgt_priv = tgt_priv;
2294         return scst_rx_mgmt_fn(sess, &params);
2295 }
2296
2297 /*
2298  * Creates new management command using LUN and sends it for execution.
2299  * Currently can be used for any fn, except SCST_ABORT_TASK.
2300  * Must not be called in parallel with scst_unregister_session() for the
2301  * same sess. Returns 0 for success, error code otherwise.
2302  *
2303  * Obsolete in favor of scst_rx_mgmt_fn()
2304  */
2305 static inline int scst_rx_mgmt_fn_lun(struct scst_session *sess, int fn,
2306         const uint8_t *lun, int lun_len, int atomic, void *tgt_priv)
2307 {
2308         struct scst_rx_mgmt_params params;
2309
2310         BUG_ON(fn == SCST_ABORT_TASK);
2311
2312         memset(&params, 0, sizeof(params));
2313         params.fn = fn;
2314         params.lun = lun;
2315         params.lun_len = lun_len;
2316         params.lun_set = 1;
2317         params.atomic = atomic;
2318         params.tgt_priv = tgt_priv;
2319         return scst_rx_mgmt_fn(sess, &params);
2320 }
2321
2322 /*
2323  * Provides various info about command's CDB.
2324  *
2325  * Returns: 0 on success, <0 if command is unknown, >0 if command is invalid.
2326  */
2327 int scst_get_cdb_info(struct scst_cmd *cmd);
2328
2329 /*
2330  * Set error SCSI status in the command and prepares it for returning it.
2331  *
2332  * Returns 0 on success, error code otherwise.
2333  */
2334 int scst_set_cmd_error_status(struct scst_cmd *cmd, int status);
2335
2336 /*
2337  * Set error in the command and fill the sense buffer.
2338  *
2339  * Returns 0 on success, error code otherwise.
2340  */
2341 int scst_set_cmd_error(struct scst_cmd *cmd, int key, int asc, int ascq);
2342
2343 /*
2344  * Sets BUSY or TASK QUEUE FULL status
2345  */
2346 void scst_set_busy(struct scst_cmd *cmd);
2347
2348 /*
2349  * Check if sense in the sense buffer, if any, in the correct format. If not,
2350  * convert it to the correct format.
2351  */
2352 void scst_check_convert_sense(struct scst_cmd *cmd);
2353
2354 /*
2355  * Sets initial Unit Attention for sess, replacing default scst_sense_reset_UA
2356  */
2357 void scst_set_initial_UA(struct scst_session *sess, int key, int asc, int ascq);
2358
2359 /*
2360  * Notifies SCST core that dev changed its capacity
2361  */
2362 void scst_capacity_data_changed(struct scst_device *dev);
2363
2364 /*
2365  * Finds a command based on the supplied tag comparing it with one
2366  * that previously set by scst_cmd_set_tag().
2367  * Returns the command on success or NULL otherwise
2368  */
2369 struct scst_cmd *scst_find_cmd_by_tag(struct scst_session *sess, uint64_t tag);
2370
2371 /*
2372  * Finds a command based on user supplied data and comparision
2373  * callback function, that should return true, if the command is found.
2374  * Returns the command on success or NULL otherwise
2375  */
2376 struct scst_cmd *scst_find_cmd(struct scst_session *sess, void *data,
2377                                int (*cmp_fn) (struct scst_cmd *cmd,
2378                                               void *data));
2379
2380 /*
2381  * Translates SCST's data direction to DMA one from backend storage
2382  * perspective.
2383  */
2384 enum dma_data_direction scst_to_dma_dir(int scst_dir);
2385
2386 /*
2387  * Translates SCST data direction to DMA data direction from the perspective
2388  * of the target device.
2389  */
2390 enum dma_data_direction scst_to_tgt_dma_dir(int scst_dir);
2391
2392 /*
2393  * Returns true, if cmd's CDB is fully locally handled by SCST and false
2394  * otherwise. Dev handlers parse() and dev_done() not called for such commands.
2395  */
2396 static inline bool scst_is_cmd_fully_local(struct scst_cmd *cmd)
2397 {
2398         return (cmd->op_flags & SCST_FULLY_LOCAL_CMD) != 0;
2399 }
2400
2401 /*
2402  * Returns true, if cmd's CDB is locally handled by SCST and
2403  * false otherwise.
2404  */
2405 static inline bool scst_is_cmd_local(struct scst_cmd *cmd)
2406 {
2407         return (cmd->op_flags & SCST_LOCAL_CMD) != 0;
2408 }
2409
2410 /* Returns true, if cmd can deliver UA */
2411 static inline bool scst_is_ua_command(struct scst_cmd *cmd)
2412 {
2413         return (cmd->op_flags & SCST_SKIP_UA) == 0;
2414 }
2415
2416 /*
2417  * Registers a virtual device.
2418  * Parameters:
2419  *   dev_type - the device's device handler
2420  *   dev_name - the new device name, NULL-terminated string. Must be uniq
2421  *              among all virtual devices in the system. The value isn't
2422  *              copied, only the reference is stored, so the value must
2423  *              remain valid during the device lifetime.
2424  * Returns assinged to the device ID on success, or negative value otherwise
2425  */
2426 int scst_register_virtual_device(struct scst_dev_type *dev_handler,
2427         const char *dev_name);
2428
2429 /*
2430  * Unegisters a virtual device.
2431  * Parameters:
2432  *   id - the device's ID, returned by the registration function
2433  */
2434 void scst_unregister_virtual_device(int id);
2435
2436 /*
2437  * Get/Set functions for tgt's sg_tablesize
2438  */
2439 static inline int scst_tgt_get_sg_tablesize(struct scst_tgt *tgt)
2440 {
2441         return tgt->sg_tablesize;
2442 }
2443
2444 static inline void scst_tgt_set_sg_tablesize(struct scst_tgt *tgt, int val)
2445 {
2446         tgt->sg_tablesize = val;
2447 }
2448
2449 /*
2450  * Get/Set functions for tgt's target private data
2451  */
2452 static inline void *scst_tgt_get_tgt_priv(struct scst_tgt *tgt)
2453 {
2454         return tgt->tgt_priv;
2455 }
2456
2457 static inline void scst_tgt_set_tgt_priv(struct scst_tgt *tgt, void *val)
2458 {
2459         tgt->tgt_priv = val;
2460 }
2461
2462 /*
2463  * Get/Set functions for session's target private data
2464  */
2465 static inline void *scst_sess_get_tgt_priv(struct scst_session *sess)
2466 {
2467         return sess->tgt_priv;
2468 }
2469
2470 static inline void scst_sess_set_tgt_priv(struct scst_session *sess,
2471                                               void *val)
2472 {
2473         sess->tgt_priv = val;
2474 }
2475
2476 /**
2477  * Returns TRUE if cmd is being executed in atomic context.
2478  *
2479  * Note: checkpatch will complain on the use of in_atomic() below. You can
2480  * safely ignore this warning since in_atomic() is used here only for debugging
2481  * purposes.
2482  */
2483 static inline int scst_cmd_atomic(struct scst_cmd *cmd)
2484 {
2485         int res = cmd->atomic;
2486 #ifdef CONFIG_SCST_EXTRACHECKS
2487         if (unlikely((in_atomic() || in_interrupt() || irqs_disabled()) &&
2488                      !res)) {
2489                 printk(KERN_ERR "ERROR: atomic context and non-atomic cmd\n");
2490                 dump_stack();
2491                 cmd->atomic = 1;
2492                 res = 1;
2493         }
2494 #endif
2495         return res;
2496 }
2497
2498 /*
2499  * Returns TRUE if cmd has been completed.
2500  */
2501 static inline int scst_cmd_completed(struct scst_cmd *cmd)
2502 {
2503         return cmd->completed;
2504 }
2505
2506 static inline enum scst_exec_context __scst_estimate_context(bool direct)
2507 {
2508         if (in_irq())
2509                 return SCST_CONTEXT_TASKLET;
2510         else if (irqs_disabled())
2511                 return SCST_CONTEXT_THREAD;
2512         else
2513                 return direct ? SCST_CONTEXT_DIRECT :
2514                                 SCST_CONTEXT_DIRECT_ATOMIC;
2515 }
2516
2517 static inline enum scst_exec_context scst_estimate_context(void)
2518 {
2519         return __scst_estimate_context(0);
2520 }
2521
2522 static inline enum scst_exec_context scst_estimate_context_direct(void)
2523 {
2524         return __scst_estimate_context(1);
2525 }
2526
2527 /* Returns cmd's CDB */
2528 static inline const uint8_t *scst_cmd_get_cdb(struct scst_cmd *cmd)
2529 {
2530         return cmd->cdb;
2531 }
2532
2533 /* Returns cmd's CDB length */
2534 static inline int scst_cmd_get_cdb_len(struct scst_cmd *cmd)
2535 {
2536         return cmd->cdb_len;
2537 }
2538
2539 /* Returns cmd's extended CDB */
2540 static inline const uint8_t *scst_cmd_get_ext_cdb(struct scst_cmd *cmd)
2541 {
2542         return cmd->ext_cdb;
2543 }
2544
2545 /* Returns cmd's extended CDB length */
2546 static inline int scst_cmd_get_ext_cdb_len(struct scst_cmd *cmd)
2547 {
2548         return cmd->ext_cdb_len;
2549 }
2550
2551 /* Sets cmd's extended CDB and its length */
2552 static inline void scst_cmd_set_ext_cdb(struct scst_cmd *cmd,
2553         uint8_t *ext_cdb, unsigned int ext_cdb_len)
2554 {
2555         cmd->ext_cdb = ext_cdb;
2556         cmd->ext_cdb_len = ext_cdb_len;
2557 }
2558
2559 /* Returns cmd's session */
2560 static inline struct scst_session *scst_cmd_get_session(struct scst_cmd *cmd)
2561 {
2562         return cmd->sess;
2563 }
2564
2565 /* Returns cmd's response data length */
2566 static inline int scst_cmd_get_resp_data_len(struct scst_cmd *cmd)
2567 {
2568         return cmd->resp_data_len;
2569 }
2570
2571 /* Returns if status should be sent for cmd */
2572 static inline int scst_cmd_get_is_send_status(struct scst_cmd *cmd)
2573 {
2574         return cmd->is_send_status;
2575 }
2576
2577 /*
2578  * Returns pointer to cmd's SG data buffer.
2579  *
2580  * Usage of this function is not recommended, use scst_get_buf_*()
2581  * family of functions instead.
2582  */
2583 static inline struct scatterlist *scst_cmd_get_sg(struct scst_cmd *cmd)
2584 {
2585         return cmd->sg;
2586 }
2587
2588 /*
2589  * Returns cmd's sg_cnt.
2590  *
2591  * Usage of this function is not recommended, use scst_get_buf_*()
2592  * family of functions instead.
2593  */
2594 static inline int scst_cmd_get_sg_cnt(struct scst_cmd *cmd)
2595 {
2596         return cmd->sg_cnt;
2597 }
2598
2599 /*
2600  * Returns cmd's data buffer length.
2601  *
2602  * In case if you need to iterate over data in the buffer, usage of
2603  * this function is not recommended, use scst_get_buf_*()
2604  * family of functions instead.
2605  */
2606 static inline unsigned int scst_cmd_get_bufflen(struct scst_cmd *cmd)
2607 {
2608         return cmd->bufflen;
2609 }
2610
2611 /*
2612  * Returns pointer to cmd's bidirectional in (WRITE) SG data buffer.
2613  *
2614  * Usage of this function is not recommended, use scst_get_in_buf_*()
2615  * family of functions instead.
2616  */
2617 static inline struct scatterlist *scst_cmd_get_in_sg(struct scst_cmd *cmd)
2618 {
2619         return cmd->in_sg;
2620 }
2621
2622 /*
2623  * Returns cmd's bidirectional in (WRITE) sg_cnt.
2624  *
2625  * Usage of this function is not recommended, use scst_get_in_buf_*()
2626  * family of functions instead.
2627  */
2628 static inline int scst_cmd_get_in_sg_cnt(struct scst_cmd *cmd)
2629 {
2630         return cmd->in_sg_cnt;
2631 }
2632
2633 /*
2634  * Returns cmd's bidirectional in (WRITE) data buffer length.
2635  *
2636  * In case if you need to iterate over data in the buffer, usage of
2637  * this function is not recommended, use scst_get_in_buf_*()
2638  * family of functions instead.
2639  */
2640 static inline unsigned int scst_cmd_get_in_bufflen(struct scst_cmd *cmd)
2641 {
2642         return cmd->in_bufflen;
2643 }
2644
2645 /* Returns pointer to cmd's target's SG data buffer */
2646 static inline struct scatterlist *scst_cmd_get_tgt_sg(struct scst_cmd *cmd)
2647 {
2648         return cmd->tgt_sg;
2649 }
2650
2651 /* Returns cmd's target's sg_cnt */
2652 static inline int scst_cmd_get_tgt_sg_cnt(struct scst_cmd *cmd)
2653 {
2654         return cmd->tgt_sg_cnt;
2655 }
2656
2657 /* Sets cmd's target's SG data buffer */
2658 static inline void scst_cmd_set_tgt_sg(struct scst_cmd *cmd,
2659         struct scatterlist *sg, int sg_cnt)
2660 {
2661         cmd->tgt_sg = sg;
2662         cmd->tgt_sg_cnt = sg_cnt;
2663         cmd->tgt_data_buf_alloced = 1;
2664 }
2665
2666 /* Returns pointer to cmd's target's IN SG data buffer */
2667 static inline struct scatterlist *scst_cmd_get_in_tgt_sg(struct scst_cmd *cmd)
2668 {
2669         return cmd->tgt_in_sg;
2670 }
2671
2672 /* Returns cmd's target's IN sg_cnt */
2673 static inline int scst_cmd_get_tgt_in_sg_cnt(struct scst_cmd *cmd)
2674 {
2675         return cmd->tgt_in_sg_cnt;
2676 }
2677
2678 /* Sets cmd's target's IN SG data buffer */
2679 static inline void scst_cmd_set_tgt_in_sg(struct scst_cmd *cmd,
2680         struct scatterlist *sg, int sg_cnt)
2681 {
2682         WARN_ON(!cmd->tgt_data_buf_alloced);
2683
2684         cmd->tgt_in_sg = sg;
2685         cmd->tgt_in_sg_cnt = sg_cnt;
2686 }
2687
2688 /* Returns cmd's data direction */
2689 static inline scst_data_direction scst_cmd_get_data_direction(
2690         struct scst_cmd *cmd)
2691 {
2692         return cmd->data_direction;
2693 }
2694
2695 /* Returns cmd's status byte from host device */
2696 static inline uint8_t scst_cmd_get_status(struct scst_cmd *cmd)
2697 {
2698         return cmd->status;
2699 }
2700
2701 /* Returns cmd's status from host adapter itself */
2702 static inline uint8_t scst_cmd_get_msg_status(struct scst_cmd *cmd)
2703 {
2704         return cmd->msg_status;
2705 }
2706
2707 /* Returns cmd's status set by low-level driver to indicate its status */
2708 static inline uint8_t scst_cmd_get_host_status(struct scst_cmd *cmd)
2709 {
2710         return cmd->host_status;
2711 }
2712
2713 /* Returns cmd's status set by SCSI mid-level */
2714 static inline uint8_t scst_cmd_get_driver_status(struct scst_cmd *cmd)
2715 {
2716         return cmd->driver_status;
2717 }
2718
2719 /* Returns pointer to cmd's sense buffer */
2720 static inline uint8_t *scst_cmd_get_sense_buffer(struct scst_cmd *cmd)
2721 {
2722         return cmd->sense;
2723 }
2724
2725 /* Returns cmd's valid sense length */
2726 static inline int scst_cmd_get_sense_buffer_len(struct scst_cmd *cmd)
2727 {
2728         return cmd->sense_valid_len;
2729 }
2730
2731 /*
2732  * Get/Set functions for cmd's target SN
2733  */
2734 static inline uint64_t scst_cmd_get_tag(struct scst_cmd *cmd)
2735 {
2736         return cmd->tag;
2737 }
2738
2739 static inline void scst_cmd_set_tag(struct scst_cmd *cmd, uint64_t tag)
2740 {
2741         cmd->tag = tag;
2742 }
2743
2744 /*
2745  * Get/Set functions for cmd's target private data.
2746  * Variant with *_lock must be used if target driver uses
2747  * scst_find_cmd() to avoid race with it, except inside scst_find_cmd()'s
2748  * callback, where lock is already taken.
2749  */
2750 static inline void *scst_cmd_get_tgt_priv(struct scst_cmd *cmd)
2751 {
2752         return cmd->tgt_priv;
2753 }
2754
2755 static inline void scst_cmd_set_tgt_priv(struct scst_cmd *cmd, void *val)
2756 {
2757         cmd->tgt_priv = val;
2758 }
2759
2760 void *scst_cmd_get_tgt_priv_lock(struct scst_cmd *cmd);
2761 void scst_cmd_set_tgt_priv_lock(struct scst_cmd *cmd, void *val);
2762
2763 /*
2764  * Get/Set functions for tgt_need_alloc_data_buf flag
2765  */
2766 static inline int scst_cmd_get_tgt_need_alloc_data_buf(struct scst_cmd *cmd)
2767 {
2768         return cmd->tgt_need_alloc_data_buf;
2769 }
2770
2771 static inline void scst_cmd_set_tgt_need_alloc_data_buf(struct scst_cmd *cmd)
2772 {
2773         cmd->tgt_need_alloc_data_buf = 1;
2774 }
2775
2776 /*
2777  * Get/Set functions for tgt_data_buf_alloced flag
2778  */
2779 static inline int scst_cmd_get_tgt_data_buff_alloced(struct scst_cmd *cmd)
2780 {
2781         return cmd->tgt_data_buf_alloced;
2782 }
2783
2784 static inline void scst_cmd_set_tgt_data_buff_alloced(struct scst_cmd *cmd)
2785 {
2786         cmd->tgt_data_buf_alloced = 1;
2787 }
2788
2789 /*
2790  * Get/Set functions for dh_data_buf_alloced flag
2791  */
2792 static inline int scst_cmd_get_dh_data_buff_alloced(struct scst_cmd *cmd)
2793 {
2794         return cmd->dh_data_buf_alloced;
2795 }
2796
2797 static inline void scst_cmd_set_dh_data_buff_alloced(struct scst_cmd *cmd)
2798 {
2799         cmd->dh_data_buf_alloced = 1;
2800 }
2801
2802 /*
2803  * Get/Set functions for no_sgv flag
2804  */
2805 static inline int scst_cmd_get_no_sgv(struct scst_cmd *cmd)
2806 {
2807         return cmd->no_sgv;
2808 }
2809
2810 static inline void scst_cmd_set_no_sgv(struct scst_cmd *cmd)
2811 {
2812         cmd->no_sgv = 1;
2813 }
2814
2815 /*
2816  * Get/Set functions for tgt_sn
2817  */
2818 static inline int scst_cmd_get_tgt_sn(struct scst_cmd *cmd)
2819 {
2820         BUG_ON(!cmd->tgt_sn_set);
2821         return cmd->tgt_sn;
2822 }
2823
2824 static inline void scst_cmd_set_tgt_sn(struct scst_cmd *cmd, uint32_t tgt_sn)
2825 {
2826         cmd->tgt_sn_set = 1;
2827         cmd->tgt_sn = tgt_sn;
2828 }
2829
2830 /*
2831  * Returns 1 if the cmd was aborted, so its status is invalid and no
2832  * reply shall be sent to the remote initiator. A target driver should
2833  * only clear internal resources, associated with cmd.
2834  */
2835 static inline int scst_cmd_aborted(struct scst_cmd *cmd)
2836 {
2837         return test_bit(SCST_CMD_ABORTED, &cmd->cmd_flags) &&
2838                 !test_bit(SCST_CMD_ABORTED_OTHER, &cmd->cmd_flags);
2839 }
2840
2841 /* Returns sense data format for cmd's dev */
2842 static inline bool scst_get_cmd_dev_d_sense(struct scst_cmd *cmd)
2843 {
2844         return (cmd->dev != NULL) ? cmd->dev->d_sense : 0;
2845 }
2846
2847 /*
2848  * Get/Set functions for expected data direction, transfer length
2849  * and its validity flag
2850  */
2851 static inline int scst_cmd_is_expected_set(struct scst_cmd *cmd)
2852 {
2853         return cmd->expected_values_set;
2854 }
2855
2856 static inline scst_data_direction scst_cmd_get_expected_data_direction(
2857         struct scst_cmd *cmd)
2858 {
2859         return cmd->expected_data_direction;
2860 }
2861
2862 static inline int scst_cmd_get_expected_transfer_len(
2863         struct scst_cmd *cmd)
2864 {
2865         return cmd->expected_transfer_len;
2866 }
2867
2868 static inline int scst_cmd_get_expected_in_transfer_len(
2869         struct scst_cmd *cmd)
2870 {
2871         return cmd->expected_in_transfer_len;
2872 }
2873
2874 static inline void scst_cmd_set_expected(struct scst_cmd *cmd,
2875         scst_data_direction expected_data_direction,
2876         int expected_transfer_len)
2877 {
2878         cmd->expected_data_direction = expected_data_direction;
2879         cmd->expected_transfer_len = expected_transfer_len;
2880         cmd->expected_values_set = 1;
2881 }
2882
2883 static inline void scst_cmd_set_expected_in_transfer_len(struct scst_cmd *cmd,
2884         int expected_in_transfer_len)
2885 {
2886         WARN_ON(!cmd->expected_values_set);
2887         cmd->expected_in_transfer_len = expected_in_transfer_len;
2888 }
2889
2890 /*
2891  * Get/clear functions for cmd's may_need_dma_sync
2892  */
2893 static inline int scst_get_may_need_dma_sync(struct scst_cmd *cmd)
2894 {
2895         return cmd->may_need_dma_sync;
2896 }
2897
2898 static inline void scst_clear_may_need_dma_sync(struct scst_cmd *cmd)
2899 {
2900         cmd->may_need_dma_sync = 0;
2901 }
2902
2903 /*
2904  * Get/set functions for cmd's delivery_status. It is one of
2905  * SCST_CMD_DELIVERY_* constants. It specifies the status of the
2906  * command's delivery to initiator.
2907  */
2908 static inline int scst_get_delivery_status(struct scst_cmd *cmd)
2909 {
2910         return cmd->delivery_status;
2911 }
2912
2913 static inline void scst_set_delivery_status(struct scst_cmd *cmd,
2914         int delivery_status)
2915 {
2916         cmd->delivery_status = delivery_status;
2917 }
2918
2919 /*
2920  * Get/Set function for mgmt cmd's target private data
2921  */
2922 static inline void *scst_mgmt_cmd_get_tgt_priv(struct scst_mgmt_cmd *mcmd)
2923 {
2924         return mcmd->tgt_priv;
2925 }
2926
2927 static inline void scst_mgmt_cmd_set_tgt_priv(struct scst_mgmt_cmd *mcmd,
2928         void *val)
2929 {
2930         mcmd->tgt_priv = val;
2931 }
2932
2933 /* Returns mgmt cmd's completition status (SCST_MGMT_STATUS_* constants) */
2934 static inline int scst_mgmt_cmd_get_status(struct scst_mgmt_cmd *mcmd)
2935 {
2936         return mcmd->status;
2937 }
2938
2939 /* Returns mgmt cmd's TM fn */
2940 static inline int scst_mgmt_cmd_get_fn(struct scst_mgmt_cmd *mcmd)
2941 {
2942         return mcmd->fn;
2943 }
2944
2945 /*
2946  * Called by dev handler's task_mgmt_fn() to notify SCST core that mcmd
2947  * is going to complete asynchronously.
2948  */
2949 void scst_prepare_async_mcmd(struct scst_mgmt_cmd *mcmd);
2950
2951 /*
2952  * Called by dev handler to notify SCST core that async. mcmd is completed
2953  * with status "status".
2954  */
2955 void scst_async_mcmd_completed(struct scst_mgmt_cmd *mcmd, int status);
2956
2957 /* Returns AEN's fn */
2958 static inline int scst_aen_get_event_fn(struct scst_aen *aen)
2959 {
2960         return aen->event_fn;
2961 }
2962
2963 /* Returns AEN's session */
2964 static inline struct scst_session *scst_aen_get_sess(struct scst_aen *aen)
2965 {
2966         return aen->sess;
2967 }
2968
2969 /* Returns AEN's LUN */
2970 static inline uint64_t scst_aen_get_lun(struct scst_aen *aen)
2971 {
2972         return aen->lun;
2973 }
2974
2975 /* Returns SCSI AEN's sense */
2976 static inline const uint8_t *scst_aen_get_sense(struct scst_aen *aen)
2977 {
2978         return aen->aen_sense;
2979 }
2980
2981 /* Returns SCSI AEN's sense length */
2982 static inline int scst_aen_get_sense_len(struct scst_aen *aen)
2983 {
2984         return aen->aen_sense_len;
2985 }
2986
2987 /*
2988  * Get/set functions for AEN's delivery_status. It is one of
2989  * SCST_AEN_RES_* constants. It specifies the status of the
2990  * command's delivery to initiator.
2991  */
2992 static inline int scst_get_aen_delivery_status(struct scst_aen *aen)
2993 {
2994         return aen->delivery_status;
2995 }
2996
2997 static inline void scst_set_aen_delivery_status(struct scst_aen *aen,
2998         int status)
2999 {
3000         aen->delivery_status = status;
3001 }
3002
3003 /*
3004  * Notifies SCST that the driver has sent the AEN and it
3005  * can be freed now. Don't forget to set the delivery status, if it
3006  * isn't success, using scst_set_aen_delivery_status() before calling
3007  * this function.
3008  */
3009 void scst_aen_done(struct scst_aen *aen);
3010
3011 #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 24)
3012
3013 /*
3014  * The macro's sg_page(), sg_virt(), sg_init_table(), sg_assign_page() and
3015  * sg_set_page() have been introduced in the 2.6.24 kernel. The definitions
3016  * below are backports of the 2.6.24 macro's for older kernels. There is one
3017  * exception however: when compiling SCST on a system with a pre-2.6.24 kernel
3018  * (e.g. RHEL 5.x) where the OFED kernel headers have been installed, do not
3019  * define the backported macro's because OFED has already defined these.
3020  */
3021
3022 #ifndef __BACKPORT_LINUX_SCATTERLIST_H_TO_2_6_23__
3023
3024 static inline struct page *sg_page(struct scatterlist *sg)
3025 {
3026         return sg->page;
3027 }
3028
3029 static inline void *sg_virt(struct scatterlist *sg)
3030 {
3031         return page_address(sg_page(sg)) + sg->offset;
3032 }
3033
3034 static inline void sg_init_table(struct scatterlist *sgl, unsigned int nents)
3035 {
3036         memset(sgl, 0, sizeof(*sgl) * nents);
3037 }
3038
3039 static inline void sg_assign_page(struct scatterlist *sg, struct page *page)
3040 {
3041         sg->page = page;
3042 }
3043
3044 static inline void sg_set_page(struct scatterlist *sg, struct page *page,
3045                                unsigned int len, unsigned int offset)
3046 {
3047         sg_assign_page(sg, page);
3048         sg->offset = offset;
3049         sg->length = len;
3050 }
3051
3052 static inline struct scatterlist *sg_next(struct scatterlist *sg)
3053 {
3054         sg++;
3055         return sg;
3056 }
3057
3058 #endif /* __BACKPORT_LINUX_SCATTERLIST_H_TO_2_6_23__ */
3059
3060 #endif /* LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 24) */
3061
3062 static inline void sg_clear(struct scatterlist *sg)
3063 {
3064         memset(sg, 0, sizeof(*sg));
3065 #ifdef CONFIG_DEBUG_SG
3066         sg->sg_magic = SG_MAGIC;
3067 #endif
3068 }
3069
3070 enum scst_sg_copy_dir {
3071         SCST_SG_COPY_FROM_TARGET,
3072         SCST_SG_COPY_TO_TARGET
3073 };
3074
3075 /*
3076  * Copies data between cmd->tgt_sg and cmd->sg in direction defined by
3077  * copy_dir parameter.
3078  */
3079 void scst_copy_sg(struct scst_cmd *cmd, enum scst_sg_copy_dir copy_dir);
3080
3081 /*
3082  * Functions for access to the commands data (SG) buffer,
3083  * including HIGHMEM environment. Should be used instead of direct
3084  * access. Returns the mapped buffer length for success, 0 for EOD,
3085  * negative error code otherwise.
3086  *
3087  * "Buf" argument returns the mapped buffer
3088  *
3089  * The "put" function unmaps the buffer.
3090  */
3091 static inline int __scst_get_buf(struct scst_cmd *cmd, struct scatterlist *sg,
3092         int sg_cnt, uint8_t **buf)
3093 {
3094         int res = 0;
3095         int i = cmd->get_sg_buf_entry_num;
3096
3097         *buf = NULL;
3098
3099         if ((i >= sg_cnt) || unlikely(sg == NULL))
3100                 goto out;
3101
3102         *buf = page_address(sg_page(&sg[i]));
3103         *buf += sg[i].offset;
3104
3105         res = sg[i].length;
3106         cmd->get_sg_buf_entry_num++;
3107
3108 out:
3109         return res;
3110 }
3111
3112 static inline int scst_get_buf_first(struct scst_cmd *cmd, uint8_t **buf)
3113 {
3114         cmd->get_sg_buf_entry_num = 0;
3115         cmd->may_need_dma_sync = 1;
3116         return __scst_get_buf(cmd, cmd->sg, cmd->sg_cnt, buf);
3117 }
3118
3119 static inline int scst_get_buf_next(struct scst_cmd *cmd, uint8_t **buf)
3120 {
3121         return __scst_get_buf(cmd, cmd->sg, cmd->sg_cnt, buf);
3122 }
3123
3124 static inline void scst_put_buf(struct scst_cmd *cmd, void *buf)
3125 {
3126         /* Nothing to do */
3127 }
3128
3129 static inline int scst_get_in_buf_first(struct scst_cmd *cmd, uint8_t **buf)
3130 {
3131         cmd->get_sg_buf_entry_num = 0;
3132         cmd->may_need_dma_sync = 1;
3133         return __scst_get_buf(cmd, cmd->in_sg, cmd->in_sg_cnt, buf);
3134 }
3135
3136 static inline int scst_get_in_buf_next(struct scst_cmd *cmd, uint8_t **buf)
3137 {
3138         return __scst_get_buf(cmd, cmd->in_sg, cmd->in_sg_cnt, buf);
3139 }
3140
3141 static inline void scst_put_in_buf(struct scst_cmd *cmd, void *buf)
3142 {
3143         /* Nothing to do */
3144 }
3145
3146 /*
3147  * Returns approximate higher rounded buffers count that
3148  * scst_get_buf_[first|next]() return.
3149  */
3150 static inline int scst_get_buf_count(struct scst_cmd *cmd)
3151 {
3152         return (cmd->sg_cnt == 0) ? 1 : cmd->sg_cnt;
3153 }
3154
3155 /*
3156  * Returns approximate higher rounded buffers count that
3157  * scst_get_in_buf_[first|next]() return.
3158  */
3159 static inline int scst_get_in_buf_count(struct scst_cmd *cmd)
3160 {
3161         return (cmd->in_sg_cnt == 0) ? 1 : cmd->in_sg_cnt;
3162 }
3163
3164 #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 23) && !defined(BACKPORT_LINUX_WORKQUEUE_TO_2_6_19)
3165 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 20))
3166 static inline int cancel_delayed_work_sync(struct delayed_work *work)
3167 #else
3168 static inline int cancel_delayed_work_sync(struct work_struct *work)
3169 #endif
3170 {
3171         int res;
3172
3173         res = cancel_delayed_work(work);
3174         flush_scheduled_work();
3175         return res;
3176 }
3177 #endif
3178
3179 /*
3180  * Suspends and resumes any activity.
3181  * Function scst_suspend_activity() doesn't return 0, until there are any
3182  * active commands (state after SCST_CMD_STATE_INIT). If "interruptible"
3183  * is true, it returns after SCST_SUSPENDING_TIMEOUT or if it was interrupted
3184  * by a signal with the coresponding error status < 0. If "interruptible"
3185  * is false, it will wait virtually forever.
3186  *
3187  * New arriving commands stay in that state until scst_resume_activity()
3188  * is called.
3189  */
3190 int scst_suspend_activity(bool interruptible);
3191 void scst_resume_activity(void);
3192
3193 /*
3194  * Main SCST commands processing routing. Must be used only by dev handlers.
3195  * Argument atomic is true if function called in atomic context.
3196  */
3197 void scst_process_active_cmd(struct scst_cmd *cmd, bool atomic);
3198
3199 /*
3200  * SCST commands processing routine, which should be called by dev handler
3201  * after its parse() callback returned SCST_CMD_STATE_STOP. Arguments
3202  * the same as for scst_process_active_cmd().
3203  */
3204 void scst_post_parse_process_active_cmd(struct scst_cmd *cmd, bool atomic);
3205
3206 /*
3207  * Checks if command can be executed (reservations, etc.) or there are local
3208  * events, like pending UAs. Returns < 0 if command must be aborted, > 0 if
3209  * there is an event and command should be immediately completed, or 0
3210  * otherwise.
3211  *
3212  * !! Dev handlers implementing exec() callback must call this function there !!
3213  * !! just before the actual command's execution                              !!
3214  */
3215 int scst_check_local_events(struct scst_cmd *cmd);
3216
3217 /*
3218  * Returns the next state of the SCSI target state machine in case if command's
3219  * completed abnormally.
3220  */
3221 int scst_get_cmd_abnormal_done_state(const struct scst_cmd *cmd);
3222
3223 /*
3224  * Sets state of the SCSI target state machine in case if command's completed
3225  * abnormally.
3226  */
3227 void scst_set_cmd_abnormal_done_state(struct scst_cmd *cmd);
3228
3229 struct scst_trace_log {
3230         unsigned int val;
3231         const char *token;
3232 };
3233
3234 /*
3235  * Main SCST mutex. All targets, devices and dev_types management is done
3236  * under this mutex.
3237  */
3238 extern struct mutex scst_mutex;
3239
3240 #ifdef CONFIG_SCST_PROC
3241
3242 /*
3243  * Returns target driver's root entry in SCST's /proc hierarchy.
3244  * The driver can create own files/directories here, which should
3245  * be deleted in the driver's release().
3246  */
3247 struct proc_dir_entry *scst_proc_get_tgt_root(
3248         struct scst_tgt_template *vtt);
3249
3250 /*
3251  * Returns device handler's root entry in SCST's /proc hierarchy.
3252  * The driver can create own files/directories here, which should
3253  * be deleted in the driver's detach()/release().
3254  */
3255 struct proc_dir_entry *scst_proc_get_dev_type_root(
3256         struct scst_dev_type *dtt);
3257
3258 /**
3259  ** Two library functions and the structure to help the drivers
3260  ** that use scst_debug.* facilities manage "trace_level" /proc entry.
3261  ** The functions service "standard" log levels and allow to work
3262  ** with driver specific levels, which should be passed inside as
3263  ** NULL-terminated array of struct scst_trace_log's, where:
3264  **   - val - the level's numeric value
3265  **   - token - its string representation
3266  **/
3267
3268 int scst_proc_log_entry_read(struct seq_file *seq, unsigned long log_level,
3269         const struct scst_trace_log *tbl);
3270 int scst_proc_log_entry_write(struct file *file, const char __user *buf,
3271         unsigned long length, unsigned long *log_level,
3272         unsigned long default_level, const struct scst_trace_log *tbl);
3273
3274 /*
3275  * helper data structure and function to create proc entry.
3276  */
3277 struct scst_proc_data {
3278         const struct file_operations seq_op;
3279         int (*show)(struct seq_file *, void *);
3280         void *data;
3281 };
3282
3283 int scst_single_seq_open(struct inode *inode, struct file *file);
3284
3285 struct proc_dir_entry *scst_create_proc_entry(struct proc_dir_entry *root,
3286         const char *name, struct scst_proc_data *pdata);
3287
3288 #define SCST_DEF_RW_SEQ_OP(x)                          \
3289         .seq_op = {                                    \
3290                 .owner          = THIS_MODULE,         \
3291                 .open           = scst_single_seq_open,\
3292                 .read           = seq_read,            \
3293                 .write          = x,                   \
3294                 .llseek         = seq_lseek,           \
3295                 .release        = single_release,      \
3296         },
3297
3298 #else /* CONFIG_SCST_PROC */
3299
3300 /* Regular SCST sysfs operations */
3301 extern struct sysfs_ops scst_sysfs_ops;
3302
3303 /*
3304  * Returns target driver's root sysfs kobject.
3305  * The driver can create own files/directories/links here.
3306  */
3307 static inline struct kobject *scst_sysfs_get_tgtt_kobj(
3308         struct scst_tgt_template *tgtt)
3309 {
3310         return &tgtt->tgtt_kobj;
3311 }
3312
3313 /*
3314  * Returns target's root sysfs kobject.
3315  * The driver can create own files/directories/links here.
3316  */
3317 static inline struct kobject *scst_sysfs_get_tgt_kobj(
3318         struct scst_tgt *tgt)
3319 {
3320         return &tgt->tgt_kobj;
3321 }
3322
3323 /*
3324  * Returns device handler's root sysfs kobject.
3325  * The driver can create own files/directories/links here.
3326  */
3327 static inline struct kobject *scst_sysfs_get_devt_kobj(
3328         struct scst_dev_type *devt)
3329 {
3330         return &devt->devt_kobj;
3331 }
3332
3333 /*
3334  * Returns device's root sysfs kobject.
3335  * The driver can create own files/directories/links here.
3336  */
3337 static inline struct kobject *scst_sysfs_get_dev_kobj(
3338         struct scst_device *dev)
3339 {
3340         return &dev->dev_kobj;
3341 }
3342
3343 /*
3344  * Returns session's root sysfs kobject.
3345  * The driver can create own files/directories/links here.
3346  */
3347 static inline struct kobject *scst_sysfs_get_sess_kobj(
3348         struct scst_session *sess)
3349 {
3350         return &sess->sess_kobj;
3351 }
3352
3353 #endif /* CONFIG_SCST_PROC */
3354
3355 /* Returns target name */
3356 static inline const char *scst_get_tgt_name(const struct scst_tgt *tgt)
3357 {
3358         return tgt->tgt_name;
3359 }
3360
3361 /*
3362  * Adds and deletes (stops) num of global SCST's threads. Returns 0 on
3363  * success, error code otherwise.
3364  */
3365 int scst_add_global_threads(int num);
3366 void scst_del_global_threads(int num);
3367
3368 int scst_alloc_sense(struct scst_cmd *cmd, int atomic);
3369 int scst_alloc_set_sense(struct scst_cmd *cmd, int atomic,
3370         const uint8_t *sense, unsigned int len);
3371
3372 /*
3373  * Sets the corresponding field in the sense buffer taking sense type
3374  * into account. Returns resulting sense length.
3375  */
3376 int scst_set_sense(uint8_t *buffer, int len, bool d_sense,
3377         int key, int asc, int ascq);
3378
3379 /*
3380  * Returns true if the sense is valid and carrying a Unit Attention or
3381  * false otherwise.
3382  */
3383 bool scst_is_ua_sense(const uint8_t *sense, int len);
3384
3385 /*
3386  * Returnes true if sense matches to (key, asc, ascq) and false otherwise.
3387  * Valid_mask is one or several SCST_SENSE_*_VALID constants setting valid
3388  * (key, asc, ascq) values.
3389  */
3390 bool scst_analyze_sense(const uint8_t *sense, int len,
3391         unsigned int valid_mask, int key, int asc, int ascq);
3392
3393 /*
3394  * Returnes a pseudo-random number for debugging purposes. Available only in
3395  * the DEBUG build.
3396  */
3397 unsigned long scst_random(void);
3398
3399 /*
3400  * Sets response data length for cmd and truncates its SG vector accordingly.
3401  * The cmd->resp_data_len must not be set directly, it must be set only
3402  * using this function. Value of resp_data_len must be <= cmd->bufflen.
3403  */
3404 void scst_set_resp_data_len(struct scst_cmd *cmd, int resp_data_len);
3405
3406 /*
3407  * Get/put global ref counter that prevents from entering into suspended
3408  * activities stage, so protects from any global management operations.
3409  */
3410 void scst_get(void);
3411 void scst_put(void);
3412
3413 /*
3414  * Cmd ref counters
3415  */
3416 void scst_cmd_get(struct scst_cmd *cmd);
3417 void scst_cmd_put(struct scst_cmd *cmd);
3418
3419 /*
3420  * Allocates and returns pointer to SG vector with data size "size".
3421  * In *count returned the count of entries in the vector.
3422  * Returns NULL for failure.
3423  */
3424 struct scatterlist *scst_alloc(int size, gfp_t gfp_mask, int *count);
3425
3426 /* Frees SG vector returned by scst_alloc() */
3427 void scst_free(struct scatterlist *sg, int count);
3428
3429 /*
3430  * Adds local to the current thread data to tgt_dev
3431  * (they will be local for the tgt_dev and current thread).
3432  */
3433 void scst_add_thr_data(struct scst_tgt_dev *tgt_dev,
3434         struct scst_thr_data_hdr *data,
3435         void (*free_fn) (struct scst_thr_data_hdr *data));
3436
3437 /* Deletes all local to threads data from tgt_dev */
3438 void scst_del_all_thr_data(struct scst_tgt_dev *tgt_dev);
3439
3440 /* Deletes all local to threads data from all tgt_dev's of the dev */
3441 void scst_dev_del_all_thr_data(struct scst_device *dev);
3442
3443 /* Finds local to the thread data. Returns NULL, if they not found. */
3444 struct scst_thr_data_hdr *__scst_find_thr_data(struct scst_tgt_dev *tgt_dev,
3445         struct task_struct *tsk);
3446
3447 /* Finds local to the current thread data. Returns NULL, if they not found. */
3448 static inline struct scst_thr_data_hdr *scst_find_thr_data(
3449         struct scst_tgt_dev *tgt_dev)
3450 {
3451         return __scst_find_thr_data(tgt_dev, current);
3452 }
3453
3454 static inline void scst_thr_data_get(struct scst_thr_data_hdr *data)
3455 {
3456         atomic_inc(&data->ref);
3457 }
3458
3459 static inline void scst_thr_data_put(struct scst_thr_data_hdr *data)
3460 {
3461         if (atomic_dec_and_test(&data->ref))
3462                 data->free_fn(data);
3463 }
3464
3465 /**
3466  ** Generic parse() support routines.
3467  ** Done via pointer on functions to avoid unneeded dereferences on
3468  ** the fast path.
3469  **/
3470
3471 /* Calculates and returns block shift for the given sector size */
3472 int scst_calc_block_shift(int sector_size);
3473
3474 /* Generic parse() for SBC (disk) devices */
3475 int scst_sbc_generic_parse(struct scst_cmd *cmd,
3476         int (*get_block_shift)(struct scst_cmd *cmd));
3477
3478 /* Generic parse() for MMC (cdrom) devices */
3479 int scst_cdrom_generic_parse(struct scst_cmd *cmd,
3480         int (*get_block_shift)(struct scst_cmd *cmd));
3481
3482 /* Generic parse() for MO disk devices */
3483 int scst_modisk_generic_parse(struct scst_cmd *cmd,
3484         int (*get_block_shift)(struct scst_cmd *cmd));
3485
3486 /* Generic parse() for tape devices */
3487 int scst_tape_generic_parse(struct scst_cmd *cmd,
3488         int (*get_block_size)(struct scst_cmd *cmd));
3489
3490 /* Generic parse() for changer devices */
3491 int scst_changer_generic_parse(struct scst_cmd *cmd,
3492         int (*nothing)(struct scst_cmd *cmd));
3493
3494 /* Generic parse() for "processor" devices */
3495 int scst_processor_generic_parse(struct scst_cmd *cmd,
3496         int (*nothing)(struct scst_cmd *cmd));
3497
3498 /* Generic parse() for RAID devices */
3499 int scst_raid_generic_parse(struct scst_cmd *cmd,
3500         int (*nothing)(struct scst_cmd *cmd));
3501
3502 /**
3503  ** Generic dev_done() support routines.
3504  ** Done via pointer on functions to avoid unneeded dereferences on
3505  ** the fast path.
3506  **/
3507
3508 /* Generic dev_done() for block devices */
3509 int scst_block_generic_dev_done(struct scst_cmd *cmd,
3510         void (*set_block_shift)(struct scst_cmd *cmd, int block_shift));
3511
3512 /* Generic dev_done() for tape devices */
3513 int scst_tape_generic_dev_done(struct scst_cmd *cmd,
3514         void (*set_block_size)(struct scst_cmd *cmd, int block_size));
3515
3516 /*
3517  * Issues a MODE SENSE for control mode page data and sets the corresponding
3518  * dev's parameter from it. Returns 0 on success and not 0 otherwise.
3519  */
3520 int scst_obtain_device_parameters(struct scst_device *dev);
3521
3522 /*
3523  * Has to be put here open coded, because Linux doesn't have equivalent, which
3524  * allows exclusive wake ups of threads in LIFO order. We need it to let (yet)
3525  * unneeded threads sleep and not pollute CPU cache by their stacks.
3526  */
3527 static inline void add_wait_queue_exclusive_head(wait_queue_head_t *q,
3528         wait_queue_t *wait)
3529 {
3530         unsigned long flags;
3531
3532         wait->flags |= WQ_FLAG_EXCLUSIVE;
3533         spin_lock_irqsave(&q->lock, flags);
3534         __add_wait_queue(q, wait);
3535         spin_unlock_irqrestore(&q->lock, flags);
3536 }
3537
3538 #endif /* __SCST_H */